Package org.jainslee.resources.diameter.sh.v940

Interface MessageFactory

All Known Subinterfaces:

ShMessageFactory

public interface MessageFactory

Factory to support the creation of concrete instances of AVPs for Diameter Sh applications.

Author:

Open Cloud

Method Summary

Modifier and Type	Method	Description
SupportedApplications	createSupportedApplications()	Create an empty SupportedApplications (Grouped AVP) instance.
SupportedApplications	createSupportedApplications(long authApplicationId, long acctApplicationId, VendorSpecificApplicationId vendorSpecificApplicationId)	Create a SupportedApplications (Grouped AVP) instance using required AVP values.
SupportedFeatures	createSupportedFeatures()	Create an empty SupportedFeatures (Grouped AVP) instance.
SupportedFeatures	createSupportedFeatures(long vendorId, long featureListId, long featureList)	Create a SupportedFeatures (Grouped AVP) instance using required AVP values.
UserData	createUserData(byte[] value)	Create an instance of UserData that can be set in the User-Data AVP.
UserData	createUserData(String value)	Create an instance of UserData that can be set in the User-Data AVP.
UserData	createUserData(ShData value)	Create an instance of UserData that can be set in the User-Data AVP.
UserIdentity	createUserIdentity()	Create an empty UserIdentity (Grouped AVP) instance.
<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.
UserDataObjectFactory	getUserDataObjectFactory()	Get a factory to create objects that can be marshalled into the User-Data XML document
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

getUserDataObjectFactory

UserDataObjectFactory getUserDataObjectFactory()

Get a factory to create objects that can be marshalled into the User-Data XML document

Returns:

User-Data XML object factory

createUserData

UserData createUserData(byte[] value)

Create an instance of UserData that can be set in the User-Data AVP.

Parameters:

value - an XML document as a byte array

Returns:

a UserData instance

createUserData

UserData createUserData(String value)

Create an instance of UserData that can be set in the User-Data AVP.

Parameters:

value - an XML document as a String

Returns:

a UserData instance

createUserData

UserData createUserData(ShData value)
                 throws UserDataException

Create an instance of UserData that can be set in the User-Data AVP.

Parameters:

value - ShData object created using an instance of UserDataObjectFactory.

Returns:

a UserData instance

Throws:

UserDataException

createSupportedFeatures

SupportedFeatures createSupportedFeatures(long vendorId,
                                          long featureListId,
                                          long featureList)

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

createSupportedFeatures

SupportedFeatures createSupportedFeatures()

Create an empty SupportedFeatures (Grouped AVP) instance.

createUserIdentity

UserIdentity createUserIdentity()

Create an empty UserIdentity (Grouped AVP) instance.

createSupportedApplications

SupportedApplications createSupportedApplications(long authApplicationId,
                                                  long acctApplicationId,
                                                  VendorSpecificApplicationId vendorSpecificApplicationId)

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

createSupportedApplications

SupportedApplications createSupportedApplications()

Create an empty SupportedApplications (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.