All Superinterfaces:

Cloneable, DiameterMessage

All Known Subinterfaces:

CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest
```
public interface CreditControlMessage
extends DiameterMessage
```
Interface containing accessor methods for AVPs present in all Diameter CCA messages. Useful for defining utility methods to read/change a common AVP of any type of message.

Author:

Open Cloud

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	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.
`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.
`DiameterIdentity[]`	`getRouteRecords()`	Returns the set of Route-Record AVPs.
`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`	`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`	`hasSessionId()`	Returns true if the Session-Id AVP is present in 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`	`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`	`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`	`setSessionId(String sessionId)`	Sets the value of the Session-Id AVP, of type UTF8String.

Methods inherited from interface org.jainslee.resources.diameter.base.DiameterMessage
clone, getAvps, getCommand, getDestinationHost, getDestinationRealm, getHeader, setDestinationHost, setDestinationRealm

- Method Detail
  - hasSessionId
```
boolean hasSessionId()
```
    Returns true if the Session-Id AVP is present in the message.
  - getSessionId
```
String getSessionId()
```
    Returns the value of the Session-Id AVP, of type UTF8String.
    
    Specified by:
    
    getSessionId in interface DiameterMessage
    
    Returns:
    
    the value of the Session-Id AVP or null if it has not been set on this message
  - setSessionId
```
void setSessionId(String sessionId)
```
    Sets the value of the Session-Id AVP, of type UTF8String.
    
    Specified by:
    
    setSessionId in interface DiameterMessage
    
    Throws:
    
    IllegalStateException - if setSessionId has already been called
  - hasOriginHost
```
boolean hasOriginHost()
```
    Returns true if the Origin-Host AVP is present in the message.
  - getOriginHost
```
DiameterIdentity getOriginHost()
```
    Returns the value of the Origin-Host AVP, of type DiameterIdentity.
    
    Specified by:
    
    getOriginHost in interface DiameterMessage
    
    Returns:
    
    the value of the Origin-Host AVP or null if it has not been set on this message
  - setOriginHost
```
void setOriginHost(DiameterIdentity originHost)
```
    Sets the value of the Origin-Host AVP, of type DiameterIdentity.
    
    Specified by:
    
    setOriginHost in interface DiameterMessage
    
    Throws:
    
    IllegalStateException - if setOriginHost has already been called
  - hasOriginRealm
```
boolean hasOriginRealm()
```
    Returns true if the Origin-Realm AVP is present in the message.
  - getOriginRealm
```
DiameterIdentity getOriginRealm()
```
    Returns the value of the Origin-Realm AVP, of type DiameterIdentity.
    
    Specified by:
    
    getOriginRealm in interface DiameterMessage
    
    Returns:
    
    the value of the Origin-Realm AVP or null if it has not been set on this message
  - setOriginRealm
```
void setOriginRealm(DiameterIdentity originRealm)
```
    Sets the value of the Origin-Realm AVP, of type DiameterIdentity.
    
    Specified by:
    
    setOriginRealm in interface DiameterMessage
    
    Throws:
    
    IllegalStateException - if setOriginRealm has already been called
  - hasAuthApplicationId
```
boolean hasAuthApplicationId()
```
    Returns true if the Auth-Application-Id AVP is present in the message.
  - getAuthApplicationId
```
long getAuthApplicationId()
```
    Returns the value of the Auth-Application-Id AVP, of type Unsigned32. Use hasAuthApplicationId() to check the existence of this AVP.
    
    Returns:
    
    the value of the Auth-Application-Id AVP
    
    Throws:
    
    IllegalStateException - if the Auth-Application-Id AVP has not been set on this message
  - setAuthApplicationId
```
void setAuthApplicationId(long authApplicationId)
```
    Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
    
    Throws:
    
    IllegalStateException - if setAuthApplicationId has already been called
  - hasCcRequestType
```
boolean hasCcRequestType()
```
    Returns true if the CC-Request-Type AVP is present in the message.
  - getCcRequestType
```
CcRequestType getCcRequestType()
```
    Returns the value of the CC-Request-Type AVP, of type Enumerated.
    
    Returns:
    
    the value of the CC-Request-Type AVP or null if it has not been set on this message
  - setCcRequestType
```
void setCcRequestType(CcRequestType ccRequestType)
```
    Sets the value of the CC-Request-Type AVP, of type Enumerated.
    
    Throws:
    
    IllegalStateException - if setCcRequestType has already been called
  - hasCcRequestNumber
```
boolean hasCcRequestNumber()
```
    Returns true if the CC-Request-Number AVP is present in the message.
  - getCcRequestNumber
```
long getCcRequestNumber()
```
    Returns the value of the CC-Request-Number AVP, of type Unsigned32. Use hasCcRequestNumber() to check the existence of this AVP.
    
    Returns:
    
    the value of the CC-Request-Number AVP
    
    Throws:
    
    IllegalStateException - if the CC-Request-Number AVP has not been set on this message
  - setCcRequestNumber
```
void setCcRequestNumber(long ccRequestNumber)
```
    Sets the value of the CC-Request-Number AVP, of type Unsigned32.
    
    Throws:
    
    IllegalStateException - if setCcRequestNumber has already been called
  - getProxyInfos
```
ProxyInfo[] getProxyInfos()
```
    Returns the set of Proxy-Info AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Proxy-Info AVPs have been set. The elements in the given array are ProxyInfo objects.
  - setProxyInfo
```
void setProxyInfo(ProxyInfo proxyInfo)
```
    Sets a single Proxy-Info AVP in the message, of type Grouped.
    
    Throws:
    
    IllegalStateException - if setProxyInfo or setProxyInfos has already been called
  - setProxyInfos
```
void setProxyInfos(ProxyInfo[] proxyInfos)
```
    Sets the set of Proxy-Info AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array.
    Note: the array must not be altered by the caller following this call, and getProxyInfos() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
    
    Throws:
    
    IllegalStateException - if setProxyInfo or setProxyInfos has already been called
  - getRouteRecords
```
DiameterIdentity[] getRouteRecords()
```
    Returns the set of Route-Record AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Route-Record AVPs have been set. The elements in the given array are DiameterIdentity objects.
  - setRouteRecord
```
void setRouteRecord(DiameterIdentity routeRecord)
```
    Sets a single Route-Record AVP in the message, of type DiameterIdentity.
    
    Throws:
    
    IllegalStateException - if setRouteRecord or setRouteRecords has already been called
  - setRouteRecords
```
void setRouteRecords(DiameterIdentity[] routeRecords)
```
    Sets the set of Route-Record AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array.
    Note: the array must not be altered by the caller following this call, and getRouteRecords() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
    
    Throws:
    
    IllegalStateException - if setRouteRecord or setRouteRecords has already been called

Interface CreditControlMessage

Method Summary

Methods inherited from interface org.jainslee.resources.diameter.base.DiameterMessage

Method Detail

hasSessionId

getSessionId

setSessionId

hasOriginHost

getOriginHost

setOriginHost

hasOriginRealm

getOriginRealm

setOriginRealm

hasAuthApplicationId

getAuthApplicationId

setAuthApplicationId

hasCcRequestType

getCcRequestType

setCcRequestType

hasCcRequestNumber

getCcRequestNumber

setCcRequestNumber

getProxyInfos

setProxyInfo

setProxyInfos

getRouteRecords

setRouteRecord

setRouteRecords