public interface ReAuthRequest extends ReAuthRequest
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 ]
Modifier and Type | Field and Description |
---|---|
static int |
commandCode |
Modifier and Type | Method and Description |
---|---|
long |
getAuthApplicationId()
Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
|
DiameterIdentity |
getDestinationHost()
Returns the value of the Destination-Host AVP, of type DiameterIdentity.
|
DiameterIdentity |
getDestinationRealm()
Returns the value of the Destination-Realm AVP, of type DiameterIdentity.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
DiameterIdentity |
getOriginHost()
Returns the value of the Origin-Host AVP, of type DiameterIdentity.
|
DiameterIdentity |
getOriginRealm()
Returns the value of the Origin-Realm AVP, of type DiameterIdentity.
|
long |
getOriginStateId()
Returns the value of the Origin-State-Id AVP, of type Unsigned32.
|
ProxyInfo[] |
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 |
getSessionId()
Returns the value of the Session-Id AVP, of type UTF8String.
|
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 |
hasDestinationHost()
Returns true if the Destination-Host AVP is present in the message.
|
boolean |
hasDestinationRealm()
Returns true if the Destination-Realm AVP is present in the message.
|
boolean |
hasOriginHost()
Returns true if the Origin-Host AVP is present in the message.
|
boolean |
hasOriginRealm()
Returns true if the Origin-Realm 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 |
hasSessionId()
Returns true if the Session-Id AVP is present in the message.
|
boolean |
hasUserName()
Returns true if the User-Name AVP is present in the message.
|
void |
removeAuthApplicationId()
Removes the Auth-Application-Id AVP from the message.
|
void |
removeDestinationHost()
Removes the Destination-Host AVP from the message.
|
void |
removeDestinationRealm()
Removes the Destination-Realm AVP from the message.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the message.
|
void |
removeOriginHost()
Removes the Origin-Host AVP from the message.
|
void |
removeOriginRealm()
Removes the Origin-Realm AVP from the message.
|
void |
removeOriginStateId()
Removes the Origin-State-Id AVP from the message.
|
void |
removeProxyInfos()
Removes all Proxy-Info AVPs from the message.
|
void |
removeReAuthRequestType()
Removes the Re-Auth-Request-Type AVP from the message.
|
void |
removeRouteRecords()
Removes all Route-Record AVPs from the message.
|
void |
removeSessionId()
Removes the Session-Id AVP from the message.
|
void |
removeUserName()
Removes the User-Name AVP from the message.
|
void |
setAuthApplicationId(long authApplicationId)
Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
|
void |
setDestinationHost(DiameterIdentity destinationHost)
Sets the value of the Destination-Host AVP, of type DiameterIdentity.
|
void |
setDestinationRealm(DiameterIdentity destinationRealm)
Sets the value of the Destination-Realm AVP, of type DiameterIdentity.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setOriginHost(DiameterIdentity originHost)
Sets the value of the Origin-Host AVP, of type DiameterIdentity.
|
void |
setOriginRealm(DiameterIdentity originRealm)
Sets the value of the Origin-Realm AVP, of type DiameterIdentity.
|
void |
setOriginStateId(long originStateId)
Sets the value of the Origin-State-Id AVP, of type Unsigned32.
|
void |
setProxyInfo(ProxyInfo proxyInfo)
Sets a single Proxy-Info AVP in the message, of type Grouped.
|
void |
setProxyInfos(ProxyInfo[] 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 |
setSessionId(java.lang.String sessionId)
Sets the value of the Session-Id AVP, of type UTF8String.
|
void |
setUserName(java.lang.String userName)
Sets the value of the User-Name AVP, of type UTF8String.
|
clone, getAvps, getCommand, getHeader
static final int commandCode
boolean hasSessionId()
hasSessionId
in interface ReAuthRequest
java.lang.String getSessionId()
getSessionId
in interface DiameterMessage
getSessionId
in interface ReAuthRequest
void setSessionId(java.lang.String sessionId)
setSessionId
in interface DiameterMessage
setSessionId
in interface ReAuthRequest
java.lang.NullPointerException
- if sessionId
is null
.void removeSessionId()
removeSessionId
in interface ReAuthRequest
boolean hasOriginHost()
hasOriginHost
in interface ReAuthRequest
DiameterIdentity getOriginHost()
getOriginHost
in interface DiameterMessage
getOriginHost
in interface ReAuthRequest
void setOriginHost(DiameterIdentity originHost)
setOriginHost
in interface DiameterMessage
setOriginHost
in interface ReAuthRequest
java.lang.NullPointerException
- if originHost
is null
.void removeOriginHost()
removeOriginHost
in interface ReAuthRequest
boolean hasOriginRealm()
hasOriginRealm
in interface ReAuthRequest
DiameterIdentity getOriginRealm()
getOriginRealm
in interface DiameterMessage
getOriginRealm
in interface ReAuthRequest
void setOriginRealm(DiameterIdentity originRealm)
setOriginRealm
in interface DiameterMessage
setOriginRealm
in interface ReAuthRequest
java.lang.NullPointerException
- if originRealm
is null
.void removeOriginRealm()
removeOriginRealm
in interface ReAuthRequest
boolean hasDestinationRealm()
hasDestinationRealm
in interface ReAuthRequest
DiameterIdentity getDestinationRealm()
getDestinationRealm
in interface DiameterMessage
getDestinationRealm
in interface ReAuthRequest
void setDestinationRealm(DiameterIdentity destinationRealm)
setDestinationRealm
in interface DiameterMessage
setDestinationRealm
in interface ReAuthRequest
java.lang.NullPointerException
- if destinationRealm
is null
.void removeDestinationRealm()
removeDestinationRealm
in interface ReAuthRequest
boolean hasDestinationHost()
hasDestinationHost
in interface ReAuthRequest
DiameterIdentity getDestinationHost()
getDestinationHost
in interface DiameterMessage
getDestinationHost
in interface ReAuthRequest
void setDestinationHost(DiameterIdentity destinationHost)
setDestinationHost
in interface DiameterMessage
setDestinationHost
in interface ReAuthRequest
java.lang.NullPointerException
- if destinationHost
is null
.void removeDestinationHost()
removeDestinationHost
in interface ReAuthRequest
boolean hasAuthApplicationId()
hasAuthApplicationId
in interface ReAuthRequest
long getAuthApplicationId()
hasAuthApplicationId()
to check the existence of this AVP.getAuthApplicationId
in interface ReAuthRequest
java.lang.IllegalStateException
- if the Auth-Application-Id AVP has not been set on this messagevoid setAuthApplicationId(long authApplicationId)
setAuthApplicationId
in interface ReAuthRequest
void removeAuthApplicationId()
removeAuthApplicationId
in interface ReAuthRequest
boolean hasReAuthRequestType()
hasReAuthRequestType
in interface ReAuthRequest
ReAuthRequestType getReAuthRequestType()
getReAuthRequestType
in interface ReAuthRequest
void setReAuthRequestType(ReAuthRequestType reAuthRequestType)
setReAuthRequestType
in interface ReAuthRequest
java.lang.NullPointerException
- if reAuthRequestType
is null
.void removeReAuthRequestType()
removeReAuthRequestType
in interface ReAuthRequest
boolean hasUserName()
hasUserName
in interface ReAuthRequest
java.lang.String getUserName()
getUserName
in interface ReAuthRequest
void setUserName(java.lang.String userName)
setUserName
in interface ReAuthRequest
java.lang.NullPointerException
- if userName
is null
.void removeUserName()
removeUserName
in interface ReAuthRequest
boolean hasOriginStateId()
hasOriginStateId
in interface ReAuthRequest
long getOriginStateId()
hasOriginStateId()
to check the existence of this AVP.getOriginStateId
in interface ReAuthRequest
java.lang.IllegalStateException
- if the Origin-State-Id AVP has not been set on this messagevoid setOriginStateId(long originStateId)
setOriginStateId
in interface ReAuthRequest
void removeOriginStateId()
removeOriginStateId
in interface ReAuthRequest
ProxyInfo[] getProxyInfos()
getProxyInfos
in interface ReAuthRequest
void setProxyInfo(ProxyInfo proxyInfo)
setProxyInfo
in interface ReAuthRequest
java.lang.NullPointerException
- if proxyInfo
is null
.void setProxyInfos(ProxyInfo[] proxyInfos)
setProxyInfos
in interface ReAuthRequest
java.lang.NullPointerException
- if proxyInfos
is null
.void removeProxyInfos()
removeProxyInfos
in interface ReAuthRequest
DiameterIdentity[] getRouteRecords()
getRouteRecords
in interface ReAuthRequest
void setRouteRecord(DiameterIdentity routeRecord)
setRouteRecord
in interface ReAuthRequest
java.lang.NullPointerException
- if routeRecord
is null
.void setRouteRecords(DiameterIdentity[] routeRecords)
setRouteRecords
in interface ReAuthRequest
java.lang.NullPointerException
- if routeRecords
is null
.void removeRouteRecords()
removeRouteRecords
in interface ReAuthRequest
DiameterAvp[] getExtensionAvps()
getExtensionAvps
in interface ReAuthRequest
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
setExtensionAvps
in interface ReAuthRequest
AvpNotAllowedException
- if an AVP is encountered of a type already known to this class
(i.e. an AVP for which get/set methods already appear in this class)java.lang.NullPointerException
- if avps
is null
.void removeExtensionAvps()
removeExtensionAvps
in interface ReAuthRequest