All Known Subinterfaces:

DiameterGxMessageFactory, DiameterGxMessageFactory, DiameterGxMessageFactory, MessageFactory, MessageFactory, MessageFactory, MessageFactory, MessageFactory, MessageFactory, MessageFactory, MessageFactory, MessageFactory, MessageFactory, RoMessageFactory, RoMessageFactory, RoMessageFactory, RoMessageFactory, RoMessageFactory, RoMessageFactory, RoMessageFactory
```
public interface CreditControlMessageFactory
```
Factory to support the creation of concrete instances for Diameter Credit Control applications.

Author:

Open Cloud

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AbortSessionAnswer`	`createCcaAbortSessionAnswer()`	Create an empty AbortSessionAnswer DiameterMessage for a ASA command.
`AbortSessionRequest`	`createCcaAbortSessionRequest()`	Create an empty AbortSessionRequest DiameterMessage for a ASR command.
`ReAuthAnswer`	`createCcaReAuthAnswer()`	Create an empty ReAuthAnswer DiameterMessage for a RAA command.
`ReAuthRequest`	`createCcaReAuthRequest()`	Create an empty ReAuthRequest DiameterMessage for a RAR command.
`CcMoney`	`createCcMoney()`	Create an empty CcMoney (Grouped AVP) instance.
`CcMoney`	`createCcMoney(UnitValue unitValue)`	Create a CcMoney (Grouped AVP) instance using required AVP values.
`CostInformation`	`createCostInformation()`	Create an empty CostInformation (Grouped AVP) instance.
`CostInformation`	`createCostInformation(UnitValue unitValue, long currencyCode)`	Create a CostInformation (Grouped AVP) instance using required AVP values.
`CreditControlAnswer`	`createCreditControlAnswer()`	Create an empty Credit Control Answer message.
`CreditControlRequest`	`createCreditControlRequest()`	Create a CreditControlRequest instance, populating it with the internal AVPs not known or needed by the application.
`CreditControlRequest`	`createCreditControlRequest(String sessionId)`	Create a CreditControlRequest instance, populating it with the internal AVPs not known or needed by the application.
`FinalUnitIndication`	`createFinalUnitIndication()`	Create an empty FinalUnitIndication (Grouped AVP) instance.
`FinalUnitIndication`	`createFinalUnitIndication(FinalUnitAction finalUnitAction)`	Create a FinalUnitIndication (Grouped AVP) instance using required AVP values.
`GrantedServiceUnit`	`createGrantedServiceUnit()`	Create an empty GrantedServiceUnit (Grouped AVP) instance.
`GsuPoolReference`	`createGsuPoolReference()`	Create an empty GsuPoolReference (Grouped AVP) instance.
`GsuPoolReference`	`createGsuPoolReference(long gsuPoolIdentifier, CcUnitType ccUnitType, UnitValue unitValue)`	Create a GsuPoolReference (Grouped AVP) instance using required AVP values.
`MultipleServicesCreditControl`	`createMultipleServicesCreditControl()`	Create an empty MultipleServicesCreditControl (Grouped AVP) instance.
`RedirectServer`	`createRedirectServer()`	Create an empty RedirectServer (Grouped AVP) instance.
`RedirectServer`	`createRedirectServer(RedirectAddressType redirectAddressType, String redirectServerAddress)`	Create a RedirectServer (Grouped AVP) instance using required AVP values.
`RequestedServiceUnit`	`createRequestedServiceUnit()`	Create an empty RequestedServiceUnit (Grouped AVP) instance.
`ServiceParameterInfo`	`createServiceParameterInfo()`	Create an empty ServiceParameterInfo (Grouped AVP) instance.
`ServiceParameterInfo`	`createServiceParameterInfo(long serviceParameterType, byte[] serviceParameterValue)`	Create a ServiceParameterInfo (Grouped AVP) instance using required AVP values.
`SubscriptionId`	`createSubscriptionId()`	Create an empty SubscriptionId (Grouped AVP) instance.
`SubscriptionId`	`createSubscriptionId(SubscriptionIdType subscriptionIdType, String subscriptionIdData)`	Create a SubscriptionId (Grouped AVP) instance using required AVP values.
`UnitValue`	`createUnitValue()`	Create an empty UnitValue (Grouped AVP) instance.
`UnitValue`	`createUnitValue(long valueDigits)`	Create a UnitValue (Grouped AVP) instance using required AVP values.
`UsedServiceUnit`	`createUsedServiceUnit()`	Create an empty UsedServiceUnit (Grouped AVP) instance.
`UserEquipmentInfo`	`createUserEquipmentInfo()`	Create an empty UserEquipmentInfo (Grouped AVP) instance.
`UserEquipmentInfo`	`createUserEquipmentInfo(UserEquipmentInfoType userEquipmentInfoType, byte[] userEquipmentInfoValue)`	Create a UserEquipmentInfo (Grouped AVP) instance using required AVP values.
`<T extends DiameterAvp> T`	`decodeAvp(byte[] bytes)`	Decodes an AVP from a byte array using standard Diameter AVP data formats.
`byte[]`	`encodeAvp(DiameterAvp avp)`	Encodes an AVP to a byte array using standard Diameter AVP data formats.
`DiameterMessageFactory`	`getBaseMessageFactory()`	Get a factory to create AVPs and messages defined by Diameter Base.
`boolean`	`isRecognizedAvp(DiameterAvp avp)`	Returns true if the specified AVP is recognized by this MessageFactory.

- Method Detail
  - getBaseMessageFactory
```
DiameterMessageFactory getBaseMessageFactory()
```
    Get a factory to create AVPs and messages defined by Diameter Base.
    
    Returns:
    
    base Diameter message factory
  - createCreditControlRequest
```
CreditControlRequest createCreditControlRequest()
```
    Create a CreditControlRequest instance, populating it with the internal AVPs not known or needed by the application.
    
    Returns:
    
    a new CreditControlRequest
  - createCreditControlRequest
```
CreditControlRequest createCreditControlRequest(String sessionId)
```
    Create a CreditControlRequest instance, populating it with the internal AVPs not known or needed by the application. Use the session ID provided to find the Diameter session. This should be used when the requests are being made synchronously and there is no CreditControlClientSessionActivity available.
    
    Parameters:
    
    sessionId - the Session-Id AVP returned in the Answer to a previous sync call
    
    Returns:
    
    a new CreditControlRequest
    
    Throws:
    
    IllegalArgumentException - if sessionId is not a SessionID AVP
  - createCreditControlAnswer
```
CreditControlAnswer createCreditControlAnswer()
```
    Create an empty Credit Control Answer message.
  - createCcaReAuthRequest
```
ReAuthRequest createCcaReAuthRequest()
```
    Create an empty ReAuthRequest DiameterMessage for a RAR command.
    
    Returns:
    
    an implementation of DiameterMessage to be passed to CreditControlServerSessionActivity.sendReAuthRequest(ReAuthRequest).
  - createCcaReAuthAnswer
```
ReAuthAnswer createCcaReAuthAnswer()
```
    Create an empty ReAuthAnswer DiameterMessage for a RAA command.
    
    Returns:
    
    an implementation of DiameterMessage to be passed to CreditControlClientSessionActivity.sendReAuthAnswer(ReAuthAnswer).
  - createCcaAbortSessionRequest
```
AbortSessionRequest createCcaAbortSessionRequest()
```
    Create an empty AbortSessionRequest DiameterMessage for a ASR command.
    
    Returns:
    
    an implementation of DiameterMessage to be passed to CreditControlServerSessionActivity.sendAbortSessionRequest(AbortSessionRequest).
  - createCcaAbortSessionAnswer
```
AbortSessionAnswer createCcaAbortSessionAnswer()
```
    Create an empty AbortSessionAnswer DiameterMessage for a ASA command.
    
    Returns:
    
    an implementation of DiameterMessage to be passed to CreditControlClientSessionActivity.sendAbortSessionAnswer(AbortSessionAnswer).
  - createFinalUnitIndication
```
FinalUnitIndication createFinalUnitIndication(FinalUnitAction finalUnitAction)
```
    Create a FinalUnitIndication (Grouped AVP) instance using required AVP values.
  - createFinalUnitIndication
```
FinalUnitIndication createFinalUnitIndication()
```
    Create an empty FinalUnitIndication (Grouped AVP) instance.
  - createGrantedServiceUnit
```
GrantedServiceUnit createGrantedServiceUnit()
```
    Create an empty GrantedServiceUnit (Grouped AVP) instance.
  - createUnitValue
```
UnitValue createUnitValue(long valueDigits)
```
    Create a UnitValue (Grouped AVP) instance using required AVP values.
  - createUnitValue
```
UnitValue createUnitValue()
```
    Create an empty UnitValue (Grouped AVP) instance.
  - createCostInformation
```
CostInformation createCostInformation(UnitValue unitValue,
                                      long currencyCode)
```
    Create a CostInformation (Grouped AVP) instance using required AVP values.
  - createCostInformation
```
CostInformation createCostInformation()
```
    Create an empty CostInformation (Grouped AVP) instance.
  - createGsuPoolReference
```
GsuPoolReference createGsuPoolReference(long gsuPoolIdentifier,
                                        CcUnitType ccUnitType,
                                        UnitValue unitValue)
```
    Create a GsuPoolReference (Grouped AVP) instance using required AVP values.
  - createGsuPoolReference
```
GsuPoolReference createGsuPoolReference()
```
    Create an empty GsuPoolReference (Grouped AVP) instance.
  - createMultipleServicesCreditControl
```
MultipleServicesCreditControl createMultipleServicesCreditControl()
```
    Create an empty MultipleServicesCreditControl (Grouped AVP) instance.
  - createUsedServiceUnit
```
UsedServiceUnit createUsedServiceUnit()
```
    Create an empty UsedServiceUnit (Grouped AVP) instance.
  - createSubscriptionId
```
SubscriptionId createSubscriptionId(SubscriptionIdType subscriptionIdType,
                                    String subscriptionIdData)
```
    Create a SubscriptionId (Grouped AVP) instance using required AVP values.
  - createSubscriptionId
```
SubscriptionId createSubscriptionId()
```
    Create an empty SubscriptionId (Grouped AVP) instance.
  - createUserEquipmentInfo
```
UserEquipmentInfo createUserEquipmentInfo(UserEquipmentInfoType userEquipmentInfoType,
                                          byte[] userEquipmentInfoValue)
```
    Create a UserEquipmentInfo (Grouped AVP) instance using required AVP values.
  - createUserEquipmentInfo
```
UserEquipmentInfo createUserEquipmentInfo()
```
    Create an empty UserEquipmentInfo (Grouped AVP) instance.
  - createRedirectServer
```
RedirectServer createRedirectServer(RedirectAddressType redirectAddressType,
                                    String redirectServerAddress)
```
    Create a RedirectServer (Grouped AVP) instance using required AVP values.
  - createRedirectServer
```
RedirectServer createRedirectServer()
```
    Create an empty RedirectServer (Grouped AVP) instance.
  - createCcMoney
```
CcMoney createCcMoney(UnitValue unitValue)
```
    Create a CcMoney (Grouped AVP) instance using required AVP values.
  - createCcMoney
```
CcMoney createCcMoney()
```
    Create an empty CcMoney (Grouped AVP) instance.
  - createServiceParameterInfo
```
ServiceParameterInfo createServiceParameterInfo(long serviceParameterType,
                                                byte[] serviceParameterValue)
```
    Create a ServiceParameterInfo (Grouped AVP) instance using required AVP values.
  - createServiceParameterInfo
```
ServiceParameterInfo createServiceParameterInfo()
```
    Create an empty ServiceParameterInfo (Grouped AVP) instance.
  - createRequestedServiceUnit
```
RequestedServiceUnit createRequestedServiceUnit()
```
    Create an empty RequestedServiceUnit (Grouped AVP) instance.
  - encodeAvp
```
byte[] encodeAvp(DiameterAvp avp)
```
    Encodes an AVP to a byte array using standard Diameter AVP data formats.
  - decodeAvp
```
<T extends DiameterAvp> T decodeAvp(byte[] bytes)
                             throws DecodeException,
                                    AvpNotAllowedException
```
    Decodes an AVP from a byte array using standard Diameter AVP data formats.
    
    Throws:
    
    DecodeException
    
    AvpNotAllowedException
  - isRecognizedAvp
```
boolean isRecognizedAvp(DiameterAvp avp)
```
    Returns true if the specified AVP is recognized by this MessageFactory. Returns false for unrecognized (e.g. Extension) AVPs.
    
    Returns:
    
    true if the specified AVP is recognized by this MessageFactory.

Interface CreditControlMessageFactory

Method Summary

Method Detail

getBaseMessageFactory

createCreditControlRequest

createCreditControlRequest

createCreditControlAnswer

createCcaReAuthRequest

createCcaReAuthAnswer

createCcaAbortSessionRequest

createCcaAbortSessionAnswer

createFinalUnitIndication

createFinalUnitIndication

createGrantedServiceUnit

createUnitValue

createUnitValue

createCostInformation

createCostInformation

createGsuPoolReference

createGsuPoolReference

createMultipleServicesCreditControl

createUsedServiceUnit

createSubscriptionId

createSubscriptionId

createUserEquipmentInfo

createUserEquipmentInfo

createRedirectServer

createRedirectServer

createCcMoney

createCcMoney

createServiceParameterInfo

createServiceParameterInfo

createRequestedServiceUnit

encodeAvp

decodeAvp

isRecognizedAvp