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

All Superinterfaces:

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

All Known Implementing Classes:

GqSessionTerminationRequestImpl

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

 7.1.5 Session-Termination-Request(STR) command
 The STR command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is
 sent by the AF to inform the SPDF that an authorized session shall be terminated.
 Message Format:
 <Session-Termination-Request> ::= < Diameter Header: 275, REQ, PXY >
                                   < Session-Id >
                                   { Origin-Host }
                                   { Origin-Realm }
                                   { Destination-Realm }
                                   { Termination-Cause }
                                   { Auth-Application-Id }
                                   [ Destination-Host ]
                                  *[ Class ]
                                   [ Origin-State-Id ]
                                  *[ Proxy-Info ]
                                  *[ Route-Record ]
                                  *[ AVP ]
 

Author:

Yulian Oifa

Field Summary

static int

COMMAND_CODE

Method Summary

long	getAuthApplicationId() Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
byte[][]	getClasses() Returns the set of Class 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.DiameterIdentity[]	getRouteRecords() Returns the set of Route-Record AVPs.
net.java.slee.resource.diameter.base.events.avp.TerminationCauseType	getTerminationCause() Returns the value of the Termination-Cause AVP, of type TerminationCauseType.
boolean	hasAuthApplicationId() Returns true if the Auth-Application-Id AVP is present in the message.
boolean	hasOriginStateId() Returns true if the Origin-State-Id AVP is present in the message.
boolean	hasTerminationCause() Returns true if the Termination-Cause AVP is present in the message.
void	setAuthApplicationId(long authApplicationId) Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
void	setClass(byte[] classValue) Sets a single Class AVP in the message, of type OctetString.
void	setClasses(byte[][] classes) Sets the set of Class 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	setRouteRecord(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity routeRecord) Sets a single Route-Record AVP in the message, of type DiameterIdentity.
void	setRouteRecords(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[] routeRecords) Sets the set of Route-Record AVPs, with all the values in the given array.
void	setTerminationCause(net.java.slee.resource.diameter.base.events.avp.TerminationCauseType terminationCause) Sets the value of the Termination-Cause AVP, of type TerminationCauseType.

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

getAuthApplicationId

long getAuthApplicationId()

Returns the value of the Auth-Application-Id AVP, of type Unsigned32.

Returns:

setAuthApplicationId

void setAuthApplicationId(long authApplicationId)
                          throws java.lang.IllegalStateException

Sets the value of the Auth-Application-Id AVP, of type Unsigned32.

Parameters:

authApplicationId -

Throws:

java.lang.IllegalStateException

hasAuthApplicationId

boolean hasAuthApplicationId()

Returns true if the Auth-Application-Id AVP is present in the message.

Returns:

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

getRouteRecords

net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[] getRouteRecords()

Returns the set of Route-Record AVPs.

Returns:

setRouteRecord

void setRouteRecord(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity routeRecord)
                    throws java.lang.IllegalStateException

Sets a single Route-Record AVP in the message, of type DiameterIdentity.

Parameters:

routeRecord -

Throws:

java.lang.IllegalStateException

setRouteRecords

void setRouteRecords(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[] routeRecords)
                     throws java.lang.IllegalStateException

Sets the set of Route-Record AVPs, with all the values in the given array.

Parameters:

routeRecords -

Throws:

java.lang.IllegalStateException

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

hasTerminationCause

boolean hasTerminationCause()

Returns true if the Termination-Cause AVP is present in the message.

getTerminationCause

net.java.slee.resource.diameter.base.events.avp.TerminationCauseType getTerminationCause()

Returns the value of the Termination-Cause AVP, of type TerminationCauseType.

Returns:

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

setTerminationCause

void setTerminationCause(net.java.slee.resource.diameter.base.events.avp.TerminationCauseType terminationCause)
                         throws java.lang.IllegalStateException

Sets the value of the Termination-Cause AVP, of type TerminationCauseType.

Throws:

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

getClasses

byte[][] getClasses()

Returns the set of Class AVPs.

Returns:

setClass

void setClass(byte[] classValue)
              throws java.lang.IllegalStateException

Sets a single Class AVP in the message, of type OctetString.

Parameters:

classValue -

Throws:

java.lang.IllegalStateException

setClasses

void setClasses(byte[][] classes)
                throws java.lang.IllegalStateException

Sets the set of Class AVPs, with all the values in the given array.

Parameters:

classes -

Throws:

java.lang.IllegalStateException