net.java.slee.resource.diameter.gq.events
Interface GqSessionTerminationAnswer

All Superinterfaces:

java.lang.Cloneable, net.java.slee.resource.diameter.base.events.DiameterMessage

All Known Implementing Classes:

GqSessionTerminationAnswerImpl

public interface GqSessionTerminationAnswer
extends net.java.slee.resource.diameter.base.events.DiameterMessage

 7.1.6 Session-Termination-Answer(STA) command
 The STA command, indicated by the Command-Code field set to 275 and the "R" bit cleared in the Command Flags
 field, is sent by the SPDF to the AF in response to the STR command.
 Message Format:
 <Session-Termination-Answer> ::= < Diameter Header: 275, PXY >
                                  < Session-Id >
                                  { Origin-Host }
                                  { Origin-Realm }
                                  [ Result-Code ]
                                  [ Experimental-Result ]
                                  [ Error-Message ]
                                  [ Error-Reporting-Host ]
                                 *[ Failed-AVP ]
                                  [ Origin-State-Id ]
                                 *[ Redirect-Host ]
                                  [ Redirect-Host-Usage ]
                                  [ Redirect-Max-Cache-Time ]
                                 *[ Proxy-Info ]
                                  [ AVP ]
 

Author:

Yulian Oifa

Field Summary

static int

COMMAND_CODE

Method Summary

java.lang.String	getErrorMessage() Returns the value of the Error-Message AVP, of type UTF8String.
net.java.slee.resource.diameter.base.events.avp.DiameterIdentity	getErrorReportingHost() Returns the value of the Error-Reporting-Host AVP, of type DiameterIdentity.
net.java.slee.resource.diameter.base.events.avp.ExperimentalResultAvp	getExperimentalResult() Returns the value of the Experimental-Result AVP, of type ExperimentalResultAvp.
net.java.slee.resource.diameter.base.events.avp.FailedAvp[]	getFailedAvps() Returns the set of Failed-AVP AVPs.
long	getOriginStateId() Returns the value of the Origin-State-Id AVP, of type Unsigned32.
net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[]	getProxyInfos() Returns the set of Proxy-Info AVPs.
net.java.slee.resource.diameter.base.events.avp.DiameterURI[]	getRedirectHosts() Returns the set of Redirect-Host AVPs.
net.java.slee.resource.diameter.base.events.avp.RedirectHostUsageType	getRedirectHostUsage() Returns the value of the Redirect-Host-Usage AVP, of type RedirectHostUsageType.
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.
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	hasExperimentalResult() Returns true if the Experimental-Result 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.
void	setErrorMessage(java.lang.String errorMessage) Sets the value of the Error-Message AVP, of type UTF8String.
void	setErrorReportingHost(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity errorReportingHost) Sets the value of the Error-Reporting-Host AVP, of type DiameterIdentity.
void	setExperimentalResult(net.java.slee.resource.diameter.base.events.avp.ExperimentalResultAvp experimentalResult) Sets the value of the Experimental-Result AVP, of type ExperimentalResultAvp.
void	setFailedAvp(net.java.slee.resource.diameter.base.events.avp.FailedAvp failedAvp) Sets a single Failed-AVP AVP in the message, of type Grouped.
void	setFailedAvps(net.java.slee.resource.diameter.base.events.avp.FailedAvp[] failedAvps) Sets the set of Failed-AVP AVPs, with all the values in the given array.
void	setOriginStateId(long originStateId) Sets the value of the Origin-State-Id AVP, of type Unsigned32.
void	setProxyInfo(net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp proxyInfo) Sets a single Proxy-Info AVP in the message, of type Grouped.
void	setProxyInfos(net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[] proxyInfos) Sets the set of Proxy-Info AVPs, with all the values in the given array.
void	setRedirectHost(net.java.slee.resource.diameter.base.events.avp.DiameterURI redirectHost) Sets a single Redirect-Host AVP in the message, of type DiameterIdentity.
void	setRedirectHosts(net.java.slee.resource.diameter.base.events.avp.DiameterURI[] redirectHosts) Sets the set of Redirect-Host AVPs, with all the values in the given array.
void	setRedirectHostUsage(net.java.slee.resource.diameter.base.events.avp.RedirectHostUsageType errorReportingHost) Sets the value of the Redirect-Host-Usage AVP, of type RedirectHostUsageType.
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.

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

COMMAND_CODE

static final int COMMAND_CODE

See Also:

Constant Field Values

Method Detail

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:

java.lang.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.

Throws:

java.lang.IllegalStateException - if setResultCode has already been called

getFailedAvps

net.java.slee.resource.diameter.base.events.avp.FailedAvp[] getFailedAvps()

Returns the set of Failed-AVP AVPs.

Returns:

setFailedAvp

void setFailedAvp(net.java.slee.resource.diameter.base.events.avp.FailedAvp failedAvp)
                  throws java.lang.IllegalStateException

Sets a single Failed-AVP AVP in the message, of type Grouped.

Parameters:

failedAvp -

Throws:

java.lang.IllegalStateException

setFailedAvps

void setFailedAvps(net.java.slee.resource.diameter.base.events.avp.FailedAvp[] failedAvps)
                   throws java.lang.IllegalStateException

Sets the set of Failed-AVP AVPs, with all the values in the given array.

Parameters:

failedAvps -

Throws:

java.lang.IllegalStateException

getProxyInfos

net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[] getProxyInfos()

Returns the set of Proxy-Info AVPs.

Returns:

setProxyInfo

void setProxyInfo(net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp proxyInfo)
                  throws java.lang.IllegalStateException

Sets a single Proxy-Info AVP in the message, of type Grouped.

Parameters:

proxyInfo -

Throws:

java.lang.IllegalStateException

setProxyInfos

void setProxyInfos(net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[] proxyInfos)
                   throws java.lang.IllegalStateException

Sets the set of Proxy-Info AVPs, with all the values in the given array.

Parameters:

proxyInfos -

Throws:

java.lang.IllegalStateException

hasErrorMessage

boolean hasErrorMessage()

Returns true if the Error-Message AVP is present in the message.

getErrorMessage

java.lang.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(java.lang.String errorMessage)
                     throws java.lang.IllegalStateException

Sets the value of the Error-Message AVP, of type UTF8String.

Throws:

java.lang.IllegalStateException - if setErrorMessage has already been called

hasErrorReportingHost

boolean hasErrorReportingHost()

Returns true if the Error-Reporting-Host AVP is present in the message.

getErrorReportingHost

net.java.slee.resource.diameter.base.events.avp.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(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity errorReportingHost)
                           throws java.lang.IllegalStateException

Sets the value of the Error-Reporting-Host AVP, of type DiameterIdentity.

Throws:

java.lang.IllegalStateException - if setErrorReportingHost has already been called

hasExperimentalResult

boolean hasExperimentalResult()

Returns true if the Experimental-Result AVP is present in the message.

getExperimentalResult

net.java.slee.resource.diameter.base.events.avp.ExperimentalResultAvp getExperimentalResult()

Returns the value of the Experimental-Result AVP, of type ExperimentalResultAvp.

Returns:

the value of the Experimental-Result AVP or null if it has not been set on this message

setExperimentalResult

void setExperimentalResult(net.java.slee.resource.diameter.base.events.avp.ExperimentalResultAvp experimentalResult)
                           throws java.lang.IllegalStateException

Sets the value of the Experimental-Result AVP, of type ExperimentalResultAvp.

Throws:

java.lang.IllegalStateException - if setErrorReportingHost 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-Idd 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

setRedirectHostUsage

void setRedirectHostUsage(net.java.slee.resource.diameter.base.events.avp.RedirectHostUsageType errorReportingHost)
                          throws java.lang.IllegalStateException

Sets the value of the Redirect-Host-Usage AVP, of type RedirectHostUsageType.

Throws:

java.lang.IllegalStateException - if setErrorReportingHost has already been called

hasRedirectHostUsage

boolean hasRedirectHostUsage()

Returns true if the Redirect-Host-Usage AVP is present in the message.

getRedirectHostUsage

net.java.slee.resource.diameter.base.events.avp.RedirectHostUsageType getRedirectHostUsage()

Returns the value of the Redirect-Host-Usage AVP, of type RedirectHostUsageType.

Returns:

the value of the Redirect-Host-Usage AVP or null if it has not been set on this message

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:

java.lang.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.

Throws:

java.lang.IllegalStateException - if setRedirectMaxCacheTime has already been called

getRedirectHosts

net.java.slee.resource.diameter.base.events.avp.DiameterURI[] getRedirectHosts()

Returns the set of Redirect-Host AVPs.

Returns:

setRedirectHost

void setRedirectHost(net.java.slee.resource.diameter.base.events.avp.DiameterURI redirectHost)
                     throws java.lang.IllegalStateException

Sets a single Redirect-Host AVP in the message, of type DiameterIdentity.

Parameters:

redirectHost -

Throws:

java.lang.IllegalStateException

setRedirectHosts

void setRedirectHosts(net.java.slee.resource.diameter.base.events.avp.DiameterURI[] redirectHosts)
                      throws java.lang.IllegalStateException

Sets the set of Redirect-Host AVPs, with all the values in the given array.

Parameters:

redirectHosts -

Throws:

java.lang.IllegalStateException