All Superinterfaces:: Cloneable, DiameterMessage

public interface ReAuthAnswer
extends DiameterMessage

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

 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 it 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 ]

Field Summary

Fields
Modifier and Type Field Description

static int commandCode

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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.
`String`	`getSessionId()`	Returns the value of the Session-Id AVP, of type UTF8String.
`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(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(String sessionId)`	Sets the value of the Session-Id AVP, of type UTF8String.
`void`	`setUserName(String userName)`	Sets the value of the User-Name AVP, of type UTF8String.

Methods inherited from interface org.jainslee.resources.diameter.base.DiameterMessage
clone, getAvps, getCommand, getDestinationHost, getDestinationRealm, getHeader, setDestinationHost, setDestinationRealm

- Field Detail
  - commandCode
```
static final int commandCode
```
    See Also:
    
    Constant Field Values
- Method Detail
  - hasSessionId
```
boolean hasSessionId()
```
    Returns true if the Session-Id AVP is present in the message.
  - getSessionId
```
String getSessionId()
```
    Returns the value of the Session-Id AVP, of type UTF8String.
    
    Specified by:
    
    getSessionId in interface DiameterMessage
    
    Returns:
    
    the value of the Session-Id AVP or null if it has not been set on this message
  - setSessionId
```
void setSessionId(String sessionId)
```
    Sets the value of the Session-Id AVP, of type UTF8String.
    
    Specified by:
    
    setSessionId in interface DiameterMessage
    
    Throws:
    
    NullPointerException - if sessionId is null.
  - removeSessionId
```
void removeSessionId()
```
    Removes the Session-Id AVP from the message. If the Session-Id AVP is not present, this method returns silently.
  - hasResultCode
```
boolean hasResultCode()
```
    Returns true if the Result-Code AVP is present in the message.
  - getResultCode
```
long getResultCode()
```
    Returns the value of the Result-Code AVP, of type Unsigned32. Use hasResultCode() to check the existence of this AVP.
    
    Returns:
    
    the value of the Result-Code AVP
    
    Throws:
    
    IllegalStateException - if the Result-Code AVP has not been set on this message
  - setResultCode
```
void setResultCode(long resultCode)
```
    Sets the value of the Result-Code AVP, of type Unsigned32.
  - removeResultCode
```
void removeResultCode()
```
    Removes the Result-Code AVP from the message. If the Result-Code AVP is not present, this method returns silently.
  - hasOriginHost
```
boolean hasOriginHost()
```
    Returns true if the Origin-Host AVP is present in the message.
  - getOriginHost
```
DiameterIdentity getOriginHost()
```
    Returns the value of the Origin-Host AVP, of type DiameterIdentity.
    
    Specified by:
    
    getOriginHost in interface DiameterMessage
    
    Returns:
    
    the value of the Origin-Host AVP or null if it has not been set on this message
  - setOriginHost
```
void setOriginHost(DiameterIdentity originHost)
```
    Sets the value of the Origin-Host AVP, of type DiameterIdentity.
    
    Specified by:
    
    setOriginHost in interface DiameterMessage
    
    Throws:
    
    NullPointerException - if originHost is null.
  - removeOriginHost
```
void removeOriginHost()
```
    Removes the Origin-Host AVP from the message. If the Origin-Host AVP is not present, this method returns silently.
  - hasOriginRealm
```
boolean hasOriginRealm()
```
    Returns true if the Origin-Realm AVP is present in the message.
  - getOriginRealm
```
DiameterIdentity getOriginRealm()
```
    Returns the value of the Origin-Realm AVP, of type DiameterIdentity.
    
    Specified by:
    
    getOriginRealm in interface DiameterMessage
    
    Returns:
    
    the value of the Origin-Realm AVP or null if it has not been set on this message
  - setOriginRealm
```
void setOriginRealm(DiameterIdentity originRealm)
```
    Sets the value of the Origin-Realm AVP, of type DiameterIdentity.
    
    Specified by:
    
    setOriginRealm in interface DiameterMessage
    
    Throws:
    
    NullPointerException - if originRealm is null.
  - removeOriginRealm
```
void removeOriginRealm()
```
    Removes the Origin-Realm AVP from the message. If the Origin-Realm AVP is not present, this method returns silently.
  - hasUserName
```
boolean hasUserName()
```
    Returns true if the User-Name AVP is present in the message.
  - getUserName
```
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(String userName)
```
    Sets the value of the User-Name AVP, of type UTF8String.
    
    Throws:
    
    NullPointerException - if userName is null.
  - removeUserName
```
void removeUserName()
```
    Removes the User-Name AVP from the message. If the User-Name AVP is not present, this method returns silently.
  - 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:
    
    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.
  - removeOriginStateId
```
void removeOriginStateId()
```
    Removes the Origin-State-Id AVP from the message. If the Origin-State-Id AVP is not present, this method returns silently.
  - hasErrorMessage
```
boolean hasErrorMessage()
```
    Returns true if the Error-Message AVP is present in the message.
  - getErrorMessage
```
String getErrorMessage()
```
    Returns the value of the Error-Message AVP, of type UTF8String.
    
    Returns:
    
    the value of the Error-Message AVP or null if it has not been set on this message
  - setErrorMessage
```
void setErrorMessage(String errorMessage)
```
    Sets the value of the Error-Message AVP, of type UTF8String.
    
    Throws:
    
    NullPointerException - if errorMessage is null.
  - removeErrorMessage
```
void removeErrorMessage()
```
    Removes the Error-Message AVP from the message. If the Error-Message AVP is not present, this method returns silently.
  - hasErrorReportingHost
```
boolean hasErrorReportingHost()
```
    Returns true if the Error-Reporting-Host AVP is present in the message.
  - getErrorReportingHost
```
DiameterIdentity getErrorReportingHost()
```
    Returns the value of the Error-Reporting-Host AVP, of type DiameterIdentity.
    
    Returns:
    
    the value of the Error-Reporting-Host AVP or null if it has not been set on this message
  - setErrorReportingHost
```
void setErrorReportingHost(DiameterIdentity errorReportingHost)
```
    Sets the value of the Error-Reporting-Host AVP, of type DiameterIdentity.
    
    Throws:
    
    NullPointerException - if errorReportingHost is null.
  - removeErrorReportingHost
```
void removeErrorReportingHost()
```
    Removes the Error-Reporting-Host AVP from the message. If the Error-Reporting-Host AVP is not present, this method returns silently.
  - getFailedAvps
```
FailedAvp[] getFailedAvps()
```
    Returns the set of Failed-AVP AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Failed-AVP AVPs have been set. The elements in the given array are FailedAvp objects.
  - setFailedAvp
```
void setFailedAvp(FailedAvp failedAvp)
```
    Sets a single Failed-AVP AVP in the message, of type Grouped.
    
    Throws:
    
    NullPointerException - if failedAvp is null.
  - setFailedAvps
```
void setFailedAvps(FailedAvp[] failedAvps)
```
    Sets the set of Failed-AVP 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 getFailedAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
    
    Throws:
    
    NullPointerException - if failedAvps is null.
  - removeFailedAvps
```
void removeFailedAvps()
```
    Removes all Failed-AVP AVPs from the message. If no Failed-AVP AVPs are present, this method returns silently.
  - getRedirectHosts
```
DiameterURI[] getRedirectHosts()
```
    Returns the set of Redirect-Host AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Redirect-Host AVPs have been set. The elements in the given array are DiameterURI objects.
  - setRedirectHost
```
void setRedirectHost(DiameterURI redirectHost)
```
    Sets a single Redirect-Host AVP in the message, of type DiameterURI.
    
    Throws:
    
    NullPointerException - if redirectHost is null.
  - setRedirectHosts
```
void setRedirectHosts(DiameterURI[] redirectHosts)
```
    Sets the set of Redirect-Host 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 getRedirectHosts() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
    
    Throws:
    
    NullPointerException - if redirectHosts is null.
  - removeRedirectHosts
```
void removeRedirectHosts()
```
    Removes all Redirect-Host AVPs from the message. If no Redirect-Host AVPs are present, this method returns silently.
  - hasRedirectHostUsage
```
boolean hasRedirectHostUsage()
```
    Returns true if the Redirect-Host-Usage AVP is present in the message.
  - getRedirectHostUsage
```
RedirectHostUsage getRedirectHostUsage()
```
    Returns the value of the Redirect-Host-Usage AVP, of type Enumerated.
    
    Returns:
    
    the value of the Redirect-Host-Usage AVP or null if it has not been set on this message
  - setRedirectHostUsage
```
void setRedirectHostUsage(RedirectHostUsage redirectHostUsage)
```
    Sets the value of the Redirect-Host-Usage AVP, of type Enumerated.
    
    Throws:
    
    NullPointerException - if redirectHostUsage is null.
  - removeRedirectHostUsage
```
void removeRedirectHostUsage()
```
    Removes the Redirect-Host-Usage AVP from the message. If the Redirect-Host-Usage AVP is not present, this method returns silently.
  - hasRedirectMaxCacheTime
```
boolean hasRedirectMaxCacheTime()
```
    Returns true if the Redirect-Max-Cache-Time AVP is present in the message.
  - getRedirectMaxCacheTime
```
long getRedirectMaxCacheTime()
```
    Returns the value of the Redirect-Max-Cache-Time AVP, of type Unsigned32. Use hasRedirectMaxCacheTime() to check the existence of this AVP.
    
    Returns:
    
    the value of the Redirect-Max-Cache-Time AVP
    
    Throws:
    
    IllegalStateException - if the Redirect-Max-Cache-Time AVP has not been set on this message
  - setRedirectMaxCacheTime
```
void setRedirectMaxCacheTime(long redirectMaxCacheTime)
```
    Sets the value of the Redirect-Max-Cache-Time AVP, of type Unsigned32.
  - removeRedirectMaxCacheTime
```
void removeRedirectMaxCacheTime()
```
    Removes the Redirect-Max-Cache-Time AVP from the message. If the Redirect-Max-Cache-Time AVP is not present, this method returns silently.
  - getProxyInfos
```
ProxyInfo[] 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(ProxyInfo proxyInfo)
```
    Sets a single Proxy-Info AVP in the message, of type Grouped.
    
    Throws:
    
    NullPointerException - if proxyInfo is null.
  - setProxyInfos
```
void setProxyInfos(ProxyInfo[] 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:
    
    NullPointerException - if proxyInfos is null.
  - removeProxyInfos
```
void removeProxyInfos()
```
    Removes all Proxy-Info AVPs from the message. If no Proxy-Info AVPs are present, this method returns silently.
  - getExtensionAvps
```
DiameterAvp[] getExtensionAvps()
```
    Returns the set of extension AVPs. The returned array contains the extension AVPs in the order they appear in the message. A return value of null implies that no extensions AVPs have been set.
  - setExtensionAvps
```
void setExtensionAvps(DiameterAvp[] avps)
               throws AvpNotAllowedException
```
    Sets the set of extension 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 getExtensionAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
    
    Throws:
    
    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)
    
    NullPointerException - if avps is null.
  - removeExtensionAvps
```
void removeExtensionAvps()
```
    Removes all extension AVPs from the message. If no extension AVPs are present, this method returns silently.

Interface ReAuthAnswer

Field Summary

Method Summary

Methods inherited from interface org.jainslee.resources.diameter.base.DiameterMessage

Field Detail

commandCode

Method Detail

hasSessionId

getSessionId

setSessionId

removeSessionId

hasResultCode

getResultCode

setResultCode

removeResultCode

hasOriginHost

getOriginHost

setOriginHost

removeOriginHost

hasOriginRealm

getOriginRealm

setOriginRealm

removeOriginRealm

hasUserName

getUserName

setUserName

removeUserName

hasOriginStateId

getOriginStateId

setOriginStateId

removeOriginStateId

hasErrorMessage

getErrorMessage

setErrorMessage

removeErrorMessage

hasErrorReportingHost

getErrorReportingHost

setErrorReportingHost

removeErrorReportingHost

getFailedAvps

setFailedAvp

setFailedAvps

removeFailedAvps

getRedirectHosts

setRedirectHost

setRedirectHosts

removeRedirectHosts

hasRedirectHostUsage

getRedirectHostUsage

setRedirectHostUsage

removeRedirectHostUsage

hasRedirectMaxCacheTime

getRedirectMaxCacheTime

setRedirectMaxCacheTime

removeRedirectMaxCacheTime

getProxyInfos

setProxyInfo

setProxyInfos

removeProxyInfos

getExtensionAvps

setExtensionAvps

removeExtensionAvps