CreditControlRequest (Mobicents :: Diameter Resources :: cca-common-events 2.3.0.FINAL API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.java.slee.resource.diameter.cca.events
Interface CreditControlRequest

All Superinterfaces:: java.lang.Cloneable, CreditControlMessage, net.java.slee.resource.diameter.base.events.DiameterMessage

All Known Implementing Classes:: CreditControlRequestImpl

public interface CreditControlRequest
extends CreditControlMessage
extends CreditControlMessage

 3.1.  Credit-Control-Request (CCR) Command
   The Credit-Control-Request message (CCR) is indicated by the
   command-code field being set to 272 and the íRí bit being set in the
   Command Flags field.  It is used between the Diameter credit-control
   client and the credit-control server to request credit authorization
   for a given service.
   The Auth-Application-Id MUST be set to the value 4, indicating the
   Diameter credit-control application.

       ::= < Diameter Header: 272, REQ, PXY >
                                   < Session-Id >
                                   { Origin-Host }
                                   { Origin-Realm }
                                   { Destination-Realm }
                                   { Auth-Application-Id }
                                   { Service-Context-Id }
                                   { CC-Request-Type }
                                   { CC-Request-Number }
                                   [ Destination-Host ]
                                   [ User-Name ]
                                   [ CC-Sub-Session-Id ]
                                   [ Acct-Multi-Session-Id ]
                                   [ Origin-State-Id ]
                                   [ Event-Timestamp ]
                                  *[ Subscription-Id ]
                                   [ Service-Identifier ]
                                   [ Termination-Cause ]
                                   [ Requested-Service-Unit ]
                                   [ Requested-Action ]
                                  *[ Used-Service-Unit ]
                                   [ Multiple-Services-Indicator ]
                                  *[ Multiple-Services-Credit-Control ]
                                  *[ Service-Parameter-Info ]
                                   [ CC-Correlation-Id ]
                                   [ User-Equipment-Info ]
                                  *[ Proxy-Info ]
                                  *[ Route-Record ]
                                  *[ AVP ]

Author:: Alexandre MendonÁa

Field Summary

Fields inherited from interface net.java.slee.resource.diameter.cca.events.CreditControlMessage
`commandCode`

Method Summary
`byte[]`	`getCcCorrelationId()` Returns the value of the CC-Correlation-Id AVP, of type OctetString.
`MultipleServicesIndicatorType`	`getMultipleServicesIndicator()` Returns the value of the Multiple-Services-Indicator AVP, of type Enumerated.
`RequestedActionType`	`getRequestedAction()` Returns the value of the Requested-Action AVP, of type Enumerated.
`RequestedServiceUnitAvp`	`getRequestedServiceUnit()` Returns the value of the Requested-Service-Unit AVP, of type Grouped.
`java.lang.String`	`getServiceContextId()` Returns the value of the Service-Context-Id AVP, of type UTF8String.
`long`	`getServiceIdentifier()` Returns the value of the Service-Identifier AVP, of type Unsigned32.
`ServiceParameterInfoAvp[]`	`getServiceParameterInfos()` Returns the set of Service-Parameter-Info AVPs.
`SubscriptionIdAvp[]`	`getSubscriptionIds()` Returns the set of Subscription-Id AVPs.
`net.java.slee.resource.diameter.base.events.avp.TerminationCauseType`	`getTerminationCause()` Returns the value of the Termination-Cause AVP, of type Enumerated.
`UsedServiceUnitAvp[]`	`getUsedServiceUnits()` Returns the set of Used-Service-Unit AVPs.
`UserEquipmentInfoAvp`	`getUserEquipmentInfo()` Returns the value of the User-Equipment-Info AVP, of type Grouped.
`boolean`	`hasCcCorrelationId()` Returns true if the CC-Correlation-Id AVP is present in the message.
`boolean`	`hasMultipleServicesIndicator()` Returns true if the Multiple-Services-Indicator AVP is present in the message.
`boolean`	`hasRequestedAction()` Returns true if the Requested-Action AVP is present in the message.
`boolean`	`hasRequestedServiceUnit()` Returns true if the Requested-Service-Unit AVP is present in the message.
`boolean`	`hasServiceContextId()` Returns true if the Service-Context-Id AVP is present in the message.
`boolean`	`hasServiceIdentifier()` Returns true if the Service-Identifier AVP is present in the message.
`boolean`	`hasTerminationCause()` Returns true if the Termination-Cause AVP is present in the message.
`boolean`	`hasUserEquipmentInfo()` Returns true if the User-Equipment-Info AVP is present in the message.
`void`	`setCcCorrelationId(byte[] ccCorrelationId)` Sets the value of the CC-Correlation-Id AVP, of type OctetString.
`void`	`setMultipleServicesIndicator(MultipleServicesIndicatorType multipleServicesIndicator)` Sets the value of the Multiple-Services-Indicator AVP, of type Enumerated.
`void`	`setRequestedAction(RequestedActionType requestedAction)` Sets the value of the Requested-Action AVP, of type Enumerated.
`void`	`setRequestedServiceUnit(RequestedServiceUnitAvp requestedServiceUnit)` Sets the value of the Requested-Service-Unit AVP, of type Grouped.
`void`	`setServiceContextId(java.lang.String serviceContextId)` Sets the value of the Service-Context-Id AVP, of type UTF8String.
`void`	`setServiceIdentifier(long serviceIdentifier)` Sets the value of the Service-Identifier AVP, of type Unsigned32.
`void`	`setServiceParameterInfo(ServiceParameterInfoAvp serviceParameterInfo)` Sets a single Service-Parameter-Info AVP in the message, of type Grouped.
`void`	`setServiceParameterInfos(ServiceParameterInfoAvp[] serviceParameterInfos)` Sets the set of Service-Parameter-Info AVPs, with all the values in the given array.
`void`	`setSubscriptionId(SubscriptionIdAvp subscriptionId)` Sets a single Subscription-Id AVP in the message, of type Grouped.
`void`	`setSubscriptionIds(SubscriptionIdAvp[] subscriptionIds)` Sets the set of Subscription-Id 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 Enumerated.
`void`	`setUsedServiceUnit(UsedServiceUnitAvp usedServiceUnit)` Sets a single Used-Service-Unit AVP in the message, of type Grouped.
`void`	`setUsedServiceUnits(UsedServiceUnitAvp[] usedServiceUnits)` Sets the set of Used-Service-Unit AVPs, with all the values in the given array.
`void`	`setUserEquipmentInfo(UserEquipmentInfoAvp userEquipmentInfo)` Sets the value of the User-Equipment-Info AVP, of type Grouped.

Methods inherited from interface net.java.slee.resource.diameter.cca.events.CreditControlMessage
getAcctMultiSessionId, getAuthApplicationId, getCcRequestNumber, getCcRequestType, getCcSubSessionId, getEventTimestamp, getMultipleServicesCreditControls, getOriginStateId, getProxyInfos, getRouteRecords, getUserName, hasAcctMultiSessionId, hasAuthApplicationId, hasCcRequestNumber, hasCcRequestType, hasCcSubSessionId, hasEventTimestamp, hasMultipleServicesCreditControl, hasOriginStateId, hasUserName, setAcctMultiSessionId, setAuthApplicationId, setCcRequestNumber, setCcRequestType, setCcSubSessionId, setEventTimestamp, setMultipleServicesCreditControl, setMultipleServicesCreditControls, setOriginStateId, setProxyInfo, setProxyInfos, setRouteRecord, setRouteRecords, setUserName

Methods inherited from interface net.java.slee.resource.diameter.cca.events.CreditControlMessage

getAcctMultiSessionId, getAuthApplicationId, getCcRequestNumber, getCcRequestType, getCcSubSessionId, getEventTimestamp, getMultipleServicesCreditControls, getOriginStateId, getProxyInfos, getRouteRecords, getUserName, hasAcctMultiSessionId, hasAuthApplicationId, hasCcRequestNumber, hasCcRequestType, hasCcSubSessionId, hasEventTimestamp, hasMultipleServicesCreditControl, hasOriginStateId, hasUserName, setAcctMultiSessionId, setAuthApplicationId, setCcRequestNumber, setCcRequestType, setCcSubSessionId, setEventTimestamp, setMultipleServicesCreditControl, setMultipleServicesCreditControls, setOriginStateId, 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`

Method Detail

getCcCorrelationId

byte[] getCcCorrelationId()

Returns the value of the CC-Correlation-Id AVP, of type OctetString.

Returns:

setCcCorrelationId

void setCcCorrelationId(byte[] ccCorrelationId)
                        throws java.lang.IllegalStateException

Sets the value of the CC-Correlation-Id AVP, of type OctetString.

Parameters:: ccCorrelationId -
Throws:: java.lang.IllegalStateException

hasCcCorrelationId

boolean hasCcCorrelationId()

Returns true if the CC-Correlation-Id AVP is present in the message.

Returns:

getMultipleServicesIndicator

MultipleServicesIndicatorType getMultipleServicesIndicator()

Returns the value of the Multiple-Services-Indicator AVP, of type Enumerated.

Returns:

setMultipleServicesIndicator

void setMultipleServicesIndicator(MultipleServicesIndicatorType multipleServicesIndicator)
                                  throws java.lang.IllegalStateException

Sets the value of the Multiple-Services-Indicator AVP, of type Enumerated.

Parameters:: multipleServicesIndicator -
Throws:: java.lang.IllegalStateException

hasMultipleServicesIndicator

boolean hasMultipleServicesIndicator()

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

Returns:

getRequestedAction

RequestedActionType getRequestedAction()

Returns the value of the Requested-Action AVP, of type Enumerated.

Returns:

setRequestedAction

void setRequestedAction(RequestedActionType requestedAction)
                        throws java.lang.IllegalStateException

Sets the value of the Requested-Action AVP, of type Enumerated.

Parameters:: requestedAction -
Throws:: java.lang.IllegalStateException

hasRequestedAction

boolean hasRequestedAction()

Returns true if the Requested-Action AVP is present in the message.

Returns:

getRequestedServiceUnit

RequestedServiceUnitAvp getRequestedServiceUnit()

Returns the value of the Requested-Service-Unit AVP, of type Grouped.

Returns:

setRequestedServiceUnit

void setRequestedServiceUnit(RequestedServiceUnitAvp requestedServiceUnit)
                             throws java.lang.IllegalStateException

Sets the value of the Requested-Service-Unit AVP, of type Grouped.

Parameters:: requestedServiceUnit -
Throws:: java.lang.IllegalStateException

hasRequestedServiceUnit

boolean hasRequestedServiceUnit()

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

Returns:

getServiceContextId

java.lang.String getServiceContextId()

Returns the value of the Service-Context-Id AVP, of type UTF8String.

Returns:

setServiceContextId

void setServiceContextId(java.lang.String serviceContextId)
                         throws java.lang.IllegalStateException

Sets the value of the Service-Context-Id AVP, of type UTF8String.

Parameters:: serviceContextId -
Throws:: java.lang.IllegalStateException

hasServiceContextId

boolean hasServiceContextId()

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

Returns:

getServiceIdentifier

long getServiceIdentifier()

Returns the value of the Service-Identifier AVP, of type Unsigned32.

Returns:

setServiceIdentifier

void setServiceIdentifier(long serviceIdentifier)
                          throws java.lang.IllegalStateException

Sets the value of the Service-Identifier AVP, of type Unsigned32.

Parameters:: serviceIdentifier -
Throws:: java.lang.IllegalStateException

hasServiceIdentifier

boolean hasServiceIdentifier()

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

Returns:

getServiceParameterInfos

ServiceParameterInfoAvp[] getServiceParameterInfos()

Returns the set of Service-Parameter-Info AVPs.

Returns:

setServiceParameterInfo

void setServiceParameterInfo(ServiceParameterInfoAvp serviceParameterInfo)
                             throws java.lang.IllegalStateException

Sets a single Service-Parameter-Info AVP in the message, of type Grouped.

Parameters:: serviceParameterInfo -
Throws:: java.lang.IllegalStateException

setServiceParameterInfos

void setServiceParameterInfos(ServiceParameterInfoAvp[] serviceParameterInfos)
                              throws java.lang.IllegalStateException

Sets the set of Service-Parameter-Info AVPs, with all the values in the given array.

Parameters:: serviceParameterInfos -
Throws:: java.lang.IllegalStateException

getSubscriptionIds

SubscriptionIdAvp[] getSubscriptionIds()

Returns the set of Subscription-Id AVPs.

Returns:

setSubscriptionId

void setSubscriptionId(SubscriptionIdAvp subscriptionId)
                       throws java.lang.IllegalStateException

Sets a single Subscription-Id AVP in the message, of type Grouped.

Parameters:: subscriptionId -
Throws:: java.lang.IllegalStateException

setSubscriptionIds

void setSubscriptionIds(SubscriptionIdAvp[] subscriptionIds)
                        throws java.lang.IllegalStateException

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

Parameters:: subscriptionIds -
Throws:: java.lang.IllegalStateException

getTerminationCause

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

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

Returns:

setTerminationCause

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

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

Parameters:: terminationCause -
Throws:: java.lang.IllegalStateException

hasTerminationCause

boolean hasTerminationCause()

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

Returns:

getUsedServiceUnits

UsedServiceUnitAvp[] getUsedServiceUnits()

Returns the set of Used-Service-Unit AVPs.

Returns:

setUsedServiceUnit

void setUsedServiceUnit(UsedServiceUnitAvp usedServiceUnit)
                        throws java.lang.IllegalStateException

Sets a single Used-Service-Unit AVP in the message, of type Grouped.

Parameters:: usedServiceUnit -
Throws:: java.lang.IllegalStateException

setUsedServiceUnits

void setUsedServiceUnits(UsedServiceUnitAvp[] usedServiceUnits)
                         throws java.lang.IllegalStateException

Sets the set of Used-Service-Unit AVPs, with all the values in the given array.

Parameters:: usedServiceUnits -
Throws:: java.lang.IllegalStateException

getUserEquipmentInfo

UserEquipmentInfoAvp getUserEquipmentInfo()

Returns the value of the User-Equipment-Info AVP, of type Grouped.

Returns:

setUserEquipmentInfo

void setUserEquipmentInfo(UserEquipmentInfoAvp userEquipmentInfo)
                          throws java.lang.IllegalStateException

Sets the value of the User-Equipment-Info AVP, of type Grouped.

Parameters:: userEquipmentInfo -
Throws:: java.lang.IllegalStateException

hasUserEquipmentInfo

boolean hasUserEquipmentInfo()

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

Returns: