public interface AccountingRequest extends DiameterMessage
6.2.2 Accounting-Request Message The ACR messages, indicated by the Command-Code field set to 271 is sent by the CTF to the CDF in order to sent charging information for the request bearer / subsystem /service. The ACR message format is defined according to the Diameter Base Protocol [401] as follows: <Accounting-Request> ::= < Diameter Header: 271, REQ, PXY > < Session-Id > { Origin-Host } { Origin-Realm } { Destination-Realm } { Accounting-Record-Type } { Accounting-Record-Number } { Acct-Application-Id } [ User-Name ] [ Acct-Interim-Interval ] [ Origin-State-Id ] [ Event-Timestamp ] * [ Proxy-Info ] * [ Route-Record ] [ Service-Context-Id ] [ Service-Information ] * [ AVP ] Note: Due to current implementation details specification of this Accounting-Request was altered [ Acct-Application-Id ] is changed to { Acct-Application-Id }.
Modifier and Type | Field and Description |
---|---|
static int |
commandCode |
Modifier and Type | Method and Description |
---|---|
long |
getAccountingRecordNumber()
Returns the value of the Accounting-Record-Number AVP, of type Unsigned32.
|
AccountingRecordType |
getAccountingRecordType()
Returns the value of the Accounting-Record-Type AVP, of type Enumerated.
|
long |
getAcctApplicationId()
Returns the value of the Acct-Application-Id AVP, of type Unsigned32.
|
long |
getAcctInterimInterval()
Returns the value of the Acct-Interim-Interval AVP, of type Unsigned32.
|
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.
|
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.
|
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.
|
java.lang.String |
getUserName()
Returns the value of the User-Name AVP, of type UTF8String.
|
boolean |
hasAccountingRecordNumber()
Returns true if the Accounting-Record-Number AVP is present in the message.
|
boolean |
hasAccountingRecordType()
Returns true if the Accounting-Record-Type AVP is present in the message.
|
boolean |
hasAcctApplicationId()
Returns true if the Acct-Application-Id AVP is present in the message.
|
boolean |
hasAcctInterimInterval()
Returns true if the Acct-Interim-Interval 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 |
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 |
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 |
hasUserName()
Returns true if the User-Name AVP is present in the message.
|
void |
removeAccountingRecordNumber()
Removes the Accounting-Record-Number AVP from the message.
|
void |
removeAccountingRecordType()
Removes the Accounting-Record-Type AVP from the message.
|
void |
removeAcctApplicationId()
Removes the Acct-Application-Id AVP from the message.
|
void |
removeAcctInterimInterval()
Removes the Acct-Interim-Interval 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 |
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 |
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 |
removeUserName()
Removes the User-Name AVP from the message.
|
void |
setAccountingRecordNumber(long accountingRecordNumber)
Sets the value of the Accounting-Record-Number AVP, of type Unsigned32.
|
void |
setAccountingRecordType(AccountingRecordType accountingRecordType)
Sets the value of the Accounting-Record-Type AVP, of type Enumerated.
|
void |
setAcctApplicationId(long acctApplicationId)
Sets the value of the Acct-Application-Id AVP, of type Unsigned32.
|
void |
setAcctInterimInterval(long acctInterimInterval)
Sets the value of the Acct-Interim-Interval AVP, of type Unsigned32.
|
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 |
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 |
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 |
setUserName(java.lang.String userName)
Sets the value of the User-Name AVP, of type UTF8String.
|
clone, getAvps, getCommand, getDestinationHost, getHeader, setDestinationHost
static final int commandCode
boolean hasSessionId()
java.lang.String getSessionId()
getSessionId
in interface DiameterMessage
void setSessionId(java.lang.String sessionId)
setSessionId
in interface DiameterMessage
java.lang.NullPointerException
- if sessionId
is null
.void removeSessionId()
boolean hasOriginHost()
DiameterIdentity getOriginHost()
getOriginHost
in interface DiameterMessage
void setOriginHost(DiameterIdentity originHost)
setOriginHost
in interface DiameterMessage
java.lang.NullPointerException
- if originHost
is null
.void removeOriginHost()
boolean hasOriginRealm()
DiameterIdentity getOriginRealm()
getOriginRealm
in interface DiameterMessage
void setOriginRealm(DiameterIdentity originRealm)
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 hasAccountingRecordType()
AccountingRecordType getAccountingRecordType()
void setAccountingRecordType(AccountingRecordType accountingRecordType)
java.lang.NullPointerException
- if accountingRecordType
is null
.void removeAccountingRecordType()
boolean hasAccountingRecordNumber()
long getAccountingRecordNumber()
hasAccountingRecordNumber()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Accounting-Record-Number AVP has not been set on this messagevoid setAccountingRecordNumber(long accountingRecordNumber)
void removeAccountingRecordNumber()
boolean hasAcctApplicationId()
long getAcctApplicationId()
hasAcctApplicationId()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Acct-Application-Id AVP has not been set on this messagevoid setAcctApplicationId(long acctApplicationId)
void removeAcctApplicationId()
boolean hasUserName()
java.lang.String getUserName()
void setUserName(java.lang.String userName)
java.lang.NullPointerException
- if userName
is null
.void removeUserName()
boolean hasAcctInterimInterval()
long getAcctInterimInterval()
hasAcctInterimInterval()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Acct-Interim-Interval AVP has not been set on this messagevoid setAcctInterimInterval(long acctInterimInterval)
void removeAcctInterimInterval()
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()
ProxyInfo[] getProxyInfos()
void setProxyInfo(ProxyInfo proxyInfo)
java.lang.NullPointerException
- if proxyInfo
is null
.void setProxyInfos(ProxyInfo[] proxyInfos)
java.lang.NullPointerException
- if proxyInfos
is null
.void removeProxyInfos()
DiameterIdentity[] getRouteRecords()
void setRouteRecord(DiameterIdentity routeRecord)
java.lang.NullPointerException
- if routeRecord
is null
.void setRouteRecords(DiameterIdentity[] routeRecords)
java.lang.NullPointerException
- if routeRecords
is null
.void removeRouteRecords()
boolean hasServiceContextId()
java.lang.String getServiceContextId()
void setServiceContextId(java.lang.String serviceContextId)
java.lang.NullPointerException
- if serviceContextId
is null
.void removeServiceContextId()
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()