net.java.slee.resource.diameter.base.events
Interface ReAuthRequest

All Superinterfaces:
java.lang.Cloneable, DiameterMessage
All Known Implementing Classes:
ReAuthRequestImpl

public interface ReAuthRequest
extends DiameterMessage

Defines an interface representing the Re-Auth-Request command. From the Diameter Base Protocol (rfc3588.txt) specification:

 8.3.1.  Re-Auth-Request
 
    The Re-Auth-Request (RAR), indicated by the Command-Code set to 258
    and the message flags' 'R' bit set, may be sent by any server to the
    access device that is providing session service, to request that the
    user be re-authenticated and/or re-authorized.
 
    Message Format
 
       <Re-Auth-Request>  ::= < Diameter Header: 258, REQ, PXY >
                  < Session-Id >
                  { Origin-Host }
                  { Origin-Realm }
                  { Destination-Realm }
                  { Destination-Host }
                  { Auth-Application-Id }
                  { Re-Auth-Request-Type }
                  [ User-Name ]
                  [ Origin-State-Id ]
                * [ Proxy-Info ]
                * [ Route-Record ]
                * [ AVP ]
 

Author:
Alexandre Mendonca , Bartosz Baranowski

Field Summary
static int commandCode
           
 
Method Summary
 long getAuthApplicationId()
          Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
 long getOriginStateId()
          Returns the value of the Origin-State-Id AVP, of type Unsigned32.
 ProxyInfoAvp[] getProxyInfos()
          Returns the set of Proxy-Info AVPs.
 ReAuthRequestType getReAuthRequestType()
          Returns the value of the Re-Auth-Request-Type AVP, of type Enumerated.
 DiameterIdentity[] getRouteRecords()
          Returns the set of Route-Record AVPs.
 java.lang.String getUserName()
          Returns the value of the User-Name AVP, of type UTF8String.
 boolean hasAuthApplicationId()
          Returns true if the Auth-Application-Id AVP is present in the message.
 boolean hasOriginStateId()
          Returns true if the Origin-State-Id AVP is present in the message.
 boolean hasReAuthRequestType()
          Returns true if the Re-Auth-Request-Type AVP is present in the message.
 boolean hasUserName()
          Returns true if the User-Name AVP is present in the message.
 void setAuthApplicationId(long authApplicationId)
          Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
 void setOriginStateId(long originStateId)
          Sets the value of the Origin-State-Id AVP, of type Unsigned32.
 void setProxyInfo(ProxyInfoAvp proxyInfo)
          Sets a single Proxy-Info AVP in the message, of type Grouped.
 void setProxyInfos(ProxyInfoAvp[] proxyInfos)
          Sets the set of Proxy-Info AVPs, with all the values in the given array.
 void setReAuthRequestType(ReAuthRequestType reAuthRequestType)
          Sets the value of the Re-Auth-Request-Type AVP, of type Enumerated.
 void setRouteRecord(DiameterIdentity routeRecord)
          Sets a single Route-Record AVP in the message, of type DiameterIdentity.
 void setRouteRecords(DiameterIdentity[] routeRecords)
          Sets the set of Route-Record AVPs, with all the values in the given array.
 void setUserName(java.lang.String userName)
          Sets the value of the User-Name AVP, of type UTF8String.
 
Methods inherited from interface net.java.slee.resource.diameter.base.events.DiameterMessage
clone, getAvps, getCommand, getDestinationHost, getDestinationRealm, getExtensionAvps, getHeader, getOriginHost, getOriginRealm, getSessionId, hasDestinationHost, hasDestinationRealm, hasOriginHost, hasOriginRealm, hasSessionId, setDestinationHost, setDestinationRealm, setExtensionAvps, setOriginHost, setOriginRealm, setSessionId
 

Field Detail

commandCode

static final int commandCode
See Also:
Constant Field Values
Method Detail

hasAuthApplicationId

boolean hasAuthApplicationId()
Returns true if the Auth-Application-Id AVP is present in the message.


getAuthApplicationId

long getAuthApplicationId()
Returns the value of the Auth-Application-Id AVP, of type Unsigned32. Use hasAuthApplicationId() to check the existence of this AVP.

Returns:
the value of the Auth-Application-Id AVP
Throws:
java.lang.IllegalStateException - if the Auth-Application-Id AVP has not been set on this message

setAuthApplicationId

void setAuthApplicationId(long authApplicationId)
Sets the value of the Auth-Application-Id AVP, of type Unsigned32.

Throws:
java.lang.IllegalStateException - if setAuthApplicationId has already been called

hasReAuthRequestType

boolean hasReAuthRequestType()
Returns true if the Re-Auth-Request-Type AVP is present in the message.


getReAuthRequestType

ReAuthRequestType getReAuthRequestType()
Returns the value of the Re-Auth-Request-Type AVP, of type Enumerated.

Returns:
the value of the Re-Auth-Request-Type AVP or null if it has not been set on this message

setReAuthRequestType

void setReAuthRequestType(ReAuthRequestType reAuthRequestType)
Sets the value of the Re-Auth-Request-Type AVP, of type Enumerated.

Throws:
java.lang.IllegalStateException - if setReAuthRequestType has already been called

hasUserName

boolean hasUserName()
Returns true if the User-Name AVP is present in the message.


getUserName

java.lang.String getUserName()
Returns the value of the User-Name AVP, of type UTF8String.

Returns:
the value of the User-Name AVP or null if it has not been set on this message

setUserName

void setUserName(java.lang.String userName)
Sets the value of the User-Name AVP, of type UTF8String.

Throws:
java.lang.IllegalStateException - if setUserName has already been called

hasOriginStateId

boolean hasOriginStateId()
Returns true if the Origin-State-Id AVP is present in the message.


getOriginStateId

long getOriginStateId()
Returns the value of the Origin-State-Id AVP, of type Unsigned32. Use hasOriginStateId() to check the existence of this AVP.

Returns:
the value of the Origin-State-Id AVP
Throws:
java.lang.IllegalStateException - if the Origin-State-Id AVP has not been set on this message

setOriginStateId

void setOriginStateId(long originStateId)
Sets the value of the Origin-State-Id AVP, of type Unsigned32.

Throws:
java.lang.IllegalStateException - if setOriginStateId has already been called

getProxyInfos

ProxyInfoAvp[] getProxyInfos()
Returns the set of Proxy-Info AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Proxy-Info AVPs have been set. The elements in the given array are ProxyInfo objects.


setProxyInfo

void setProxyInfo(ProxyInfoAvp proxyInfo)
Sets a single Proxy-Info AVP in the message, of type Grouped.

Throws:
java.lang.IllegalStateException - if setProxyInfo or setProxyInfos has already been called

setProxyInfos

void setProxyInfos(ProxyInfoAvp[] proxyInfos)
Sets the set of Proxy-Info AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getProxyInfos() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:
java.lang.IllegalStateException - if setProxyInfo or setProxyInfos has already been called

getRouteRecords

DiameterIdentity[] getRouteRecords()
Returns the set of Route-Record AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Route-Record AVPs have been set. The elements in the given array are DiameterIdentity objects.


setRouteRecord

void setRouteRecord(DiameterIdentity routeRecord)
Sets a single Route-Record AVP in the message, of type DiameterIdentity.

Throws:
java.lang.IllegalStateException - if setRouteRecord or setRouteRecords has already been called

setRouteRecords

void setRouteRecords(DiameterIdentity[] routeRecords)
Sets the set of Route-Record AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getRouteRecords() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:
java.lang.IllegalStateException - if setRouteRecord or setRouteRecords has already been called


Copyright © 2011. All Rights Reserved.