public interface ReAuthAnswer extends ReAuthAnswer
8.3.2. Re-Auth-Answer The Re-Auth-Answer (RAA), indicated by the Command-Code set to 258 and the message flags' 'R' bit clear, is sent in response to the RAR. The Result-Code AVP MUST be present, and indicates the disposition of the request. A successful RAA message MUST be followed by an application-specific authentication and/or authorization message. Message Format <Re-Auth-Answer> ::= < Diameter Header: 258, PXY > < Session-Id > { Result-Code } { Origin-Host } { Origin-Realm } [ User-Name ] [ Origin-State-Id ] [ Error-Message ] [ Error-Reporting-Host ] * [ Failed-AVP ] * [ Redirect-Host ] [ Redirect-Host-Usage ] [ Redirect-Max-Cache-Time ] * [ Proxy-Info ] * [ AVP ]
Modifier and Type | Field and Description |
---|---|
static int |
commandCode |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getErrorMessage()
Returns the value of the Error-Message AVP, of type UTF8String.
|
DiameterIdentity |
getErrorReportingHost()
Returns the value of the Error-Reporting-Host AVP, of type DiameterIdentity.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
FailedAvp[] |
getFailedAvps()
Returns the set of Failed-AVP 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.
|
DiameterURI[] |
getRedirectHosts()
Returns the set of Redirect-Host AVPs.
|
RedirectHostUsage |
getRedirectHostUsage()
Returns the value of the Redirect-Host-Usage AVP, of type Enumerated.
|
long |
getRedirectMaxCacheTime()
Returns the value of the Redirect-Max-Cache-Time AVP, of type Unsigned32.
|
long |
getResultCode()
Returns the value of the Result-Code AVP, of type Unsigned32.
|
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 |
hasErrorMessage()
Returns true if the Error-Message AVP is present in the message.
|
boolean |
hasErrorReportingHost()
Returns true if the Error-Reporting-Host 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 |
hasRedirectHostUsage()
Returns true if the Redirect-Host-Usage AVP is present in the message.
|
boolean |
hasRedirectMaxCacheTime()
Returns true if the Redirect-Max-Cache-Time AVP is present in the message.
|
boolean |
hasResultCode()
Returns true if the Result-Code 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 |
removeErrorMessage()
Removes the Error-Message AVP from the message.
|
void |
removeErrorReportingHost()
Removes the Error-Reporting-Host AVP from the message.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the message.
|
void |
removeFailedAvps()
Removes all Failed-AVP 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 |
removeRedirectHosts()
Removes all Redirect-Host AVPs from the message.
|
void |
removeRedirectHostUsage()
Removes the Redirect-Host-Usage AVP from the message.
|
void |
removeRedirectMaxCacheTime()
Removes the Redirect-Max-Cache-Time AVP from the message.
|
void |
removeResultCode()
Removes the Result-Code AVP from the message.
|
void |
removeSessionId()
Removes the Session-Id AVP from the message.
|
void |
removeUserName()
Removes the User-Name AVP from the message.
|
void |
setErrorMessage(java.lang.String errorMessage)
Sets the value of the Error-Message AVP, of type UTF8String.
|
void |
setErrorReportingHost(DiameterIdentity errorReportingHost)
Sets the value of the Error-Reporting-Host AVP, of type DiameterIdentity.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setFailedAvp(FailedAvp failedAvp)
Sets a single Failed-AVP AVP in the message, of type Grouped.
|
void |
setFailedAvps(FailedAvp[] failedAvps)
Sets the set of Failed-AVP 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 |
setRedirectHost(DiameterURI redirectHost)
Sets a single Redirect-Host AVP in the message, of type DiameterURI.
|
void |
setRedirectHosts(DiameterURI[] redirectHosts)
Sets the set of Redirect-Host AVPs, with all the values in the given array.
|
void |
setRedirectHostUsage(RedirectHostUsage redirectHostUsage)
Sets the value of the Redirect-Host-Usage AVP, of type Enumerated.
|
void |
setRedirectMaxCacheTime(long redirectMaxCacheTime)
Sets the value of the Redirect-Max-Cache-Time AVP, of type Unsigned32.
|
void |
setResultCode(long resultCode)
Sets the value of the Result-Code AVP, of type Unsigned32.
|
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, getDestinationHost, getDestinationRealm, getHeader, setDestinationHost, setDestinationRealm
static final int commandCode
boolean hasSessionId()
hasSessionId
in interface ReAuthAnswer
java.lang.String getSessionId()
getSessionId
in interface DiameterMessage
getSessionId
in interface ReAuthAnswer
void setSessionId(java.lang.String sessionId)
setSessionId
in interface DiameterMessage
setSessionId
in interface ReAuthAnswer
java.lang.NullPointerException
- if sessionId
is null
.void removeSessionId()
removeSessionId
in interface ReAuthAnswer
boolean hasResultCode()
hasResultCode
in interface ReAuthAnswer
long getResultCode()
hasResultCode()
to check the existence of this AVP.getResultCode
in interface ReAuthAnswer
java.lang.IllegalStateException
- if the Result-Code AVP has not been set on this messagevoid setResultCode(long resultCode)
setResultCode
in interface ReAuthAnswer
void removeResultCode()
removeResultCode
in interface ReAuthAnswer
boolean hasOriginHost()
hasOriginHost
in interface ReAuthAnswer
DiameterIdentity getOriginHost()
getOriginHost
in interface DiameterMessage
getOriginHost
in interface ReAuthAnswer
void setOriginHost(DiameterIdentity originHost)
setOriginHost
in interface DiameterMessage
setOriginHost
in interface ReAuthAnswer
java.lang.NullPointerException
- if originHost
is null
.void removeOriginHost()
removeOriginHost
in interface ReAuthAnswer
boolean hasOriginRealm()
hasOriginRealm
in interface ReAuthAnswer
DiameterIdentity getOriginRealm()
getOriginRealm
in interface DiameterMessage
getOriginRealm
in interface ReAuthAnswer
void setOriginRealm(DiameterIdentity originRealm)
setOriginRealm
in interface DiameterMessage
setOriginRealm
in interface ReAuthAnswer
java.lang.NullPointerException
- if originRealm
is null
.void removeOriginRealm()
removeOriginRealm
in interface ReAuthAnswer
boolean hasUserName()
hasUserName
in interface ReAuthAnswer
java.lang.String getUserName()
getUserName
in interface ReAuthAnswer
void setUserName(java.lang.String userName)
setUserName
in interface ReAuthAnswer
java.lang.NullPointerException
- if userName
is null
.void removeUserName()
removeUserName
in interface ReAuthAnswer
boolean hasOriginStateId()
hasOriginStateId
in interface ReAuthAnswer
long getOriginStateId()
hasOriginStateId()
to check the existence of this AVP.getOriginStateId
in interface ReAuthAnswer
java.lang.IllegalStateException
- if the Origin-State-Id AVP has not been set on this messagevoid setOriginStateId(long originStateId)
setOriginStateId
in interface ReAuthAnswer
void removeOriginStateId()
removeOriginStateId
in interface ReAuthAnswer
boolean hasErrorMessage()
hasErrorMessage
in interface ReAuthAnswer
java.lang.String getErrorMessage()
getErrorMessage
in interface ReAuthAnswer
void setErrorMessage(java.lang.String errorMessage)
setErrorMessage
in interface ReAuthAnswer
java.lang.NullPointerException
- if errorMessage
is null
.void removeErrorMessage()
removeErrorMessage
in interface ReAuthAnswer
boolean hasErrorReportingHost()
hasErrorReportingHost
in interface ReAuthAnswer
DiameterIdentity getErrorReportingHost()
getErrorReportingHost
in interface ReAuthAnswer
void setErrorReportingHost(DiameterIdentity errorReportingHost)
setErrorReportingHost
in interface ReAuthAnswer
java.lang.NullPointerException
- if errorReportingHost
is null
.void removeErrorReportingHost()
removeErrorReportingHost
in interface ReAuthAnswer
FailedAvp[] getFailedAvps()
getFailedAvps
in interface ReAuthAnswer
void setFailedAvp(FailedAvp failedAvp)
setFailedAvp
in interface ReAuthAnswer
java.lang.NullPointerException
- if failedAvp
is null
.void setFailedAvps(FailedAvp[] failedAvps)
setFailedAvps
in interface ReAuthAnswer
java.lang.NullPointerException
- if failedAvps
is null
.void removeFailedAvps()
removeFailedAvps
in interface ReAuthAnswer
DiameterURI[] getRedirectHosts()
getRedirectHosts
in interface ReAuthAnswer
void setRedirectHost(DiameterURI redirectHost)
setRedirectHost
in interface ReAuthAnswer
java.lang.NullPointerException
- if redirectHost
is null
.void setRedirectHosts(DiameterURI[] redirectHosts)
setRedirectHosts
in interface ReAuthAnswer
java.lang.NullPointerException
- if redirectHosts
is null
.void removeRedirectHosts()
removeRedirectHosts
in interface ReAuthAnswer
boolean hasRedirectHostUsage()
hasRedirectHostUsage
in interface ReAuthAnswer
RedirectHostUsage getRedirectHostUsage()
getRedirectHostUsage
in interface ReAuthAnswer
void setRedirectHostUsage(RedirectHostUsage redirectHostUsage)
setRedirectHostUsage
in interface ReAuthAnswer
java.lang.NullPointerException
- if redirectHostUsage
is null
.void removeRedirectHostUsage()
removeRedirectHostUsage
in interface ReAuthAnswer
boolean hasRedirectMaxCacheTime()
hasRedirectMaxCacheTime
in interface ReAuthAnswer
long getRedirectMaxCacheTime()
hasRedirectMaxCacheTime()
to check the existence of this AVP.getRedirectMaxCacheTime
in interface ReAuthAnswer
java.lang.IllegalStateException
- if the Redirect-Max-Cache-Time AVP has not been set on this messagevoid setRedirectMaxCacheTime(long redirectMaxCacheTime)
setRedirectMaxCacheTime
in interface ReAuthAnswer
void removeRedirectMaxCacheTime()
removeRedirectMaxCacheTime
in interface ReAuthAnswer
ProxyInfo[] getProxyInfos()
getProxyInfos
in interface ReAuthAnswer
void setProxyInfo(ProxyInfo proxyInfo)
setProxyInfo
in interface ReAuthAnswer
java.lang.NullPointerException
- if proxyInfo
is null
.void setProxyInfos(ProxyInfo[] proxyInfos)
setProxyInfos
in interface ReAuthAnswer
java.lang.NullPointerException
- if proxyInfos
is null
.void removeProxyInfos()
removeProxyInfos
in interface ReAuthAnswer
DiameterAvp[] getExtensionAvps()
getExtensionAvps
in interface ReAuthAnswer
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
setExtensionAvps
in interface ReAuthAnswer
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 ReAuthAnswer