Package org.jainslee.resources.diameter.base

Interface DiameterMessageFactory

public interface DiameterMessageFactory

Factory to create instances of DiameterAvp, DiameterMessage.

An implementation of this class should be returned by the DiameterProvider.getDiameterMessageFactory() method.

Author:

Open Cloud

Method Summary

Modifier and Type	Method	Description
AbortSessionAnswer	createAbortSessionAnswer()	Create an empty AbortSessionAnswer DiameterMessage for a ASA command.
AbortSessionAnswer	createAbortSessionAnswer(DiameterAvp[] avps)	Create a AbortSessionAnswer DiameterMessage for a ASA command containing the given AVPs.
AbortSessionRequest	createAbortSessionRequest()	Create an empty AbortSessionRequest DiameterMessage for a ASR command.
AbortSessionRequest	createAbortSessionRequest(DiameterAvp[] avps)	Create a AbortSessionRequest DiameterMessage for a ASR command containing the given AVPs.
AccountingAnswer	createAccountingAnswer()	Create an empty AccountingAnswer DiameterMessage for a ACA command.
AccountingAnswer	createAccountingAnswer(DiameterAvp[] avps)	Create a AccountingAnswer DiameterMessage for a ACA command containing the given AVPs.
AccountingRequest	createAccountingRequest()	Create an empty AccountingRequest DiameterMessage for a ACR command.
AccountingRequest	createAccountingRequest(DiameterAvp[] avps)	Create a AccountingRequest DiameterMessage for a ACR command containing the given AVPs.
DiameterAvp	createAvp(int avpCode, byte[] value)	Create an AVP containing a DiameterAvpValue from the byte[] value provided.
DiameterAvp	createAvp(int avpCode, double value)	Create an AVP containing a DiameterAvpValue from the double value provided.
DiameterAvp	createAvp(int avpCode, float value)	Create an AVP containing a DiameterAvpValue from the float value provided.
DiameterAvp	createAvp(int avpCode, int value)	Create an AVP containing a DiameterAvpValue from the int value provided.
DiameterAvp	createAvp(int vendorID, int avpCode, byte[] value)	Create a vendor-specific AVP containing a DiameterAvpValue from the byte[] value provided.
DiameterAvp	createAvp(int vendorID, int avpCode, double value)	Create a vendor-specific AVP containing a DiameterAvpValue from the double value provided.
DiameterAvp	createAvp(int vendorID, int avpCode, float value)	Create a vendor-specific AVP containing a DiameterAvpValue from the float value provided.
DiameterAvp	createAvp(int vendorID, int avpCode, int value)	Create a vendor-specific AVP containing a DiameterAvpValue from the int value provided.
DiameterAvp	createAvp(int vendorID, int avpCode, long value)	Create a vendor-specific AVP containing a DiameterAvpValue from the long value provided.
DiameterAvp	createAvp(int vendorID, int avpCode, String value)	Create a vendor-specific AVP containing a DiameterAvpValue from the java.lang.String value provided.
DiameterAvp	createAvp(int vendorID, int avpCode, InetAddress value)	Create a vendor-specific AVP containing a DiameterAvpValue from the java.net.InetAddress value provided.
DiameterAvp	createAvp(int vendorID, int avpCode, Date value)	Create a vendor-specific AVP containing a DiameterAvpValue from the java.util.Date value provided.
DiameterAvp	createAvp(int vendorID, int avpCode, DiameterAvp[] avps)	Create a value for a vendor-specific Grouped AVP.
DiameterAvp	createAvp(int vendorID, int avpCode, Enumerated value)	Create a vendor-specific AVP containing a DiameterAvpValue from the org.jainslee.resources.diameter.base.types.Enumerated value provided.
DiameterAvp	createAvp(int avpCode, long value)	Create an AVP containing a DiameterAvpValue from the long value provided.
DiameterAvp	createAvp(int avpCode, String value)	Create an AVP containing a DiameterAvpValue from the java.lang.String value provided.
DiameterAvp	createAvp(int avpCode, InetAddress value)	Create an AVP containing a DiameterAvpValue from the java.net.InetAddress value provided.
DiameterAvp	createAvp(int avpCode, Date value)	Create an AVP containing a DiameterAvpValue from the java.util.Date value provided.
DiameterAvp	createAvp(int avpCode, DiameterAvp[] avps)	Create a value for a Grouped AVP.
DiameterAvp	createAvp(int avpCode, Enumerated value)	Create an AVP containing a DiameterAvpValue from the org.jainslee.resources.diameter.base.types.Enumerated value provided.
UndefinedAvp	createAvp(String name, int vendorID, int avpCode, boolean isMandatory, boolean isProtected, byte[] avpData)	Creates an undefined AVP, an AVP that is not configured in the Diameter stack.
DiameterAvp	createAvp(String name, int vendorID, int avpCode, boolean isMandatory, boolean isProtected, DiameterAvp[] avps)	Creates an undefined grouped AVP, a grouped AVP that is not configured in the Diameter stack.
CapabilitiesExchangeAnswer	createCapabilitiesExchangeAnswer()	Create an empty CapabilitiesExchangeAnswer DiameterMessage for a CEA command.
CapabilitiesExchangeAnswer	createCapabilitiesExchangeAnswer(DiameterAvp[] avps)	Create a CapabilitiesExchangeAnswer DiameterMessage for a CEA command containing the given AVPs.
CapabilitiesExchangeRequest	createCapabilitiesExchangeRequest()	Create an empty CapabilitiesExchangeRequest DiameterMessage for a CER command.
CapabilitiesExchangeRequest	createCapabilitiesExchangeRequest(DiameterAvp[] avps)	Create a CapabilitiesExchangeRequest DiameterMessage for a CER command containing the given AVPs.
CapabilitiesUpdateAnswer	createCapabilitiesUpdateAnswer()	Create an empty CapabilitiesUpdateAnswer DiameterMessage for a CUA command.
CapabilitiesUpdateAnswer	createCapabilitiesUpdateAnswer(DiameterAvp[] avps)	Create a CapabilitiesUpdateAnswer DiameterMessage for a CUA command containing the given AVPs.
CapabilitiesUpdateRequest	createCapabilitiesUpdateRequest()	Create an empty CapabilitiesUpdateRequest DiameterMessage for a CUR command.
CapabilitiesUpdateRequest	createCapabilitiesUpdateRequest(DiameterAvp[] avps)	Create a CapabilitiesUpdateRequest DiameterMessage for a CUR command containing the given AVPs.
DiameterCommand	createCommand(int commandCode, int applicationId, String shortName, String longName, boolean isRequest, boolean isProxiable)	Create an instance of a DiameterCommand concrete implementation using the given arguments.
DeviceWatchdogAnswer	createDeviceWatchdogAnswer()	Create an empty DeviceWatchdogAnswer DiameterMessage for a DWA command.
DeviceWatchdogAnswer	createDeviceWatchdogAnswer(DiameterAvp[] avps)	Create a DeviceWatchdogAnswer DiameterMessage for a DWA command containing the given AVPs.
DeviceWatchdogRequest	createDeviceWatchdogRequest()	Create an empty DeviceWatchdogRequest DiameterMessage for a DWR command.
DeviceWatchdogRequest	createDeviceWatchdogRequest(DiameterAvp[] avps)	Create a DeviceWatchdogRequest DiameterMessage for a DWR command containing the given AVPs.
DisconnectPeerAnswer	createDisconnectPeerAnswer()	Create an empty DisconnectPeerAnswer DiameterMessage for a DPA command.
DisconnectPeerAnswer	createDisconnectPeerAnswer(DiameterAvp[] avps)	Create a DisconnectPeerAnswer DiameterMessage for a DPA command containing the given AVPs.
DisconnectPeerRequest	createDisconnectPeerRequest()	Create an empty DisconnectPeerRequest DiameterMessage for a DPR command.
DisconnectPeerRequest	createDisconnectPeerRequest(DiameterAvp[] avps)	Create a DisconnectPeerRequest DiameterMessage for a DPR command containing the given AVPs.
ExperimentalResult	createExperimentalResult()	Create an empty ExperimentalResult (Grouped AVP) instance.
ExperimentalResult	createExperimentalResult(long vendorId, long experimentalResultCode)	Create a ExperimentalResult (Grouped AVP) instance using required AVP values.
ExperimentalResult	createExperimentalResult(DiameterAvp avp)	Create a ExperimentalResult (Grouped AVP) instance, populating one AVP.
ExperimentalResult	createExperimentalResult(DiameterAvp[] avps)	Create a ExperimentalResult (Grouped AVP) instance using the given array to populate the AVPs.
FailedAvp	createFailedAvp()	Create an empty FailedAvp (Grouped AVP) instance.
FailedAvp	createFailedAvp(DiameterAvp avp)	Create a FailedAvp (Grouped AVP) instance, populating one AVP.
FailedAvp	createFailedAvp(DiameterAvp[] avps)	Create a FailedAvp (Grouped AVP) instance using the given array to populate the AVPs.
ExtensionDiameterMessage	createMessage(DiameterCommand command, DiameterAvp[] avps)	Create an instance of a DiameterMessage concrete implementation using the given arguments and default AVPs required for the command (must be known to the factory).
DiameterMessage	createMessage(DiameterHeader header, DiameterAvp[] avps)
ProxyInfo	createProxyInfo()	Create an empty ProxyInfo (Grouped AVP) instance.
ProxyInfo	createProxyInfo(DiameterAvp avp)	Create a ProxyInfo (Grouped AVP) instance, populating one AVP.
ProxyInfo	createProxyInfo(DiameterAvp[] avps)	Create a ProxyInfo (Grouped AVP) instance using the given array to populate the AVPs.
ProxyInfo	createProxyInfo(DiameterIdentity proxyHost, byte[] proxyState)	Create a ProxyInfo (Grouped AVP) instance using required AVP values.
ReAuthAnswer	createReAuthAnswer()	Create an empty ReAuthAnswer DiameterMessage for a RAA command.
ReAuthAnswer	createReAuthAnswer(DiameterAvp[] avps)	Create a ReAuthAnswer DiameterMessage for a RAA command containing the given AVPs.
ReAuthRequest	createReAuthRequest()	Create an empty ReAuthRequest DiameterMessage for a RAR command.
ReAuthRequest	createReAuthRequest(DiameterAvp[] avps)	Create a ReAuthRequest DiameterMessage for a RAR command containing the given AVPs.
SessionTerminationAnswer	createSessionTerminationAnswer()	Create an empty SessionTerminationAnswer DiameterMessage for a STA command.
SessionTerminationAnswer	createSessionTerminationAnswer(DiameterAvp[] avps)	Create a SessionTerminationAnswer DiameterMessage for a STA command containing the given AVPs.
SessionTerminationRequest	createSessionTerminationRequest()	Create an empty SessionTerminationRequest DiameterMessage for a STR command.
SessionTerminationRequest	createSessionTerminationRequest(DiameterAvp[] avps)	Create a SessionTerminationRequest DiameterMessage for a STR command containing the given AVPs.
VendorSpecificApplicationId	createVendorSpecificApplicationId()	Create an empty VendorSpecificApplicationId (Grouped AVP) instance.
VendorSpecificApplicationId	createVendorSpecificApplicationId(long vendorId)	Create a VendorSpecificApplicationId (Grouped AVP) instance using required AVP values.
VendorSpecificApplicationId	createVendorSpecificApplicationId(DiameterAvp avp)	Create a VendorSpecificApplicationId (Grouped AVP) instance, populating one AVP.
VendorSpecificApplicationId	createVendorSpecificApplicationId(DiameterAvp[] avps)	Create a VendorSpecificApplicationId (Grouped AVP) instance using the given array to populate the AVPs.
DiameterAvp	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.
boolean	isRecognizedAvp(DiameterAvp avp)	Returns true if the specified AVP is recognized by this DiameterMessageFactory.

Method Detail

createAvp

DiameterAvp createAvp(int avpCode,
                      DiameterAvp[] avps)
               throws NoSuchAvpException,
                      AvpNotAllowedException

Create a value for a Grouped AVP. Type will always be DiameterAvpType.GROUPED

Parameters:

avpCode - the code for the AVP

avps - an array of DiameterAvp objects

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

AvpNotAllowedException

createAvp

DiameterAvp createAvp(int vendorID,
                      int avpCode,
                      DiameterAvp[] avps)
               throws NoSuchAvpException,
                      AvpNotAllowedException

Create a value for a vendor-specific Grouped AVP. Type will always be DiameterAvpType.GROUPED

Parameters:

vendorID - the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

avpCode - the code for the AVP

avps - an array of DiameterAvp objects

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

AvpNotAllowedException

encodeAvp

byte[] encodeAvp(DiameterAvp avp)

Encodes an AVP to a byte array using standard Diameter AVP data formats.

decodeAvp

DiameterAvp decodeAvp(byte[] bytes)
               throws DecodeException

Decodes an AVP from a byte array using standard Diameter AVP data formats.

Throws:

DecodeException

createAvp

DiameterAvp createAvp(int avpCode,
                      byte[] value)
               throws NoSuchAvpException

Create an AVP containing a DiameterAvpValue from the byte[] value provided. The AVP type will be determined from the AVP code.

Parameters:

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int vendorID,
                      int avpCode,
                      byte[] value)
               throws NoSuchAvpException

Create a vendor-specific AVP containing a DiameterAvpValue from the byte[] value provided. The AVP type will be determined from the AVP code.

Parameters:

vendorID - the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int avpCode,
                      int value)
               throws NoSuchAvpException

Create an AVP containing a DiameterAvpValue from the int value provided. The AVP type will be determined from the AVP code.

Parameters:

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int vendorID,
                      int avpCode,
                      int value)
               throws NoSuchAvpException

Create a vendor-specific AVP containing a DiameterAvpValue from the int value provided. The AVP type will be determined from the AVP code.

Parameters:

vendorID - the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int avpCode,
                      long value)
               throws NoSuchAvpException

Create an AVP containing a DiameterAvpValue from the long value provided. The AVP type will be determined from the AVP code.

Parameters:

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int vendorID,
                      int avpCode,
                      long value)
               throws NoSuchAvpException

Create a vendor-specific AVP containing a DiameterAvpValue from the long value provided. The AVP type will be determined from the AVP code.

Parameters:

vendorID - the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int avpCode,
                      float value)
               throws NoSuchAvpException

Create an AVP containing a DiameterAvpValue from the float value provided. The AVP type will be determined from the AVP code.

Parameters:

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int vendorID,
                      int avpCode,
                      float value)
               throws NoSuchAvpException

Create a vendor-specific AVP containing a DiameterAvpValue from the float value provided. The AVP type will be determined from the AVP code.

Parameters:

vendorID - the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int avpCode,
                      double value)
               throws NoSuchAvpException

Create an AVP containing a DiameterAvpValue from the double value provided. The AVP type will be determined from the AVP code.

Parameters:

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int vendorID,
                      int avpCode,
                      double value)
               throws NoSuchAvpException

Create a vendor-specific AVP containing a DiameterAvpValue from the double value provided. The AVP type will be determined from the AVP code.

Parameters:

vendorID - the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int avpCode,
                      InetAddress value)
               throws NoSuchAvpException

Create an AVP containing a DiameterAvpValue from the java.net.InetAddress value provided. The AVP type will be determined from the AVP code.

Parameters:

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int vendorID,
                      int avpCode,
                      InetAddress value)
               throws NoSuchAvpException

Create a vendor-specific AVP containing a DiameterAvpValue from the java.net.InetAddress value provided. The AVP type will be determined from the AVP code.

Parameters:

vendorID - the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int avpCode,
                      Date value)
               throws NoSuchAvpException

Create an AVP containing a DiameterAvpValue from the java.util.Date value provided. The AVP type will be determined from the AVP code.

Parameters:

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int vendorID,
                      int avpCode,
                      Date value)
               throws NoSuchAvpException

Create a vendor-specific AVP containing a DiameterAvpValue from the java.util.Date value provided. The AVP type will be determined from the AVP code.

Parameters:

vendorID - the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int avpCode,
                      String value)
               throws NoSuchAvpException

Create an AVP containing a DiameterAvpValue from the java.lang.String value provided. The AVP type will be determined from the AVP code.

Parameters:

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int vendorID,
                      int avpCode,
                      String value)
               throws NoSuchAvpException

Create a vendor-specific AVP containing a DiameterAvpValue from the java.lang.String value provided. The AVP type will be determined from the AVP code.

Parameters:

vendorID - the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int avpCode,
                      Enumerated value)
               throws NoSuchAvpException

Create an AVP containing a DiameterAvpValue from the org.jainslee.resources.diameter.base.types.Enumerated value provided. The AVP type will be determined from the AVP code.

Parameters:

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

DiameterAvp createAvp(int vendorID,
                      int avpCode,
                      Enumerated value)
               throws NoSuchAvpException

Create a vendor-specific AVP containing a DiameterAvpValue from the org.jainslee.resources.diameter.base.types.Enumerated value provided. The AVP type will be determined from the AVP code.

Parameters:

vendorID - the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

avpCode - the code for the AVP

value - the value itself

Returns:

an implementation of the DiameterAvp interface

Throws:

NoSuchAvpException

createAvp

UndefinedAvp createAvp(String name,
                       int vendorID,
                       int avpCode,
                       boolean isMandatory,
                       boolean isProtected,
                       byte[] avpData)

Creates an undefined AVP, an AVP that is not configured in the Diameter stack.

Parameters:

name - a symbolic name for this AVP, used for debugging. If null, the AVP's name will be set to the default value of UndefinedAvp.NAME.

vendorID - the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

avpCode - the code for the AVP

isMandatory - specifies whether the M bit will be set in the AVP.

isProtected - specifies whether the P bit will be set in the AVP.

avpData - the undecoded AVP data.

Returns:

an UndefinedAvp instance.

createAvp

DiameterAvp createAvp(String name,
                      int vendorID,
                      int avpCode,
                      boolean isMandatory,
                      boolean isProtected,
                      DiameterAvp[] avps)

Creates an undefined grouped AVP, a grouped AVP that is not configured in the Diameter stack. The DiameterAvp instance returned will always be of type DiameterAvpType.GROUPED, and does not need decoding, but its member AVPs may need decoding if they are UndefinedAvps.

Parameters:

name - a symbolic name for this AVP, used for debugging. If null, the AVP's name will be set to the default value of UndefinedAvp.NAME.

vendorID - the IANA-assigned enterprise number of the vendor that specified the AVP (eg. 10415 for 3GPP).

avpCode - the code for the AVP

isMandatory - specifies whether the M bit will be set in the AVP.

isProtected - specifies whether the P bit will be set in the AVP.

avps - an array of DiameterAvp objects

Returns:

a DiameterAvp instance of type DiameterAvpType.GROUPED. The member AVPs may be accessed using DiameterAvp.groupedAvpValue().

createCommand

DiameterCommand createCommand(int commandCode,
                              int applicationId,
                              String shortName,
                              String longName,
                              boolean isRequest,
                              boolean isProxiable)

Create an instance of a DiameterCommand concrete implementation using the given arguments.

Parameters:

commandCode - the command code of the command

applicationId - the application ID of the command

shortName - the short name of the command, e.g., "CER"

longName - the long name of the command, e.g., "Capabilities-Exchange-Request"

isRequest - true if this command represents a request (not answer)

isProxiable - true if this command may be proxied

Returns:

a complete and correct DiameterCommand object to be passed to createMessage(DiameterCommand, DiameterAvp[] avps).

createMessage

ExtensionDiameterMessage createMessage(DiameterCommand command,
                                       DiameterAvp[] avps)
                                throws AvpNotAllowedException

Create an instance of a DiameterMessage concrete implementation using the given arguments and default AVPs required for the command (must be known to the factory).

Parameters:

command - the command for this message

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array.

Returns:

a complete and correct DiameterMessage object to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createMessage

DiameterMessage createMessage(DiameterHeader header,
                              DiameterAvp[] avps)
                       throws AvpNotAllowedException

Throws:

AvpNotAllowedException

createAbortSessionRequest

AbortSessionRequest createAbortSessionRequest(DiameterAvp[] avps)
                                       throws AvpNotAllowedException

Create a AbortSessionRequest DiameterMessage for a ASR command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createAbortSessionRequest

AbortSessionRequest createAbortSessionRequest()

Create an empty AbortSessionRequest DiameterMessage for a ASR command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createAbortSessionAnswer

AbortSessionAnswer createAbortSessionAnswer(DiameterAvp[] avps)
                                     throws AvpNotAllowedException

Create a AbortSessionAnswer DiameterMessage for a ASA command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createAbortSessionAnswer

AbortSessionAnswer createAbortSessionAnswer()

Create an empty AbortSessionAnswer DiameterMessage for a ASA command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createAccountingRequest

AccountingRequest createAccountingRequest(DiameterAvp[] avps)
                                   throws AvpNotAllowedException

Create a AccountingRequest DiameterMessage for a ACR command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createAccountingRequest

AccountingRequest createAccountingRequest()

Create an empty AccountingRequest DiameterMessage for a ACR command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createAccountingAnswer

AccountingAnswer createAccountingAnswer(DiameterAvp[] avps)
                                 throws AvpNotAllowedException

Create a AccountingAnswer DiameterMessage for a ACA command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createAccountingAnswer

AccountingAnswer createAccountingAnswer()

Create an empty AccountingAnswer DiameterMessage for a ACA command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createCapabilitiesExchangeRequest

CapabilitiesExchangeRequest createCapabilitiesExchangeRequest(DiameterAvp[] avps)
                                                       throws AvpNotAllowedException

Create a CapabilitiesExchangeRequest DiameterMessage for a CER command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createCapabilitiesExchangeRequest

CapabilitiesExchangeRequest createCapabilitiesExchangeRequest()

Create an empty CapabilitiesExchangeRequest DiameterMessage for a CER command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createCapabilitiesExchangeAnswer

CapabilitiesExchangeAnswer createCapabilitiesExchangeAnswer(DiameterAvp[] avps)
                                                     throws AvpNotAllowedException

Create a CapabilitiesExchangeAnswer DiameterMessage for a CEA command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createCapabilitiesExchangeAnswer

CapabilitiesExchangeAnswer createCapabilitiesExchangeAnswer()

Create an empty CapabilitiesExchangeAnswer DiameterMessage for a CEA command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createCapabilitiesUpdateRequest

CapabilitiesUpdateRequest createCapabilitiesUpdateRequest(DiameterAvp[] avps)
                                                   throws AvpNotAllowedException

Create a CapabilitiesUpdateRequest DiameterMessage for a CUR command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createCapabilitiesUpdateRequest

CapabilitiesUpdateRequest createCapabilitiesUpdateRequest()

Create an empty CapabilitiesUpdateRequest DiameterMessage for a CUR command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createCapabilitiesUpdateAnswer

CapabilitiesUpdateAnswer createCapabilitiesUpdateAnswer(DiameterAvp[] avps)
                                                 throws AvpNotAllowedException

Create a CapabilitiesUpdateAnswer DiameterMessage for a CUA command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createCapabilitiesUpdateAnswer

CapabilitiesUpdateAnswer createCapabilitiesUpdateAnswer()

Create an empty CapabilitiesUpdateAnswer DiameterMessage for a CUA command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createDeviceWatchdogRequest

DeviceWatchdogRequest createDeviceWatchdogRequest(DiameterAvp[] avps)
                                           throws AvpNotAllowedException

Create a DeviceWatchdogRequest DiameterMessage for a DWR command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createDeviceWatchdogRequest

DeviceWatchdogRequest createDeviceWatchdogRequest()

Create an empty DeviceWatchdogRequest DiameterMessage for a DWR command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createDeviceWatchdogAnswer

DeviceWatchdogAnswer createDeviceWatchdogAnswer(DiameterAvp[] avps)
                                         throws AvpNotAllowedException

Create a DeviceWatchdogAnswer DiameterMessage for a DWA command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createDeviceWatchdogAnswer

DeviceWatchdogAnswer createDeviceWatchdogAnswer()

Create an empty DeviceWatchdogAnswer DiameterMessage for a DWA command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createDisconnectPeerRequest

DisconnectPeerRequest createDisconnectPeerRequest(DiameterAvp[] avps)
                                           throws AvpNotAllowedException

Create a DisconnectPeerRequest DiameterMessage for a DPR command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createDisconnectPeerRequest

DisconnectPeerRequest createDisconnectPeerRequest()

Create an empty DisconnectPeerRequest DiameterMessage for a DPR command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createDisconnectPeerAnswer

DisconnectPeerAnswer createDisconnectPeerAnswer(DiameterAvp[] avps)
                                         throws AvpNotAllowedException

Create a DisconnectPeerAnswer DiameterMessage for a DPA command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createDisconnectPeerAnswer

DisconnectPeerAnswer createDisconnectPeerAnswer()

Create an empty DisconnectPeerAnswer DiameterMessage for a DPA command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createReAuthRequest

ReAuthRequest createReAuthRequest(DiameterAvp[] avps)
                           throws AvpNotAllowedException

Create a ReAuthRequest DiameterMessage for a RAR command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createReAuthRequest

ReAuthRequest createReAuthRequest()

Create an empty ReAuthRequest DiameterMessage for a RAR command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createReAuthAnswer

ReAuthAnswer createReAuthAnswer(DiameterAvp[] avps)
                         throws AvpNotAllowedException

Create a ReAuthAnswer DiameterMessage for a RAA command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createReAuthAnswer

ReAuthAnswer createReAuthAnswer()

Create an empty ReAuthAnswer DiameterMessage for a RAA command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createSessionTerminationRequest

SessionTerminationRequest createSessionTerminationRequest(DiameterAvp[] avps)
                                                   throws AvpNotAllowedException

Create a SessionTerminationRequest DiameterMessage for a STR command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createSessionTerminationRequest

SessionTerminationRequest createSessionTerminationRequest()

Create an empty SessionTerminationRequest DiameterMessage for a STR command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createSessionTerminationAnswer

SessionTerminationAnswer createSessionTerminationAnswer(DiameterAvp[] avps)
                                                 throws AvpNotAllowedException

Create a SessionTerminationAnswer DiameterMessage for a STA command containing the given AVPs.

Parameters:

avps - an array of DiameterAvp objects. AVPs will be added to the message in the order they are in the array. May be null or empty.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

Throws:

AvpNotAllowedException

createSessionTerminationAnswer

SessionTerminationAnswer createSessionTerminationAnswer()

Create an empty SessionTerminationAnswer DiameterMessage for a STA command.

Returns:

an implementation of DiameterMessage to be passed to DiameterActivity.sendMessage(DiameterMessage).

createFailedAvp

FailedAvp createFailedAvp()

Create an empty FailedAvp (Grouped AVP) instance.

createFailedAvp

FailedAvp createFailedAvp(DiameterAvp avp)

Create a FailedAvp (Grouped AVP) instance, populating one AVP.

createFailedAvp

FailedAvp createFailedAvp(DiameterAvp[] avps)

Create a FailedAvp (Grouped AVP) instance using the given array to populate the AVPs.

createProxyInfo

ProxyInfo createProxyInfo(DiameterIdentity proxyHost,
                          byte[] proxyState)

Create a ProxyInfo (Grouped AVP) instance using required AVP values.

createProxyInfo

ProxyInfo createProxyInfo()

Create an empty ProxyInfo (Grouped AVP) instance.

createProxyInfo

ProxyInfo createProxyInfo(DiameterAvp avp)

Create a ProxyInfo (Grouped AVP) instance, populating one AVP.

createProxyInfo

ProxyInfo createProxyInfo(DiameterAvp[] avps)

Create a ProxyInfo (Grouped AVP) instance using the given array to populate the AVPs.

createVendorSpecificApplicationId

VendorSpecificApplicationId createVendorSpecificApplicationId(long vendorId)

Create a VendorSpecificApplicationId (Grouped AVP) instance using required AVP values.

createVendorSpecificApplicationId

VendorSpecificApplicationId createVendorSpecificApplicationId()

Create an empty VendorSpecificApplicationId (Grouped AVP) instance.

createVendorSpecificApplicationId

VendorSpecificApplicationId createVendorSpecificApplicationId(DiameterAvp avp)

Create a VendorSpecificApplicationId (Grouped AVP) instance, populating one AVP.

createVendorSpecificApplicationId

VendorSpecificApplicationId createVendorSpecificApplicationId(DiameterAvp[] avps)

Create a VendorSpecificApplicationId (Grouped AVP) instance using the given array to populate the AVPs.

createExperimentalResult

ExperimentalResult createExperimentalResult(long vendorId,
                                            long experimentalResultCode)

Create a ExperimentalResult (Grouped AVP) instance using required AVP values.

createExperimentalResult

ExperimentalResult createExperimentalResult()

Create an empty ExperimentalResult (Grouped AVP) instance.

createExperimentalResult

ExperimentalResult createExperimentalResult(DiameterAvp avp)

Create a ExperimentalResult (Grouped AVP) instance, populating one AVP.

createExperimentalResult

ExperimentalResult createExperimentalResult(DiameterAvp[] avps)

Create a ExperimentalResult (Grouped AVP) instance using the given array to populate the AVPs.

isRecognizedAvp

boolean isRecognizedAvp(DiameterAvp avp)

Returns true if the specified AVP is recognized by this DiameterMessageFactory. Returns false for unrecognized (e.g. Extension) AVPs.

Returns:

true if the specified AVP is recognized by this DiameterMessageFactory.