org.jainslee.resources.diameter.base.types

Interface AbortSessionRequest

All Superinterfaces:

java.lang.Cloneable, DiameterMessage

public interface AbortSessionRequest
extends DiameterMessage

Defines an interface representing the Abort-Session-Request command. From the Diameter Base Protocol (rfc6733.txt) specification:

 8.5.1.  Abort-Session-Request
 
    The Abort-Session-Request (ASR), indicated by the Command Code set to
    274 and the message flags' 'R' bit set, may be sent by any Diameter
    server or any Diameter proxy to the access device that is providing
    session service, to request that the session identified by the
    Session-Id be stopped.
 
    Message Format
 
       <Abort-Session-Request>  ::= < Diameter Header: 274, REQ, PXY >
                  < Session-Id >
                  { Origin-Host }
                  { Origin-Realm }
                  { Destination-Realm }
                  { Destination-Host }
                  { Auth-Application-Id }
                  [ User-Name ]
                  [ Origin-State-Id ]
                * [ Proxy-Info ]
                * [ Route-Record ]
                * [ AVP ]
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	commandCode

Method Summary

Methods

Modifier and Type	Method and Description
long	getAuthApplicationId() Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
DiameterIdentity	getDestinationHost() Returns the value of the Destination-Host AVP, of type DiameterIdentity.
DiameterIdentity	getDestinationRealm() Returns the value of the Destination-Realm AVP, of type DiameterIdentity.
DiameterAvp[]	getExtensionAvps() Returns the set of extension 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.
DiameterIdentity[]	getRouteRecords() Returns the set of Route-Record AVPs.
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	hasAuthApplicationId() Returns true if the Auth-Application-Id AVP is present in the message.
boolean	hasDestinationHost() Returns true if the Destination-Host AVP is present in the message.
boolean	hasDestinationRealm() Returns true if the Destination-Realm 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	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	removeAuthApplicationId() Removes the Auth-Application-Id AVP from the message.
void	removeDestinationHost() Removes the Destination-Host AVP from the message.
void	removeDestinationRealm() Removes the Destination-Realm AVP from the message.
void	removeExtensionAvps() Removes all extension 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	removeRouteRecords() Removes all Route-Record AVPs from the message.
void	removeSessionId() Removes the Session-Id AVP from the message.
void	removeUserName() Removes the User-Name AVP from the message.
void	setAuthApplicationId(long authApplicationId) Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
void	setDestinationHost(DiameterIdentity destinationHost) Sets the value of the Destination-Host AVP, of type DiameterIdentity.
void	setDestinationRealm(DiameterIdentity destinationRealm) Sets the value of the Destination-Realm AVP, of type DiameterIdentity.
void	setExtensionAvps(DiameterAvp[] avps) Sets the set of extension 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	setRouteRecord(DiameterIdentity routeRecord) Sets a single Route-Record AVP in the message, of type DiameterIdentity.
void	setRouteRecords(DiameterIdentity[] routeRecords) Sets the set of Route-Record AVPs, with all the values in the given array.
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.

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

clone, getAvps, getCommand, getHeader

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

java.lang.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(java.lang.String sessionId)

Sets the value of the Session-Id AVP, of type UTF8String.

Specified by:

setSessionId in interface DiameterMessage

Throws:

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

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:

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

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

hasDestinationRealm

boolean hasDestinationRealm()

Returns true if the Destination-Realm AVP is present in the message.

getDestinationRealm

DiameterIdentity getDestinationRealm()

Returns the value of the Destination-Realm AVP, of type DiameterIdentity.

Specified by:

getDestinationRealm in interface DiameterMessage

Returns:

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

setDestinationRealm

void setDestinationRealm(DiameterIdentity destinationRealm)

Sets the value of the Destination-Realm AVP, of type DiameterIdentity.

Specified by:

setDestinationRealm in interface DiameterMessage

Throws:

java.lang.NullPointerException - if destinationRealm is null.

removeDestinationRealm

void removeDestinationRealm()

Removes the Destination-Realm AVP from the message. If the Destination-Realm AVP is not present, this method returns silently.

hasDestinationHost

boolean hasDestinationHost()

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

getDestinationHost

DiameterIdentity getDestinationHost()

Returns the value of the Destination-Host AVP, of type DiameterIdentity.

Specified by:

getDestinationHost in interface DiameterMessage

Returns:

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

setDestinationHost

void setDestinationHost(DiameterIdentity destinationHost)

Sets the value of the Destination-Host AVP, of type DiameterIdentity.

Specified by:

setDestinationHost in interface DiameterMessage

Throws:

java.lang.NullPointerException - if destinationHost is null.

removeDestinationHost

void removeDestinationHost()

Removes the Destination-Host AVP from the message. If the Destination-Host AVP is not present, this method returns silently.

hasAuthApplicationId

boolean hasAuthApplicationId()

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

getAuthApplicationId

long getAuthApplicationId()

Returns the value of the Auth-Application-Id AVP, of type Unsigned32. Use hasAuthApplicationId() to check the existence of this AVP.

Returns:

the value of the Auth-Application-Id AVP

Throws:

java.lang.IllegalStateException - if the Auth-Application-Id AVP has not been set on this message

setAuthApplicationId

void setAuthApplicationId(long authApplicationId)

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

removeAuthApplicationId

void removeAuthApplicationId()

Removes the Auth-Application-Id AVP from the message. If the Auth-Application-Id AVP is not present, this method returns silently.

hasUserName

boolean hasUserName()

Returns true if the User-Name AVP is present in the message.

getUserName

java.lang.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(java.lang.String userName)

Sets the value of the User-Name AVP, of type UTF8String.

Throws:

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

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.

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.

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:

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

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

getRouteRecords

DiameterIdentity[] getRouteRecords()

Returns the set of Route-Record AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Route-Record AVPs have been set. The elements in the given array are DiameterIdentity objects.

setRouteRecord

void setRouteRecord(DiameterIdentity routeRecord)

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

Throws:

java.lang.NullPointerException - if routeRecord is null.

setRouteRecords

void setRouteRecords(DiameterIdentity[] routeRecords)

Sets the set of Route-Record 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 getRouteRecords() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:

java.lang.NullPointerException - if routeRecords is null.

removeRouteRecords

void removeRouteRecords()

Removes all Route-Record AVPs from the message. If no Route-Record 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)

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