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

All Superinterfaces:

java.lang.Cloneable, net.java.slee.resource.diameter.base.events.DiameterMessage

All Known Subinterfaces:

CreditControlAnswer, CreditControlRequest

All Known Implementing Classes:

CreditControlAnswerImpl, CreditControlMessageImpl, CreditControlRequestImpl

public interface CreditControlMessage
extends net.java.slee.resource.diameter.base.events.DiameterMessage

 3.  Credit-Control Messages
   This section defines new Diameter message Command-Code values that
   MUST be supported by all Diameter implementations that conform to
   this specification.  The Command Codes are as follows:
   Command-Name                  Abbrev.    Code     Reference
   -----------------------------------------------------------
   Credit-Control-Request        CCR        272      3.1
   Credit-Control-Answer         CCA        272      3.2
   Diameter Base [DIAMBASE] defines in the section 3.2 the Command Code
   ABNF specification.  These formats are observed in Credit-Control
   messages.
 

Author:

Alexandre MendonÔøΩa

Field Summary

static int

commandCode

Method Summary

java.lang.String	getAcctMultiSessionId() Returns the value of the Acct-Multi-Session-Id AVP, of type UTF8String.
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.
long	getCcSubSessionId() Returns the value of the CC-Sub-Session-Id AVP, of type Unsigned64.
java.util.Date	getEventTimestamp() Returns the value of the Event-Timestamp AVP, of type Time.
MultipleServicesCreditControlAvp[]	getMultipleServicesCreditControls() Returns the set of Multiple-Services-Credit-Control AVPs.
long	getOriginStateId() Returns the value of the Origin-State-Id AVP, of type Unsigned32.
net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[]	getProxyInfos() Returns the set of Proxy-Info AVPs.
net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[]	getRouteRecords() Returns the set of Route-Record AVPs.
java.lang.String	getUserName() Returns the value of the User-Name AVP, of type UTF8String.
boolean	hasAcctMultiSessionId() Returns true if the Acct-Multi-Session-Id AVP is present in the message.
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	hasCcSubSessionId() Returns true if the CC-Sub-Session-Id AVP is present in the message.
boolean	hasEventTimestamp() Returns true if the Event-Timestamp AVP is present in the message.
boolean	hasMultipleServicesCreditControl() Returns tru if Multiple-Services-Credit-Control AVP is present
boolean	hasOriginStateId() Returns true if the Origin-State-Id AVP is present in the message.
boolean	hasUserName() Returns true if the User-Name AVP is present in the message.
void	setAcctMultiSessionId(java.lang.String acctMultiSessionId) Sets the value of the Acct-Multi-Session-Id AVP, of type UTF8String.
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	setCcSubSessionId(long ccSubSessionId) Sets the value of the CC-Sub-Session-Id AVP, of type Unsigned64.
void	setEventTimestamp(java.util.Date eventTimestamp) Sets the value of the Event-Timestamp AVP, of type Time.
void	setMultipleServicesCreditControl(MultipleServicesCreditControlAvp multipleServicesCreditControl) Sets a single Multiple-Services-Credit-Control AVP in the message, of type Grouped.
void	setMultipleServicesCreditControls(MultipleServicesCreditControlAvp[] multipleServicesCreditControls) Sets the set of Multiple-Services-Credit-Control AVPs, with all the values in the given array.
void	setOriginStateId(long originStateId) Sets the value of the Origin-State-Id AVP, of type Unsigned32.
void	setProxyInfo(net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp proxyInfo) Sets a single Proxy-Info AVP in the message, of type Grouped.
void	setProxyInfos(net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[] proxyInfos) Sets the set of Proxy-Info AVPs, with all the values in the given array.
void	setRouteRecord(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity routeRecord) Sets a single Route-Record AVP in the message, of type DiameterIdentity.
void	setRouteRecords(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[] routeRecords) Sets the set of Route-Record AVPs, with all the values in the given array.
void	setUserName(java.lang.String userName) Sets the value of the User-Name AVP, of type UTF8String.

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

Field Detail

commandCode

static final int commandCode

See Also:

Constant Field Values

Method Detail

getAcctMultiSessionId

java.lang.String getAcctMultiSessionId()

Returns the value of the Acct-Multi-Session-Id AVP, of type UTF8String.

Returns:

setAcctMultiSessionId

void setAcctMultiSessionId(java.lang.String acctMultiSessionId)
                           throws java.lang.IllegalStateException

Sets the value of the Acct-Multi-Session-Id AVP, of type UTF8String.

Parameters:

acctMultiSessionId -

Throws:

java.lang.IllegalStateException

hasAcctMultiSessionId

boolean hasAcctMultiSessionId()

Returns true if the Acct-Multi-Session-Id AVP is present in the message.

Returns:

getAuthApplicationId

long getAuthApplicationId()

Returns the value of the Auth-Application-Id AVP, of type Unsigned32.

Returns:

setAuthApplicationId

void setAuthApplicationId(long authApplicationId)
                          throws java.lang.IllegalStateException

Sets the value of the Auth-Application-Id AVP, of type Unsigned32.

Parameters:

authApplicationId -

Throws:

java.lang.IllegalStateException

hasAuthApplicationId

boolean hasAuthApplicationId()

Returns true if the Auth-Application-Id AVP is present in the message.

Returns:

getCcRequestNumber

long getCcRequestNumber()

Returns the value of the CC-Request-Number AVP, of type Unsigned32.

Returns:

setCcRequestNumber

void setCcRequestNumber(long ccRequestNumber)
                        throws java.lang.IllegalStateException

Sets the value of the CC-Request-Number AVP, of type Unsigned32.

Parameters:

ccRequestNumber -

Throws:

java.lang.IllegalStateException

hasCcRequestNumber

boolean hasCcRequestNumber()

Returns true if the CC-Request-Number AVP is present in the message.

Returns:

getCcRequestType

CcRequestType getCcRequestType()

Returns the value of the CC-Request-Type AVP, of type Enumerated.

Returns:

setCcRequestType

void setCcRequestType(CcRequestType ccRequestType)
                      throws java.lang.IllegalStateException

Sets the value of the CC-Request-Type AVP, of type Enumerated.

Parameters:

ccRequestType -

Throws:

java.lang.IllegalStateException

hasCcRequestType

boolean hasCcRequestType()

Returns true if the CC-Request-Type AVP is present in the message.

Returns:

getCcSubSessionId

long getCcSubSessionId()

Returns the value of the CC-Sub-Session-Id AVP, of type Unsigned64.

Returns:

setCcSubSessionId

void setCcSubSessionId(long ccSubSessionId)
                       throws java.lang.IllegalStateException

Sets the value of the CC-Sub-Session-Id AVP, of type Unsigned64.

Parameters:

ccSubSessionId -

Throws:

java.lang.IllegalStateException

hasCcSubSessionId

boolean hasCcSubSessionId()

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

Returns:

getEventTimestamp

java.util.Date getEventTimestamp()

Returns the value of the Event-Timestamp AVP, of type Time.

Returns:

setEventTimestamp

void setEventTimestamp(java.util.Date eventTimestamp)
                       throws java.lang.IllegalStateException

Sets the value of the Event-Timestamp AVP, of type Time.

Parameters:

eventTimestamp -

Throws:

java.lang.IllegalStateException

hasEventTimestamp

boolean hasEventTimestamp()

Returns true if the Event-Timestamp AVP is present in the message.

Returns:

hasMultipleServicesCreditControl

boolean hasMultipleServicesCreditControl()

Returns tru if Multiple-Services-Credit-Control AVP is present

Returns:

getMultipleServicesCreditControls

MultipleServicesCreditControlAvp[] getMultipleServicesCreditControls()

Returns the set of Multiple-Services-Credit-Control AVPs.

Returns:

setMultipleServicesCreditControl

void setMultipleServicesCreditControl(MultipleServicesCreditControlAvp multipleServicesCreditControl)
                                      throws java.lang.IllegalStateException

Sets a single Multiple-Services-Credit-Control AVP in the message, of type Grouped.

Parameters:

multipleServicesCreditControl -

Throws:

java.lang.IllegalStateException

setMultipleServicesCreditControls

void setMultipleServicesCreditControls(MultipleServicesCreditControlAvp[] multipleServicesCreditControls)
                                       throws java.lang.IllegalStateException

Sets the set of Multiple-Services-Credit-Control AVPs, with all the values in the given array.

Parameters:

multipleServicesCreditControls -

Throws:

java.lang.IllegalStateException

getOriginStateId

long getOriginStateId()

Returns the value of the Origin-State-Id AVP, of type Unsigned32.

Returns:

setOriginStateId

void setOriginStateId(long originStateId)
                      throws java.lang.IllegalStateException

Sets the value of the Origin-State-Id AVP, of type Unsigned32.

Parameters:

originStateId -

Throws:

java.lang.IllegalStateException

hasOriginStateId

boolean hasOriginStateId()

Returns true if the Origin-State-Id AVP is present in the message.

Returns:

getProxyInfos

net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[] getProxyInfos()

Returns the set of Proxy-Info AVPs.

Returns:

setProxyInfo

void setProxyInfo(net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp proxyInfo)
                  throws java.lang.IllegalStateException

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

Parameters:

proxyInfo -

Throws:

java.lang.IllegalStateException

setProxyInfos

void setProxyInfos(net.java.slee.resource.diameter.base.events.avp.ProxyInfoAvp[] proxyInfos)
                   throws java.lang.IllegalStateException

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

Parameters:

proxyInfos -

Throws:

java.lang.IllegalStateException

getRouteRecords

net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[] getRouteRecords()

Returns the set of Route-Record AVPs.

Returns:

setRouteRecord

void setRouteRecord(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity routeRecord)
                    throws java.lang.IllegalStateException

Sets a single Route-Record AVP in the message, of type DiameterIdentity.

Parameters:

routeRecord -

Throws:

java.lang.IllegalStateException

setRouteRecords

void setRouteRecords(net.java.slee.resource.diameter.base.events.avp.DiameterIdentity[] routeRecords)
                     throws java.lang.IllegalStateException

Sets the set of Route-Record AVPs, with all the values in the given array.

Parameters:

routeRecords -

Throws:

java.lang.IllegalStateException

getUserName

java.lang.String getUserName()

Returns the value of the User-Name AVP, of type UTF8String.

Returns:

setUserName

void setUserName(java.lang.String userName)
                 throws java.lang.IllegalStateException

Sets the value of the User-Name AVP, of type UTF8String.

Parameters:

userName -

Throws:

java.lang.IllegalStateException

hasUserName

boolean hasUserName()

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

Returns: