public interface CreditControlRequest extends CreditControlMessage
6.4.2 Credit-Control-Request message The CCR messages, indicated by the Command-Code field set to 272 is sent by the CTF to the OCF in order to request credits for the request bearer / subsystem /service. The CCR message format is defined according to RFC 4006 [402] as follows: <Credit-Control-Request> ::= < 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 ] [ Origin-State-Id ] [ Event-Timestamp ] *[ Subscription-Id ] [ Termination-Cause ] [ Requested-Action ] [ AoC-Request-Type ] [ Multiple-Services-Indicator ] *[ Multiple-Services-Credit-Control ] [ CC-Correlation-Id ] [ User-Equipment-Info ] *[ Proxy-Info ] *[ Route-Record ] [ Service-Information ] *[ AVP ]
Modifier and Type | Field and Description |
---|---|
static int |
commandCode |
Modifier and Type | Method and Description |
---|---|
AocRequestType |
getAocRequestType()
Returns the value of the AoC-Request-Type AVP, of type Enumerated.
|
long |
getAuthApplicationId()
Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
|
byte[] |
getCcCorrelationId()
Returns the value of the CC-Correlation-Id AVP, of type OctetString.
|
long |
getCcRequestNumber()
Returns the value of the CC-Request-Number AVP, of type Unsigned32.
|
CcRequestType |
getCcRequestType()
Returns the value of the CC-Request-Type AVP, of type Enumerated.
|
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.
|
java.util.Date |
getEventTimestamp()
Returns the value of the Event-Timestamp AVP, of type Time.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
MultipleServicesCreditControl[] |
getMultipleServicesCreditControls()
Returns the set of Multiple-Services-Credit-Control AVPs.
|
MultipleServicesIndicator |
getMultipleServicesIndicator()
Returns the value of the Multiple-Services-Indicator AVP, of type Enumerated.
|
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.
|
RequestedAction |
getRequestedAction()
Returns the value of the Requested-Action AVP, of type Enumerated.
|
DiameterIdentity[] |
getRouteRecords()
Returns the set of Route-Record AVPs.
|
java.lang.String |
getServiceContextId()
Returns the value of the Service-Context-Id AVP, of type UTF8String.
|
ServiceInformation |
getServiceInformation()
Returns the value of the Service-Information AVP, of type Grouped.
|
java.lang.String |
getSessionId()
Returns the value of the Session-Id AVP, of type UTF8String.
|
SubscriptionId[] |
getSubscriptionIds()
Returns the set of Subscription-Id AVPs.
|
TerminationCause |
getTerminationCause()
Returns the value of the Termination-Cause AVP, of type Enumerated.
|
UserEquipmentInfo |
getUserEquipmentInfo()
Returns the value of the User-Equipment-Info AVP, of type Grouped.
|
java.lang.String |
getUserName()
Returns the value of the User-Name AVP, of type UTF8String.
|
boolean |
hasAocRequestType()
Returns true if the AoC-Request-Type AVP is present in the message.
|
boolean |
hasAuthApplicationId()
Returns true if the Auth-Application-Id AVP is present in the message.
|
boolean |
hasCcCorrelationId()
Returns true if the CC-Correlation-Id AVP is present in the message.
|
boolean |
hasCcRequestNumber()
Returns true if the CC-Request-Number AVP is present in the message.
|
boolean |
hasCcRequestType()
Returns true if the CC-Request-Type 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 |
hasEventTimestamp()
Returns true if the Event-Timestamp AVP is present in the message.
|
boolean |
hasMultipleServicesIndicator()
Returns true if the Multiple-Services-Indicator 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 |
hasRequestedAction()
Returns true if the Requested-Action AVP is present in the message.
|
boolean |
hasServiceContextId()
Returns true if the Service-Context-Id AVP is present in the message.
|
boolean |
hasServiceInformation()
Returns true if the Service-Information AVP is present in the message.
|
boolean |
hasSessionId()
Returns true if the Session-Id 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.
|
boolean |
hasUserName()
Returns true if the User-Name AVP is present in the message.
|
void |
removeAocRequestType()
Removes the AoC-Request-Type AVP from the message.
|
void |
removeAuthApplicationId()
Removes the Auth-Application-Id AVP from the message.
|
void |
removeCcCorrelationId()
Removes the CC-Correlation-Id AVP from the message.
|
void |
removeCcRequestNumber()
Removes the CC-Request-Number AVP from the message.
|
void |
removeCcRequestType()
Removes the CC-Request-Type 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 |
removeEventTimestamp()
Removes the Event-Timestamp AVP from the message.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the message.
|
void |
removeMultipleServicesCreditControls()
Removes all Multiple-Services-Credit-Control AVPs from the message.
|
void |
removeMultipleServicesIndicator()
Removes the Multiple-Services-Indicator AVP 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 |
removeRequestedAction()
Removes the Requested-Action AVP from the message.
|
void |
removeRouteRecords()
Removes all Route-Record AVPs from the message.
|
void |
removeServiceContextId()
Removes the Service-Context-Id AVP from the message.
|
void |
removeServiceInformation()
Removes the Service-Information AVP from the message.
|
void |
removeSessionId()
Removes the Session-Id AVP from the message.
|
void |
removeSubscriptionIds()
Removes all Subscription-Id AVPs from the message.
|
void |
removeTerminationCause()
Removes the Termination-Cause AVP from the message.
|
void |
removeUserEquipmentInfo()
Removes the User-Equipment-Info AVP from the message.
|
void |
removeUserName()
Removes the User-Name AVP from the message.
|
void |
setAocRequestType(AocRequestType aocRequestType)
Sets the value of the AoC-Request-Type AVP, of type Enumerated.
|
void |
setAuthApplicationId(long authApplicationId)
Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
|
void |
setCcCorrelationId(byte[] ccCorrelationId)
Sets the value of the CC-Correlation-Id AVP, of type OctetString.
|
void |
setCcRequestNumber(long ccRequestNumber)
Sets the value of the CC-Request-Number AVP, of type Unsigned32.
|
void |
setCcRequestType(CcRequestType ccRequestType)
Sets the value of the CC-Request-Type AVP, of type Enumerated.
|
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 |
setEventTimestamp(java.util.Date eventTimestamp)
Sets the value of the Event-Timestamp AVP, of type Time.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setMultipleServicesCreditControl(MultipleServicesCreditControl multipleServicesCreditControl)
Sets a single Multiple-Services-Credit-Control AVP in the message, of type Grouped.
|
void |
setMultipleServicesCreditControls(MultipleServicesCreditControl[] multipleServicesCreditControls)
Sets the set of Multiple-Services-Credit-Control AVPs, with all the values in the given array.
|
void |
setMultipleServicesIndicator(MultipleServicesIndicator multipleServicesIndicator)
Sets the value of the Multiple-Services-Indicator AVP, of type Enumerated.
|
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 |
setRequestedAction(RequestedAction requestedAction)
Sets the value of the Requested-Action AVP, of type Enumerated.
|
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 |
setServiceContextId(java.lang.String serviceContextId)
Sets the value of the Service-Context-Id AVP, of type UTF8String.
|
void |
setServiceInformation(ServiceInformation serviceInformation)
Sets the value of the Service-Information AVP, of type Grouped.
|
void |
setSessionId(java.lang.String sessionId)
Sets the value of the Session-Id AVP, of type UTF8String.
|
void |
setSubscriptionId(SubscriptionId subscriptionId)
Sets a single Subscription-Id AVP in the message, of type Grouped.
|
void |
setSubscriptionIds(SubscriptionId[] subscriptionIds)
Sets the set of Subscription-Id AVPs, with all the values in the given array.
|
void |
setTerminationCause(TerminationCause terminationCause)
Sets the value of the Termination-Cause AVP, of type Enumerated.
|
void |
setUserEquipmentInfo(UserEquipmentInfo userEquipmentInfo)
Sets the value of the User-Equipment-Info AVP, of type Grouped.
|
void |
setUserName(java.lang.String userName)
Sets the value of the User-Name AVP, of type UTF8String.
|
clone, getAvps, getCommand, getHeader
static final int commandCode
boolean hasSessionId()
hasSessionId
in interface CreditControlMessage
java.lang.String getSessionId()
getSessionId
in interface CreditControlMessage
getSessionId
in interface DiameterMessage
void setSessionId(java.lang.String sessionId)
setSessionId
in interface CreditControlMessage
setSessionId
in interface DiameterMessage
java.lang.NullPointerException
- if sessionId
is null
.void removeSessionId()
boolean hasOriginHost()
hasOriginHost
in interface CreditControlMessage
DiameterIdentity getOriginHost()
getOriginHost
in interface CreditControlMessage
getOriginHost
in interface DiameterMessage
void setOriginHost(DiameterIdentity originHost)
setOriginHost
in interface CreditControlMessage
setOriginHost
in interface DiameterMessage
java.lang.NullPointerException
- if originHost
is null
.void removeOriginHost()
boolean hasOriginRealm()
hasOriginRealm
in interface CreditControlMessage
DiameterIdentity getOriginRealm()
getOriginRealm
in interface CreditControlMessage
getOriginRealm
in interface DiameterMessage
void setOriginRealm(DiameterIdentity originRealm)
setOriginRealm
in interface CreditControlMessage
setOriginRealm
in interface DiameterMessage
java.lang.NullPointerException
- if originRealm
is null
.void removeOriginRealm()
boolean hasDestinationRealm()
DiameterIdentity getDestinationRealm()
getDestinationRealm
in interface DiameterMessage
void setDestinationRealm(DiameterIdentity destinationRealm)
setDestinationRealm
in interface DiameterMessage
java.lang.NullPointerException
- if destinationRealm
is null
.void removeDestinationRealm()
boolean hasAuthApplicationId()
hasAuthApplicationId
in interface CreditControlMessage
long getAuthApplicationId()
hasAuthApplicationId()
to check the existence of this AVP.getAuthApplicationId
in interface CreditControlMessage
java.lang.IllegalStateException
- if the Auth-Application-Id AVP has not been set on this messagevoid setAuthApplicationId(long authApplicationId)
setAuthApplicationId
in interface CreditControlMessage
void removeAuthApplicationId()
boolean hasServiceContextId()
java.lang.String getServiceContextId()
void setServiceContextId(java.lang.String serviceContextId)
java.lang.NullPointerException
- if serviceContextId
is null
.void removeServiceContextId()
boolean hasCcRequestType()
hasCcRequestType
in interface CreditControlMessage
CcRequestType getCcRequestType()
getCcRequestType
in interface CreditControlMessage
void setCcRequestType(CcRequestType ccRequestType)
setCcRequestType
in interface CreditControlMessage
java.lang.NullPointerException
- if ccRequestType
is null
.void removeCcRequestType()
boolean hasCcRequestNumber()
hasCcRequestNumber
in interface CreditControlMessage
long getCcRequestNumber()
hasCcRequestNumber()
to check the existence of this AVP.getCcRequestNumber
in interface CreditControlMessage
java.lang.IllegalStateException
- if the CC-Request-Number AVP has not been set on this messagevoid setCcRequestNumber(long ccRequestNumber)
setCcRequestNumber
in interface CreditControlMessage
void removeCcRequestNumber()
boolean hasDestinationHost()
DiameterIdentity getDestinationHost()
getDestinationHost
in interface DiameterMessage
void setDestinationHost(DiameterIdentity destinationHost)
setDestinationHost
in interface DiameterMessage
java.lang.NullPointerException
- if destinationHost
is null
.void removeDestinationHost()
boolean hasUserName()
java.lang.String getUserName()
void setUserName(java.lang.String userName)
java.lang.NullPointerException
- if userName
is null
.void removeUserName()
boolean hasOriginStateId()
long getOriginStateId()
hasOriginStateId()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Origin-State-Id AVP has not been set on this messagevoid setOriginStateId(long originStateId)
void removeOriginStateId()
boolean hasEventTimestamp()
java.util.Date getEventTimestamp()
void setEventTimestamp(java.util.Date eventTimestamp)
java.lang.NullPointerException
- if eventTimestamp
is null
.void removeEventTimestamp()
SubscriptionId[] getSubscriptionIds()
void setSubscriptionId(SubscriptionId subscriptionId)
java.lang.NullPointerException
- if subscriptionId
is null
.void setSubscriptionIds(SubscriptionId[] subscriptionIds)
java.lang.NullPointerException
- if subscriptionIds
is null
.void removeSubscriptionIds()
boolean hasTerminationCause()
TerminationCause getTerminationCause()
void setTerminationCause(TerminationCause terminationCause)
java.lang.NullPointerException
- if terminationCause
is null
.void removeTerminationCause()
boolean hasRequestedAction()
RequestedAction getRequestedAction()
void setRequestedAction(RequestedAction requestedAction)
java.lang.NullPointerException
- if requestedAction
is null
.void removeRequestedAction()
boolean hasAocRequestType()
AocRequestType getAocRequestType()
void setAocRequestType(AocRequestType aocRequestType)
java.lang.NullPointerException
- if aocRequestType
is null
.void removeAocRequestType()
boolean hasMultipleServicesIndicator()
MultipleServicesIndicator getMultipleServicesIndicator()
void setMultipleServicesIndicator(MultipleServicesIndicator multipleServicesIndicator)
java.lang.NullPointerException
- if multipleServicesIndicator
is null
.void removeMultipleServicesIndicator()
MultipleServicesCreditControl[] getMultipleServicesCreditControls()
void setMultipleServicesCreditControl(MultipleServicesCreditControl multipleServicesCreditControl)
java.lang.NullPointerException
- if multipleServicesCreditControl
is null
.void setMultipleServicesCreditControls(MultipleServicesCreditControl[] multipleServicesCreditControls)
java.lang.NullPointerException
- if multipleServicesCreditControls
is null
.void removeMultipleServicesCreditControls()
boolean hasCcCorrelationId()
byte[] getCcCorrelationId()
void setCcCorrelationId(byte[] ccCorrelationId)
java.lang.NullPointerException
- if ccCorrelationId
is null
.void removeCcCorrelationId()
boolean hasUserEquipmentInfo()
UserEquipmentInfo getUserEquipmentInfo()
void setUserEquipmentInfo(UserEquipmentInfo userEquipmentInfo)
java.lang.NullPointerException
- if userEquipmentInfo
is null
.void removeUserEquipmentInfo()
ProxyInfo[] getProxyInfos()
getProxyInfos
in interface CreditControlMessage
void setProxyInfo(ProxyInfo proxyInfo)
setProxyInfo
in interface CreditControlMessage
java.lang.NullPointerException
- if proxyInfo
is null
.void setProxyInfos(ProxyInfo[] proxyInfos)
setProxyInfos
in interface CreditControlMessage
java.lang.NullPointerException
- if proxyInfos
is null
.void removeProxyInfos()
DiameterIdentity[] getRouteRecords()
getRouteRecords
in interface CreditControlMessage
void setRouteRecord(DiameterIdentity routeRecord)
setRouteRecord
in interface CreditControlMessage
java.lang.NullPointerException
- if routeRecord
is null
.void setRouteRecords(DiameterIdentity[] routeRecords)
setRouteRecords
in interface CreditControlMessage
java.lang.NullPointerException
- if routeRecords
is null
.void removeRouteRecords()
boolean hasServiceInformation()
ServiceInformation getServiceInformation()
void setServiceInformation(ServiceInformation serviceInformation)
java.lang.NullPointerException
- if serviceInformation
is null
.void removeServiceInformation()
DiameterAvp[] getExtensionAvps()
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
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
.void removeExtensionAvps()