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

All Superinterfaces:

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

All Known Implementing Classes:

GqAARequestImpl

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

 7.1.1 AA-Request(AAR) command
 The AAR command, indicated by the Command-Code field set to 265 and the "R" bit set in the Command Flags field,
 is sent by an AF to the SPDF in order to request the authorization for the bearer usage for the AF session.
 Message Format:
   <AA-Request> ::= < Diameter Header: 265, REQ, PXY >
                    < Session-Id >
                    { Auth-Application-Id }
                    { Origin-Host }
                    { Origin-Realm }
                    { Destination-Realm }
                   *[ Media-Component-Description ]
                   *[ Flow-Grouping ]
                    [ AF-Charging-Identifier ]
                    [ SIP-Forking-Indication ]
                   *[ Specific-Action ]
                    [ User-Name ]
                    [ Binding-Information ]
                    [ Latching-Indication ]
                    [ Reservation-Priority ]
                    [ Globally-Unique-Address ]
                    [ Service-Class ]
                    [ Authorization-Lifetime ]
                   *[ Proxy-Info ]
                   *[ Route-Record ]
                    [ Overbooking-Indicator ]
                   *[ Authorization-Package-Id ]
                   *[ AVP ]
 

Author:

Yulian Oifa

Field Summary

static int

COMMAND_CODE

Method Summary

byte[]	getAFChargingIdentifier() Returns the value of the AF-Charging-Identifier AVP, of type OctetString.
long	getAuthApplicationId() Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
long	getAuthorizationLifetime() Returns the value of the Authorization-Lifetime AVP, of type Unsigned32.
java.lang.String[]	getAuthorizationPackageIds() Returns the set of Authorization-Package-Id AVPs.
BindingInformation	getBindingInformation() Returns the Binding-Information AVP.
FlowGrouping[]	getFlowGroupings() Returns the set of Flow-Grouping AVPs.
GloballyUniqueAddress	getGloballyUniqueAddress() Returns the Globally-Unique-Address AVP.
LatchingIndication	getLatchingIndication() Returns the Latching-Information AVP.
MediaComponentDescription[]	getMediaComponentDescriptions() Returns the set of Media-Component-Description AVPs.
OverbookingIndicator	getOverbookingIndicator() Returns the Overbooking-Indicator AVP.
net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[]	getProxyInfos() Returns the set of Proxy-Info AVPs.
ReservationPriority	getReservationPriority() Returns the Reservation-Priority AVP.
net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[]	getRouteRecords() Returns the set of Route-Record AVPs.
java.lang.String	getServiceClass() Returns the value of the Service-Class AVP, of type UTF8String.
SIPForkingIndication	getSIPForkingIndication() Returns the value of the SIP-Forking-Indication AVP, of type SIPForkingIndication.
SpecificAction[]	getSpecificActions() Returns the set of Specific-Action AVPs.
java.lang.String	getUserName() Returns the value of the User-Name AVP, of type UTF8String.
boolean	hasAFChargingIdentifier() Returns true if the AF-Charging-Identifier AVP is present in the message.
boolean	hasAuthApplicationId() Returns true if the Auth-Application-Id AVP is present in the message.
boolean	hasAuthorizationLifetime() Returns true if the Authorization-Lifetime AVP is present in the message.
boolean	hasBindingInformation() Returns true if the Binding-Information AVP is present in the message.
boolean	hasGloballyUniqueAddress() Returns true if the Globally-Unique-Address AVP is present in the message.
boolean	hasLatchingIndication() Returns true if the Latching-Indication AVP is present in the message.
boolean	hasOverbookingIndicator() Returns true if the Overbooking-Indicator AVP is present in the message.
boolean	hasReservationPriority() Returns true if the Reservation-Priority AVP is present in the message.
boolean	hasServiceClass() Returns true if the Service-Class AVP is present in the message.
boolean	hasSIPForkingIndication() Returns true if the Sip-Forking-Indication AVP is present in the message.
boolean	hasUserName() Returns true if the User-Name AVP is present in the message.
void	setAFChargingIdentifier(byte[] AFChargingIdentifier) Sets the value of the AF-Charging-Identifier AVP, of type OctetString.
void	setAuthApplicationId(long authApplicationId) Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
void	setAuthorizationLifetime(long authorizationLifetime) Sets the value of the Authorization-Lifetime AVP, of type Unsigned32.
void	setAuthorizationPackageId(java.lang.String authorizationPackageId) Sets a single Authorization-Package-Id AVP in the message, of type UTF8String.
void	setAuthorizationPackageIds(java.lang.String[] authorizationPackageIds) Sets the set of Authorization-Package-Id AVPs, with all the values in the given array.
void	setBindingInformation(BindingInformation bindingInformation) Sets a Binding-Information AVP in the message, of type BindingInformation.
void	setFlowGrouping(FlowGrouping flowGrouping) Sets a single Media-Component-Description AVP in the message, of type FlowGrouping.
void	setFlowGroupings(FlowGrouping[] flowGroupings) Sets the set of Media-Component-Description AVPs, with all the values in the given array.
void	setGloballyUniqueAddress(GloballyUniqueAddress globallyUniqueAddress) Sets a Globally-Unique-Address AVP in the message, of type GloballyUniqueAddress.
void	setLatchingIndication(LatchingIndication latchingIndication) Sets a Latching-Indication AVP in the message, of type BindingInformation.
void	setMediaComponentDescription(MediaComponentDescription mediaComponentDescription) Sets a single Media-Component-Description AVP in the message, of type MediaComponentDescription.
void	setMediaComponentDescriptions(MediaComponentDescription[] mediaComponentDescriptions) Sets the set of Media-Component-Description AVPs, with all the values in the given array.
void	setOverbookingIndicator(OverbookingIndicator overbookingIndicator) Sets a Overbooking-Indicator AVP in the message, of type OverbookingIndicator.
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	setReservationPriority(ReservationPriority reservationPriority) Sets a Reservation-Priority AVP in the message, of type ReservationPriority.
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	setServiceClass(java.lang.String serviceClass) Sets the value of the Service-Class AVP, of type UTF8String.
void	setSIPForkingIndication(SIPForkingIndication SIPForkingIndication) Sets the value of the SIP-Forking-Indication AVP, of type SIPForkingIndication.
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.
void	setUserName(java.lang.String userName) Sets the value of the User-Name AVP, of type UTF8String.

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:

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.IllegalStateException - if setUserName has already been called

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

getAuthorizationLifetime

long getAuthorizationLifetime()

Returns the value of the Authorization-Lifetime AVP, of type Unsigned32.

Returns:

setAuthorizationLifetime

void setAuthorizationLifetime(long authorizationLifetime)
                              throws java.lang.IllegalStateException

Sets the value of the Authorization-Lifetime AVP, of type Unsigned32.

Parameters:

authApplicationId -

Throws:

java.lang.IllegalStateException

hasAuthorizationLifetime

boolean hasAuthorizationLifetime()

Returns true if the Authorization-Lifetime AVP is present in the message.

Returns:

getMediaComponentDescriptions

MediaComponentDescription[] getMediaComponentDescriptions()

Returns the set of Media-Component-Description AVPs.

Returns:

setMediaComponentDescription

void setMediaComponentDescription(MediaComponentDescription mediaComponentDescription)
                                  throws java.lang.IllegalStateException

Sets a single Media-Component-Description AVP in the message, of type MediaComponentDescription.

Parameters:

mediaComponentDescription -

Throws:

java.lang.IllegalStateException

setMediaComponentDescriptions

void setMediaComponentDescriptions(MediaComponentDescription[] mediaComponentDescriptions)
                                   throws java.lang.IllegalStateException

Sets the set of Media-Component-Description AVPs, with all the values in the given array.

Parameters:

mediaComponentDescriptions -

Throws:

java.lang.IllegalStateException

getFlowGroupings

FlowGrouping[] getFlowGroupings()

Returns the set of Flow-Grouping AVPs.

Returns:

setFlowGrouping

void setFlowGrouping(FlowGrouping flowGrouping)
                     throws java.lang.IllegalStateException

Sets a single Media-Component-Description AVP in the message, of type FlowGrouping.

Parameters:

flowGrouping -

Throws:

java.lang.IllegalStateException

setFlowGroupings

void setFlowGroupings(FlowGrouping[] flowGroupings)
                      throws java.lang.IllegalStateException

Sets the set of Media-Component-Description AVPs, with all the values in the given array.

Parameters:

flowGroupings -

Throws:

java.lang.IllegalStateException

getAFChargingIdentifier

byte[] getAFChargingIdentifier()

Returns the value of the AF-Charging-Identifier AVP, of type OctetString. A return value of null implies that the AVP has not been set.

setAFChargingIdentifier

void setAFChargingIdentifier(byte[] AFChargingIdentifier)

Sets the value of the AF-Charging-Identifier AVP, of type OctetString.

hasAFChargingIdentifier

boolean hasAFChargingIdentifier()

Returns true if the AF-Charging-Identifier AVP is present in the message.

Returns:

getSIPForkingIndication

SIPForkingIndication getSIPForkingIndication()

Returns the value of the SIP-Forking-Indication AVP, of type SIPForkingIndication. A return value of null implies that the AVP has not been set.

setSIPForkingIndication

void setSIPForkingIndication(SIPForkingIndication SIPForkingIndication)

Sets the value of the SIP-Forking-Indication AVP, of type SIPForkingIndication.

hasSIPForkingIndication

boolean hasSIPForkingIndication()

Returns true if the Sip-Forking-Indication AVP is present in the message.

Returns:

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

getBindingInformation

BindingInformation getBindingInformation()

Returns the Binding-Information AVP.

Returns:

setBindingInformation

void setBindingInformation(BindingInformation bindingInformation)
                           throws java.lang.IllegalStateException

Sets a Binding-Information AVP in the message, of type BindingInformation.

Parameters:

bindingInformation -

Throws:

java.lang.IllegalStateException

hasBindingInformation

boolean hasBindingInformation()

Returns true if the Binding-Information AVP is present in the message.

Returns:

getLatchingIndication

LatchingIndication getLatchingIndication()

Returns the Latching-Information AVP.

Returns:

setLatchingIndication

void setLatchingIndication(LatchingIndication latchingIndication)
                           throws java.lang.IllegalStateException

Sets a Latching-Indication AVP in the message, of type BindingInformation.

Parameters:

latchingIndication -

Throws:

java.lang.IllegalStateException

hasLatchingIndication

boolean hasLatchingIndication()

Returns true if the Latching-Indication AVP is present in the message.

Returns:

getReservationPriority

ReservationPriority getReservationPriority()

Returns the Reservation-Priority AVP.

Returns:

setReservationPriority

void setReservationPriority(ReservationPriority reservationPriority)
                            throws java.lang.IllegalStateException

Sets a Reservation-Priority AVP in the message, of type ReservationPriority.

Parameters:

reservationPriority -

Throws:

java.lang.IllegalStateException

hasReservationPriority

boolean hasReservationPriority()

Returns true if the Reservation-Priority AVP is present in the message.

Returns:

getGloballyUniqueAddress

GloballyUniqueAddress getGloballyUniqueAddress()

Returns the Globally-Unique-Address AVP.

Returns:

setGloballyUniqueAddress

void setGloballyUniqueAddress(GloballyUniqueAddress globallyUniqueAddress)
                              throws java.lang.IllegalStateException

Sets a Globally-Unique-Address AVP in the message, of type GloballyUniqueAddress.

Parameters:

globallyUniqueAddress -

Throws:

java.lang.IllegalStateException

hasGloballyUniqueAddress

boolean hasGloballyUniqueAddress()

Returns true if the Globally-Unique-Address AVP is present in the message.

Returns:

hasServiceClass

boolean hasServiceClass()

Returns true if the Service-Class AVP is present in the message.

getServiceClass

java.lang.String getServiceClass()

Returns the value of the Service-Class AVP, of type UTF8String.

Returns:

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

setServiceClass

void setServiceClass(java.lang.String serviceClass)

Sets the value of the Service-Class AVP, of type UTF8String.

Throws:

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

getOverbookingIndicator

OverbookingIndicator getOverbookingIndicator()

Returns the Overbooking-Indicator AVP.

Returns:

setOverbookingIndicator

void setOverbookingIndicator(OverbookingIndicator overbookingIndicator)
                             throws java.lang.IllegalStateException

Sets a Overbooking-Indicator AVP in the message, of type OverbookingIndicator.

Parameters:

overbookingIndicator -

Throws:

java.lang.IllegalStateException

hasOverbookingIndicator

boolean hasOverbookingIndicator()

Returns true if the Overbooking-Indicator AVP is present in the message.

Returns:

getAuthorizationPackageIds

java.lang.String[] getAuthorizationPackageIds()

Returns the set of Authorization-Package-Id AVPs.

Returns:

setAuthorizationPackageId

void setAuthorizationPackageId(java.lang.String authorizationPackageId)
                               throws java.lang.IllegalStateException

Sets a single Authorization-Package-Id AVP in the message, of type UTF8String.

Parameters:

specificAction -

Throws:

java.lang.IllegalStateException

setAuthorizationPackageIds

void setAuthorizationPackageIds(java.lang.String[] authorizationPackageIds)
                                throws java.lang.IllegalStateException

Sets the set of Authorization-Package-Id AVPs, with all the values in the given array.

Parameters:

specificActions -

Throws:

java.lang.IllegalStateException