org.mobicents.slee.resource.diameter.gq.events
Class GqSessionTerminationRequestImpl

java.lang.Object
  org.mobicents.slee.resource.diameter.base.events.DiameterMessageImpl
      org.mobicents.slee.resource.diameter.gq.events.GqSessionTerminationRequestImpl

All Implemented Interfaces:

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

public class GqSessionTerminationRequestImpl
extends org.mobicents.slee.resource.diameter.base.events.DiameterMessageImpl
implements GqSessionTerminationRequest

 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

Fields inherited from class org.mobicents.slee.resource.diameter.base.events.DiameterMessageImpl

message

Fields inherited from interface net.java.slee.resource.diameter.gq.events.GqSessionTerminationRequest

COMMAND_CODE

Constructor Summary

GqSessionTerminationRequestImpl(org.jdiameter.api.Message message)

Method Summary

byte[][]	getClasses() Returns the set of Class AVPs.
java.lang.String	getLongName()
java.lang.String	getShortName()
net.java.slee.resource.diameter.base.events.avp.TerminationCauseType	getTerminationCause() Returns the value of the Termination-Cause AVP, of type TerminationCauseType.
boolean	hasTerminationCause() Returns true if the Termination-Cause AVP is present in the message.
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	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 class org.mobicents.slee.resource.diameter.base.events.DiameterMessageImpl

addAvp, addAvp, addAvp, addAvp, clone, getAcctApplicationId, getAuthApplicationId, getAvp, getAvp, getAvp, getAvpAsAddress, getAvpAsAddress, getAvpAsCustom, getAvpAsCustom, getAvpAsDiameterIdentity, getAvpAsDiameterIdentity, getAvpAsDiameterURI, getAvpAsDiameterURI, getAvpAsEnumerated, getAvpAsEnumerated, getAvpAsFloat32, getAvpAsFloat32, getAvpAsFloat64, getAvpAsFloat64, getAvpAsGrouped, getAvpAsGrouped, getAvpAsInteger32, getAvpAsInteger32, getAvpAsInteger64, getAvpAsInteger64, getAvpAsIPFilterRule, getAvpAsIPFilterRule, getAvpAsOctetString, getAvpAsOctetString, getAvpAsRaw, getAvpAsRaw, getAvpAsTime, getAvpAsTime, getAvpAsUnsigned32, getAvpAsUnsigned32, getAvpAsUnsigned64, getAvpAsUnsigned64, getAvpAsUTF8String, getAvpAsUTF8String, getAvps, getAvpsAsAddress, getAvpsAsAddress, getAvpsAsCustom, getAvpsAsCustom, getAvpsAsDiameterIdentity, getAvpsAsDiameterIdentity, getAvpsAsDiameterURI, getAvpsAsDiameterURI, getAvpsAsEnumerated, getAvpsAsEnumerated, getAvpsAsFloat32, getAvpsAsFloat32, getAvpsAsFloat64, getAvpsAsFloat64, getAvpsAsGrouped, getAvpsAsGrouped, getAvpsAsInteger32, getAvpsAsInteger32, getAvpsAsInteger64, getAvpsAsInteger64, getAvpsAsIPFilterRule, getAvpsAsIPFilterRule, getAvpsAsOctetString, getAvpsAsOctetString, getAvpsAsRaw, getAvpsAsRaw, getAvpsAsTime, getAvpsAsTime, getAvpsAsUnsigned32, getAvpsAsUnsigned32, getAvpsAsUnsigned64, getAvpsAsUnsigned64, getAvpsAsUTF8String, getAvpsAsUTF8String, getCommand, getData, getDestinationHost, getDestinationRealm, getErrorMessage, getErrorReportingHost, getEventTimestamp, getExtensionAvps, getFailedAvp, getFailedAvps, getGenericData, getHeader, getOriginHost, getOriginRealm, getOriginStateId, getProxyInfos, getRedirectHosts, getRedirectHostUsage, getRedirectMaxCacheTime, getResultCode, getRouteRecords, getSessionId, getUserName, getVendorSpecificApplicationId, hasAcctApplicationId, hasAuthApplicationId, hasAvp, hasAvp, hasDestinationHost, hasDestinationRealm, hasErrorMessage, hasErrorReportingHost, hasEventTimestamp, hasFailedAvp, hasOriginHost, hasOriginRealm, hasOriginStateId, hasRedirectHosts, hasRedirectHostUsage, hasRedirectMaxCacheTime, hasResultCode, hasSessionId, hasUserName, hasVendorSpecificApplicationId, removeData, reportAvpFetchError, setAcctApplicationId, setAuthApplicationId, setAvpAsFloat32, setAvpAsFloat64, setAvpAsGrouped, setAvpAsInteger32, setAvpAsInteger64, setAvpAsOctetString, setAvpAsRaw, setAvpAsTime, setAvpAsUnsigned32, setAvpAsUnsigned64, setAvpAsUTF8String, setData, setDestinationHost, setDestinationRealm, setErrorMessage, setErrorReportingHost, setEventTimestamp, setExtensionAvps, setFailedAvp, setFailedAvps, setOriginHost, setOriginRealm, setOriginStateId, setProxyInfo, setProxyInfos, setRedirectHost, setRedirectHosts, setRedirectHostUsage, setRedirectMaxCacheTime, setResultCode, setRouteRecord, setRouteRecords, setSessionId, setUserName, setVendorSpecificApplicationId, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.java.slee.resource.diameter.gq.events.GqSessionTerminationRequest

getAuthApplicationId, getOriginStateId, getProxyInfos, getRouteRecords, hasAuthApplicationId, hasOriginStateId, setAuthApplicationId, setOriginStateId, setProxyInfo, setProxyInfos, setRouteRecord, setRouteRecords

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

Constructor Detail

GqSessionTerminationRequestImpl

public GqSessionTerminationRequestImpl(org.jdiameter.api.Message message)

Method Detail

hasTerminationCause

public boolean hasTerminationCause()

Description copied from interface: GqSessionTerminationRequest

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

Specified by:

hasTerminationCause in interface GqSessionTerminationRequest

getTerminationCause

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

Description copied from interface: GqSessionTerminationRequest

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

Specified by:

getTerminationCause in interface GqSessionTerminationRequest

Returns:

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

setTerminationCause

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

Description copied from interface: GqSessionTerminationRequest

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

Specified by:

setTerminationCause in interface GqSessionTerminationRequest

Throws:

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

getClasses

public byte[][] getClasses()

Description copied from interface: GqSessionTerminationRequest

Returns the set of Class AVPs.

Specified by:

getClasses in interface GqSessionTerminationRequest

Returns:

setClass

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

Description copied from interface: GqSessionTerminationRequest

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

Specified by:

setClass in interface GqSessionTerminationRequest

Throws:

java.lang.IllegalStateException

setClasses

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

Description copied from interface: GqSessionTerminationRequest

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

Specified by:

setClasses in interface GqSessionTerminationRequest

Throws:

java.lang.IllegalStateException

getLongName

public java.lang.String getLongName()

Specified by:

getLongName in class org.mobicents.slee.resource.diameter.base.events.DiameterMessageImpl

getShortName

public java.lang.String getShortName()

Specified by:

getShortName in class org.mobicents.slee.resource.diameter.base.events.DiameterMessageImpl