public interface SessionTerminationAnswer extends DiameterMessage
8.4.2. Session-Termination-Answer The Session-Termination-Answer (STA), indicated by the Command-Code set to 275 and the message flags' 'R' bit clear, is sent by the Diameter Server to acknowledge the notification that the session has been terminated. The Result-Code AVP MUST be present, and MAY contain an indication that an error occurred while servicing the STR. Upon sending or receipt of the STA, the Diameter Server MUST release all resources for the session indicated by the Session-Id AVP. Any intermediate server in the Proxy-Chain MAY also release any resources, if necessary. Message Format <Session-Termination-Answer> ::= < Diameter Header: 275, PXY > < Session-Id > { Result-Code } { Origin-Host } { Origin-Realm } [ User-Name ] * [ Class ] [ Error-Message ] [ Error-Reporting-Host ] * [ Failed-AVP ] [ Origin-State-Id ] * [ 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 |
---|---|
byte[][] |
getClassAvps()
Returns the set of Class AVPs.
|
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 |
removeClassAvps()
Removes all Class AVPs from 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 |
setClassAvp(byte[] classAvp)
Sets a single Class AVP in the message, of type OctetString.
|
void |
setClassAvps(byte[][] classAvps)
Sets the set of Class AVPs, with all the values in the given array.
|
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()
java.lang.String getSessionId()
getSessionId
in interface DiameterMessage
void setSessionId(java.lang.String sessionId)
setSessionId
in interface DiameterMessage
java.lang.NullPointerException
- if sessionId
is null
.void removeSessionId()
boolean hasResultCode()
long getResultCode()
hasResultCode()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Result-Code AVP has not been set on this messagevoid setResultCode(long resultCode)
void removeResultCode()
boolean hasOriginHost()
DiameterIdentity getOriginHost()
getOriginHost
in interface DiameterMessage
void setOriginHost(DiameterIdentity originHost)
setOriginHost
in interface DiameterMessage
java.lang.NullPointerException
- if originHost
is null
.void removeOriginHost()
boolean hasOriginRealm()
DiameterIdentity getOriginRealm()
getOriginRealm
in interface DiameterMessage
void setOriginRealm(DiameterIdentity originRealm)
setOriginRealm
in interface DiameterMessage
java.lang.NullPointerException
- if originRealm
is null
.void removeOriginRealm()
boolean hasUserName()
java.lang.String getUserName()
void setUserName(java.lang.String userName)
java.lang.NullPointerException
- if userName
is null
.void removeUserName()
byte[][] getClassAvps()
void setClassAvp(byte[] classAvp)
java.lang.NullPointerException
- if classAvp
is null
.void setClassAvps(byte[][] classAvps)
java.lang.NullPointerException
- if classAvps
is null
.void removeClassAvps()
boolean hasErrorMessage()
java.lang.String getErrorMessage()
void setErrorMessage(java.lang.String errorMessage)
java.lang.NullPointerException
- if errorMessage
is null
.void removeErrorMessage()
boolean hasErrorReportingHost()
DiameterIdentity getErrorReportingHost()
void setErrorReportingHost(DiameterIdentity errorReportingHost)
java.lang.NullPointerException
- if errorReportingHost
is null
.void removeErrorReportingHost()
FailedAvp[] getFailedAvps()
void setFailedAvp(FailedAvp failedAvp)
java.lang.NullPointerException
- if failedAvp
is null
.void setFailedAvps(FailedAvp[] failedAvps)
java.lang.NullPointerException
- if failedAvps
is null
.void removeFailedAvps()
boolean hasOriginStateId()
long getOriginStateId()
hasOriginStateId()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Origin-State-Id AVP has not been set on this messagevoid setOriginStateId(long originStateId)
void removeOriginStateId()
DiameterURI[] getRedirectHosts()
void setRedirectHost(DiameterURI redirectHost)
java.lang.NullPointerException
- if redirectHost
is null
.void setRedirectHosts(DiameterURI[] redirectHosts)
java.lang.NullPointerException
- if redirectHosts
is null
.void removeRedirectHosts()
boolean hasRedirectHostUsage()
RedirectHostUsage getRedirectHostUsage()
void setRedirectHostUsage(RedirectHostUsage redirectHostUsage)
java.lang.NullPointerException
- if redirectHostUsage
is null
.void removeRedirectHostUsage()
boolean hasRedirectMaxCacheTime()
long getRedirectMaxCacheTime()
hasRedirectMaxCacheTime()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Redirect-Max-Cache-Time AVP has not been set on this messagevoid setRedirectMaxCacheTime(long redirectMaxCacheTime)
void removeRedirectMaxCacheTime()
ProxyInfo[] getProxyInfos()
void setProxyInfo(ProxyInfo proxyInfo)
java.lang.NullPointerException
- if proxyInfo
is null
.void setProxyInfos(ProxyInfo[] proxyInfos)
java.lang.NullPointerException
- if proxyInfos
is null
.void removeProxyInfos()
DiameterAvp[] getExtensionAvps()
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
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()