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

java.lang.Object
  extended by org.mobicents.slee.resource.diameter.base.events.DiameterMessageImpl
      extended by org.mobicents.slee.resource.diameter.gq.events.GqAARequestImpl
All Implemented Interfaces:
java.lang.Cloneable, net.java.slee.resource.diameter.base.events.DiameterMessage, GqAARequest

public class GqAARequestImpl
extends org.mobicents.slee.resource.diameter.base.events.DiameterMessageImpl
implements GqAARequest

 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
 
Fields inherited from class org.mobicents.slee.resource.diameter.base.events.DiameterMessageImpl
message
 
Fields inherited from interface net.java.slee.resource.diameter.gq.events.GqAARequest
COMMAND_CODE
 
Constructor Summary
GqAARequestImpl(org.jdiameter.api.Message message)
           
 
Method Summary
 byte[] getAFChargingIdentifier()
          Returns the value of the AF-Charging-Identifier AVP, of type OctetString.
 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.
 java.lang.String getLongName()
           
 MediaComponentDescription[] getMediaComponentDescriptions()
          Returns the set of Media-Component-Description AVPs.
 OverbookingIndicator getOverbookingIndicator()
          Returns the Overbooking-Indicator AVP.
 ReservationPriority getReservationPriority()
          Returns the Reservation-Priority AVP.
 java.lang.String getServiceClass()
          Returns the value of the Service-Class AVP, of type UTF8String.
 java.lang.String getShortName()
           
 SIPForkingIndication getSIPForkingIndication()
          Returns the value of the SIP-Forking-Indication AVP, of type SIPForkingIndication.
 SpecificAction[] getSpecificActions()
          Returns the set of Specific-Action AVPs.
 boolean hasAFChargingIdentifier()
          Returns true if the AF-Charging-Identifier 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.
 void setAFChargingIdentifier(byte[] AFChargingIdentifier)
          Sets the value of the AF-Charging-Identifier AVP, of type OctetString.
 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 setReservationPriority(ReservationPriority reservationPriority)
          Sets a Reservation-Priority AVP in the message, of type ReservationPriority.
 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.
 
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.GqAARequest
getAuthApplicationId, getProxyInfos, getRouteRecords, getUserName, hasAuthApplicationId, hasUserName, setAuthApplicationId, setProxyInfo, setProxyInfos, setRouteRecord, setRouteRecords, setUserName
 
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

GqAARequestImpl

public GqAARequestImpl(org.jdiameter.api.Message message)
Method Detail

getAuthorizationLifetime

public long getAuthorizationLifetime()
Description copied from interface: GqAARequest
Returns the value of the Authorization-Lifetime AVP, of type Unsigned32.

Specified by:
getAuthorizationLifetime in interface GqAARequest
Returns:

setAuthorizationLifetime

public void setAuthorizationLifetime(long authorizationLifetime)
                              throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets the value of the Authorization-Lifetime AVP, of type Unsigned32.

Specified by:
setAuthorizationLifetime in interface GqAARequest
Throws:
java.lang.IllegalStateException

hasAuthorizationLifetime

public boolean hasAuthorizationLifetime()
Description copied from interface: GqAARequest
Returns true if the Authorization-Lifetime AVP is present in the message.

Specified by:
hasAuthorizationLifetime in interface GqAARequest
Returns:

getMediaComponentDescriptions

public MediaComponentDescription[] getMediaComponentDescriptions()
Description copied from interface: GqAARequest
Returns the set of Media-Component-Description AVPs.

Specified by:
getMediaComponentDescriptions in interface GqAARequest
Returns:

setMediaComponentDescription

public void setMediaComponentDescription(MediaComponentDescription mediaComponentDescription)
                                  throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets a single Media-Component-Description AVP in the message, of type MediaComponentDescription.

Specified by:
setMediaComponentDescription in interface GqAARequest
Throws:
java.lang.IllegalStateException

setMediaComponentDescriptions

public void setMediaComponentDescriptions(MediaComponentDescription[] mediaComponentDescriptions)
                                   throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets the set of Media-Component-Description AVPs, with all the values in the given array.

Specified by:
setMediaComponentDescriptions in interface GqAARequest
Throws:
java.lang.IllegalStateException

getFlowGroupings

public FlowGrouping[] getFlowGroupings()
Description copied from interface: GqAARequest
Returns the set of Flow-Grouping AVPs.

Specified by:
getFlowGroupings in interface GqAARequest
Returns:

setFlowGrouping

public void setFlowGrouping(FlowGrouping flowGrouping)
                     throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets a single Media-Component-Description AVP in the message, of type FlowGrouping.

Specified by:
setFlowGrouping in interface GqAARequest
Throws:
java.lang.IllegalStateException

setFlowGroupings

public void setFlowGroupings(FlowGrouping[] flowGroupings)
                      throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets the set of Media-Component-Description AVPs, with all the values in the given array.

Specified by:
setFlowGroupings in interface GqAARequest
Throws:
java.lang.IllegalStateException

getAFChargingIdentifier

public byte[] getAFChargingIdentifier()
Description copied from interface: GqAARequest
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.

Specified by:
getAFChargingIdentifier in interface GqAARequest

setAFChargingIdentifier

public void setAFChargingIdentifier(byte[] AFChargingIdentifier)
Description copied from interface: GqAARequest
Sets the value of the AF-Charging-Identifier AVP, of type OctetString.

Specified by:
setAFChargingIdentifier in interface GqAARequest

hasAFChargingIdentifier

public boolean hasAFChargingIdentifier()
Description copied from interface: GqAARequest
Returns true if the AF-Charging-Identifier AVP is present in the message.

Specified by:
hasAFChargingIdentifier in interface GqAARequest
Returns:

getSIPForkingIndication

public SIPForkingIndication getSIPForkingIndication()
Description copied from interface: GqAARequest
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.

Specified by:
getSIPForkingIndication in interface GqAARequest

setSIPForkingIndication

public void setSIPForkingIndication(SIPForkingIndication SIPForkingIndication)
Description copied from interface: GqAARequest
Sets the value of the SIP-Forking-Indication AVP, of type SIPForkingIndication.

Specified by:
setSIPForkingIndication in interface GqAARequest

hasSIPForkingIndication

public boolean hasSIPForkingIndication()
Description copied from interface: GqAARequest
Returns true if the Sip-Forking-Indication AVP is present in the message.

Specified by:
hasSIPForkingIndication in interface GqAARequest
Returns:

getSpecificActions

public SpecificAction[] getSpecificActions()
Description copied from interface: GqAARequest
Returns the set of Specific-Action AVPs.

Specified by:
getSpecificActions in interface GqAARequest
Returns:

setSpecificAction

public void setSpecificAction(SpecificAction specificAction)
                       throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets a single Specific-Action AVP in the message, of type SpecificAction.

Specified by:
setSpecificAction in interface GqAARequest
Throws:
java.lang.IllegalStateException

setSpecificActions

public void setSpecificActions(SpecificAction[] specificActions)
                        throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets the set of Specific-Action AVPs, with all the values in the given array.

Specified by:
setSpecificActions in interface GqAARequest
Throws:
java.lang.IllegalStateException

getBindingInformation

public BindingInformation getBindingInformation()
Description copied from interface: GqAARequest
Returns the Binding-Information AVP.

Specified by:
getBindingInformation in interface GqAARequest
Returns:

setBindingInformation

public void setBindingInformation(BindingInformation bindingInformation)
                           throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets a Binding-Information AVP in the message, of type BindingInformation.

Specified by:
setBindingInformation in interface GqAARequest
Throws:
java.lang.IllegalStateException

hasBindingInformation

public boolean hasBindingInformation()
Description copied from interface: GqAARequest
Returns true if the Binding-Information AVP is present in the message.

Specified by:
hasBindingInformation in interface GqAARequest
Returns:

getLatchingIndication

public LatchingIndication getLatchingIndication()
Description copied from interface: GqAARequest
Returns the Latching-Information AVP.

Specified by:
getLatchingIndication in interface GqAARequest
Returns:

setLatchingIndication

public void setLatchingIndication(LatchingIndication latchingIndication)
                           throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets a Latching-Indication AVP in the message, of type BindingInformation.

Specified by:
setLatchingIndication in interface GqAARequest
Throws:
java.lang.IllegalStateException

hasLatchingIndication

public boolean hasLatchingIndication()
Description copied from interface: GqAARequest
Returns true if the Latching-Indication AVP is present in the message.

Specified by:
hasLatchingIndication in interface GqAARequest
Returns:

getReservationPriority

public ReservationPriority getReservationPriority()
Description copied from interface: GqAARequest
Returns the Reservation-Priority AVP.

Specified by:
getReservationPriority in interface GqAARequest
Returns:

setReservationPriority

public void setReservationPriority(ReservationPriority reservationPriority)
                            throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets a Reservation-Priority AVP in the message, of type ReservationPriority.

Specified by:
setReservationPriority in interface GqAARequest
Throws:
java.lang.IllegalStateException

hasReservationPriority

public boolean hasReservationPriority()
Description copied from interface: GqAARequest
Returns true if the Reservation-Priority AVP is present in the message.

Specified by:
hasReservationPriority in interface GqAARequest
Returns:

getGloballyUniqueAddress

public GloballyUniqueAddress getGloballyUniqueAddress()
Description copied from interface: GqAARequest
Returns the Globally-Unique-Address AVP.

Specified by:
getGloballyUniqueAddress in interface GqAARequest
Returns:

setGloballyUniqueAddress

public void setGloballyUniqueAddress(GloballyUniqueAddress globallyUniqueAddress)
                              throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets a Globally-Unique-Address AVP in the message, of type GloballyUniqueAddress.

Specified by:
setGloballyUniqueAddress in interface GqAARequest
Throws:
java.lang.IllegalStateException

hasGloballyUniqueAddress

public boolean hasGloballyUniqueAddress()
Description copied from interface: GqAARequest
Returns true if the Globally-Unique-Address AVP is present in the message.

Specified by:
hasGloballyUniqueAddress in interface GqAARequest
Returns:

hasServiceClass

public boolean hasServiceClass()
Description copied from interface: GqAARequest
Returns true if the Service-Class AVP is present in the message.

Specified by:
hasServiceClass in interface GqAARequest

getServiceClass

public java.lang.String getServiceClass()
Description copied from interface: GqAARequest
Returns the value of the Service-Class AVP, of type UTF8String.

Specified by:
getServiceClass in interface GqAARequest
Returns:
the value of the Service-Class AVP or null if it has not been set on this message

setServiceClass

public void setServiceClass(java.lang.String serviceClass)
Description copied from interface: GqAARequest
Sets the value of the Service-Class AVP, of type UTF8String.

Specified by:
setServiceClass in interface GqAARequest

getOverbookingIndicator

public OverbookingIndicator getOverbookingIndicator()
Description copied from interface: GqAARequest
Returns the Overbooking-Indicator AVP.

Specified by:
getOverbookingIndicator in interface GqAARequest
Returns:

setOverbookingIndicator

public void setOverbookingIndicator(OverbookingIndicator overbookingIndicator)
                             throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets a Overbooking-Indicator AVP in the message, of type OverbookingIndicator.

Specified by:
setOverbookingIndicator in interface GqAARequest
Throws:
java.lang.IllegalStateException

hasOverbookingIndicator

public boolean hasOverbookingIndicator()
Description copied from interface: GqAARequest
Returns true if the Overbooking-Indicator AVP is present in the message.

Specified by:
hasOverbookingIndicator in interface GqAARequest
Returns:

getAuthorizationPackageIds

public java.lang.String[] getAuthorizationPackageIds()
Description copied from interface: GqAARequest
Returns the set of Authorization-Package-Id AVPs.

Specified by:
getAuthorizationPackageIds in interface GqAARequest
Returns:

setAuthorizationPackageId

public void setAuthorizationPackageId(java.lang.String authorizationPackageId)
                               throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets a single Authorization-Package-Id AVP in the message, of type UTF8String.

Specified by:
setAuthorizationPackageId in interface GqAARequest
Throws:
java.lang.IllegalStateException

setAuthorizationPackageIds

public void setAuthorizationPackageIds(java.lang.String[] authorizationPackageIds)
                                throws java.lang.IllegalStateException
Description copied from interface: GqAARequest
Sets the set of Authorization-Package-Id AVPs, with all the values in the given array.

Specified by:
setAuthorizationPackageIds in interface GqAARequest
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


Copyright © 2012. All Rights Reserved.