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

All Superinterfaces:

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

All Known Implementing Classes:

GqReAuthRequestImpl

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

 7.1.3  Re-Auth-Request (RAR) command
 The RAR command, indicated by the Command-Code field set to 258 and the 'R' bit set in
 the Command Flags field, is sent by the SPDF to the AF in order to indicate a specific
 action.
 
 However, application-specific authentication and/or authorization messages are not 
 mandated for the Gq application in response to an RAR command.
 
 The values INDICATION_OF_RELEASE_OF_BEARER, INDICATION_OF_SUBSCRIBER_DETACHMENT, 
 INDICATION_OF_RESERVATION_EXPIRATION and INDICATION_OF_LOSS_OF_BEARER, 
 INDICATION_OF_RECOVERY_OF_BEARER and INDICATION_OF_RELEASE_OF_BEARER of the 
 Specific-Action AVP shall not be combined with each other in an Re-Auth-Request.
 
 Message Format:
 
 <RA-Request> ::= < Diameter Header: 258, REQ, PXY > 
                  < Session-Id >
                  { Origin-Host } 
                  { Origin-Realm } 
                  { Destination-Realm } 
                  { Destination-Host } 
                  { Auth-Application-Id }
                 *{ Specific-Action } 
                 *[ Flow-Description ]
                  [ Globally-Unique-Address ]
                  [ Logical-Access-Id ] 
                 *[ Flows ]
                  [ Abort-Cause ]
                  [ Origin-State-Id ] 
                 *[ Proxy-Info ] 
                 *[ Route-Record ] 
                 *[ AVP ]
 

Author:

Yulian Oifa

Field Summary

static int

COMMAND_CODE

Method Summary

AbortCause	getAbortCause() Returns the value of the Abort-Cause AVP, of type AbortCause.
long	getAuthApplicationId() Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
Flows[]	getFlows() Returns the set of Flows AVPs.
byte[]	getLogicalAccessId() Returns the value of the Logical-Access-Id AVP, of type OctetString.
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.
SpecificAction[]	getSpecificActions() Returns the set of Specific-Action AVPs.
boolean	hasAbortCause() Returns true if the Abort-Cause AVP is present in the message.
boolean	hasAuthApplicationId() Returns true if the Auth-Application-Id AVP is present in the message.
boolean	hasLogicalAccessId() Returns true if the Logical-Access-Id AVP is present in the message.
boolean	hasOriginStateId() Returns true if the Origin-State-Id AVP is present in the message.
void	setAbortCause(AbortCause abortCause) Sets the value of the Abort-Cause AVP, of type AbortCause.
void	setAuthApplicationId(long authApplicationId) Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
void	setFlows(Flows flow) Sets a single Flows AVP in the message, of type Flows.
void	setFlows(Flows[] flows) Sets the set of Flows AVPs, with all the values in the given array.
void	setLogicalAccessId(byte[] logicalAccessId) Sets the value of the Logical-Access-Id AVP, of type OctetString.
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	setSpecificAction(SpecificAction specificAction) Sets a single Specific-Action AVP in the message, of type SpecificAction.
void	setSpecificActions(SpecificAction[] specificActions) Sets the set of Specific-Action AVPs, with all the values in the given array.

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

Throws:

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

getSpecificActions

SpecificAction[] getSpecificActions()

Returns the set of Specific-Action AVPs.

Returns:

setSpecificAction

void setSpecificAction(SpecificAction specificAction)
                       throws java.lang.IllegalStateException

Sets a single Specific-Action AVP in the message, of type SpecificAction.

Parameters:

specificAction -

Throws:

java.lang.IllegalStateException

setSpecificActions

void setSpecificActions(SpecificAction[] specificActions)
                        throws java.lang.IllegalStateException

Sets the set of Specific-Action AVPs, with all the values in the given array.

Parameters:

specificActions -

Throws:

java.lang.IllegalStateException

getFlows

Flows[] getFlows()

Returns the set of Flows AVPs.

Returns:

setFlows

void setFlows(Flows flow)
              throws java.lang.IllegalStateException

Sets a single Flows AVP in the message, of type Flows.

Parameters:

flow -

Throws:

java.lang.IllegalStateException

setFlows

void setFlows(Flows[] flows)
              throws java.lang.IllegalStateException

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

Parameters:

flows -

Throws:

java.lang.IllegalStateException

hasAbortCause

boolean hasAbortCause()

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

getAbortCause

AbortCause getAbortCause()

Returns the value of the Abort-Cause AVP, of type AbortCause.

Returns:

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

setAbortCause

void setAbortCause(AbortCause abortCause)
                   throws java.lang.IllegalStateException

Sets the value of the Abort-Cause AVP, of type AbortCause.

Throws:

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

hasLogicalAccessId

boolean hasLogicalAccessId()

Returns true if the Logical-Access-Id AVP is present in the message.

getLogicalAccessId

byte[] getLogicalAccessId()

Returns the value of the Logical-Access-Id AVP, of type OctetString.

Returns:

the value of the Logical-Access-Id AVP or null if it has not been set on this message

setLogicalAccessId

void setLogicalAccessId(byte[] logicalAccessId)
                        throws java.lang.IllegalStateException

Sets the value of the Logical-Access-Id AVP, of type OctetString.

Throws:

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