public interface CreditControlAnswer extends CreditControlMessage
6.4.3 Credit-Control-Answer Message The Credit-Control-Answer (CCA) messages, indicated by the Command-Code field set to 272 is sent by the OCF to the CTF in order to reply to the CCR. The CCA message format is defined according to IETF RFC 4006. <Credit-Control-Answer> ::= < Diameter Header: 272, PXY > < Session-Id > { Result-Code } { Origin-Host } { Origin-Realm } { Auth-Application-Id } { CC-Request-Type } { CC-Request-Number } [ CC-Session-Failover ] *[ Multiple-Services-Credit-Control ] [ Cost-Information] [ Credit-Control-Failure-Handling ] [ Direct-Debiting-Failure-Handling ] *[ Redirect-Host] [ Redirect-Host-Usage ] [ Redirect-Max-Cache-Time ] *[ Proxy-Info ] *[ Route-Record ] *[ Failed-AVP ] [ Service-Information ] *[ AVP ]
Modifier and Type | Field and Description |
---|---|
static int |
commandCode |
Modifier and Type | Method and Description |
---|---|
long |
getAuthApplicationId()
Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
|
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.
|
CcSessionFailover |
getCcSessionFailover()
Returns the value of the CC-Session-Failover AVP, of type Enumerated.
|
CostInformation |
getCostInformation()
Returns the value of the Cost-Information AVP, of type Grouped.
|
CreditControlFailureHandling |
getCreditControlFailureHandling()
Returns the value of the Credit-Control-Failure-Handling AVP, of type Enumerated.
|
DirectDebitingFailureHandling |
getDirectDebitingFailureHandling()
Returns the value of the Direct-Debiting-Failure-Handling AVP, of type Enumerated.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
FailedAvp[] |
getFailedAvps()
Returns the set of Failed-AVP AVPs.
|
MultipleServicesCreditControl[] |
getMultipleServicesCreditControls()
Returns the set of Multiple-Services-Credit-Control AVPs.
|
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.
|
ProxyInfo[] |
getProxyInfos()
Returns the set of Proxy-Info AVPs.
|
DiameterURI[] |
getRedirectHosts()
Returns the set of Redirect-Host AVPs.
|
RedirectHostUsage |
getRedirectHostUsage()
Returns the value of the Redirect-Host-Usage AVP, of type Enumerated.
|
long |
getRedirectMaxCacheTime()
Returns the value of the Redirect-Max-Cache-Time AVP, of type Unsigned32.
|
long |
getResultCode()
Returns the value of the Result-Code AVP, of type Unsigned32.
|
DiameterIdentity[] |
getRouteRecords()
Returns the set of Route-Record AVPs.
|
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.
|
boolean |
hasAuthApplicationId()
Returns true if the Auth-Application-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 |
hasCcSessionFailover()
Returns true if the CC-Session-Failover AVP is present in the message.
|
boolean |
hasCostInformation()
Returns true if the Cost-Information AVP is present in the message.
|
boolean |
hasCreditControlFailureHandling()
Returns true if the Credit-Control-Failure-Handling AVP is present in the message.
|
boolean |
hasDirectDebitingFailureHandling()
Returns true if the Direct-Debiting-Failure-Handling 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 |
hasRedirectHostUsage()
Returns true if the Redirect-Host-Usage AVP is present in the message.
|
boolean |
hasRedirectMaxCacheTime()
Returns true if the Redirect-Max-Cache-Time AVP is present in the message.
|
boolean |
hasResultCode()
Returns true if the Result-Code 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.
|
void |
removeAuthApplicationId()
Removes the Auth-Application-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 |
removeCcSessionFailover()
Removes the CC-Session-Failover AVP from the message.
|
void |
removeCostInformation()
Removes the Cost-Information AVP from the message.
|
void |
removeCreditControlFailureHandling()
Removes the Credit-Control-Failure-Handling AVP from the message.
|
void |
removeDirectDebitingFailureHandling()
Removes the Direct-Debiting-Failure-Handling AVP from the message.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the message.
|
void |
removeFailedAvps()
Removes all Failed-AVP AVPs from the message.
|
void |
removeMultipleServicesCreditControls()
Removes all Multiple-Services-Credit-Control AVPs from the message.
|
void |
removeOriginHost()
Removes the Origin-Host AVP from the message.
|
void |
removeOriginRealm()
Removes the Origin-Realm AVP from the message.
|
void |
removeProxyInfos()
Removes all Proxy-Info AVPs from the message.
|
void |
removeRedirectHosts()
Removes all Redirect-Host AVPs from the message.
|
void |
removeRedirectHostUsage()
Removes the Redirect-Host-Usage AVP from the message.
|
void |
removeRedirectMaxCacheTime()
Removes the Redirect-Max-Cache-Time AVP from the message.
|
void |
removeResultCode()
Removes the Result-Code AVP from the message.
|
void |
removeRouteRecords()
Removes all Route-Record AVPs from the message.
|
void |
removeServiceInformation()
Removes the Service-Information AVP from the message.
|
void |
removeSessionId()
Removes the Session-Id AVP from the message.
|
void |
setAuthApplicationId(long authApplicationId)
Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
|
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 |
setCcSessionFailover(CcSessionFailover ccSessionFailover)
Sets the value of the CC-Session-Failover AVP, of type Enumerated.
|
void |
setCostInformation(CostInformation costInformation)
Sets the value of the Cost-Information AVP, of type Grouped.
|
void |
setCreditControlFailureHandling(CreditControlFailureHandling creditControlFailureHandling)
Sets the value of the Credit-Control-Failure-Handling AVP, of type Enumerated.
|
void |
setDirectDebitingFailureHandling(DirectDebitingFailureHandling directDebitingFailureHandling)
Sets the value of the Direct-Debiting-Failure-Handling AVP, of type Enumerated.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setFailedAvp(FailedAvp failedAvp)
Sets a single Failed-AVP AVP in the message, of type Grouped.
|
void |
setFailedAvps(FailedAvp[] failedAvps)
Sets the set of Failed-AVP 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 |
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 |
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 |
setRedirectHost(DiameterURI redirectHost)
Sets a single Redirect-Host AVP in the message, of type DiameterURI.
|
void |
setRedirectHosts(DiameterURI[] redirectHosts)
Sets the set of Redirect-Host AVPs, with all the values in the given array.
|
void |
setRedirectHostUsage(RedirectHostUsage redirectHostUsage)
Sets the value of the Redirect-Host-Usage AVP, of type Enumerated.
|
void |
setRedirectMaxCacheTime(long redirectMaxCacheTime)
Sets the value of the Redirect-Max-Cache-Time AVP, of type Unsigned32.
|
void |
setResultCode(long resultCode)
Sets the value of the Result-Code AVP, of type Unsigned32.
|
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 |
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.
|
clone, getAvps, getCommand, getDestinationHost, getDestinationRealm, getHeader, setDestinationHost, setDestinationRealm
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 hasResultCode()
long getResultCode()
hasResultCode()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Result-Code AVP has not been set on this messagevoid setResultCode(long resultCode)
void removeResultCode()
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 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 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 hasCcSessionFailover()
CcSessionFailover getCcSessionFailover()
void setCcSessionFailover(CcSessionFailover ccSessionFailover)
java.lang.NullPointerException
- if ccSessionFailover
is null
.void removeCcSessionFailover()
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 hasCostInformation()
CostInformation getCostInformation()
void setCostInformation(CostInformation costInformation)
java.lang.NullPointerException
- if costInformation
is null
.void removeCostInformation()
boolean hasCreditControlFailureHandling()
CreditControlFailureHandling getCreditControlFailureHandling()
void setCreditControlFailureHandling(CreditControlFailureHandling creditControlFailureHandling)
java.lang.NullPointerException
- if creditControlFailureHandling
is null
.void removeCreditControlFailureHandling()
boolean hasDirectDebitingFailureHandling()
DirectDebitingFailureHandling getDirectDebitingFailureHandling()
void setDirectDebitingFailureHandling(DirectDebitingFailureHandling directDebitingFailureHandling)
java.lang.NullPointerException
- if directDebitingFailureHandling
is null
.void removeDirectDebitingFailureHandling()
DiameterURI[] getRedirectHosts()
void setRedirectHost(DiameterURI redirectHost)
java.lang.NullPointerException
- if redirectHost
is null
.void setRedirectHosts(DiameterURI[] redirectHosts)
java.lang.NullPointerException
- if redirectHosts
is null
.void removeRedirectHosts()
boolean hasRedirectHostUsage()
RedirectHostUsage getRedirectHostUsage()
void setRedirectHostUsage(RedirectHostUsage redirectHostUsage)
java.lang.NullPointerException
- if redirectHostUsage
is null
.void removeRedirectHostUsage()
boolean hasRedirectMaxCacheTime()
long getRedirectMaxCacheTime()
hasRedirectMaxCacheTime()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Redirect-Max-Cache-Time AVP has not been set on this messagevoid setRedirectMaxCacheTime(long redirectMaxCacheTime)
void removeRedirectMaxCacheTime()
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()
FailedAvp[] getFailedAvps()
void setFailedAvp(FailedAvp failedAvp)
java.lang.NullPointerException
- if failedAvp
is null
.void setFailedAvps(FailedAvp[] failedAvps)
java.lang.NullPointerException
- if failedAvps
is null
.void removeFailedAvps()
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()