Interface MessageFactory
-
- All Known Subinterfaces:
ShMessageFactory
public interface MessageFactoryFactory to support the creation of concrete instances of AVPs for Diameter Sh applications.- Author:
- Open Cloud
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CallReferenceInfocreateCallReferenceInfo()Create an empty CallReferenceInfo (Grouped AVP) instance.CallReferenceInfocreateCallReferenceInfo(byte[] callReferenceNumber, byte[] asNumber)Create a CallReferenceInfo (Grouped AVP) instance using required AVP values.OcOlrcreateOcOlr()Create an empty OcOlr (Grouped AVP) instance.OcOlrcreateOcOlr(long ocSequenceNumber, OcReportType ocReportType)Create a OcOlr (Grouped AVP) instance using required AVP values.OcSupportedFeaturescreateOcSupportedFeatures()Create an empty OcSupportedFeatures (Grouped AVP) instance.RepositoryDataIdcreateRepositoryDataId()Create an empty RepositoryDataId (Grouped AVP) instance.RepositoryDataIdcreateRepositoryDataId(byte[] serviceIndication, long sequenceNumber)Create a RepositoryDataId (Grouped AVP) instance using required AVP values.SupportedApplicationscreateSupportedApplications()Create an empty SupportedApplications (Grouped AVP) instance.SupportedApplicationscreateSupportedApplications(long authApplicationId, long acctApplicationId, VendorSpecificApplicationId vendorSpecificApplicationId)Create a SupportedApplications (Grouped AVP) instance using required AVP values.SupportedFeaturescreateSupportedFeatures()Create an empty SupportedFeatures (Grouped AVP) instance.SupportedFeaturescreateSupportedFeatures(long vendorId, long featureListId, long featureList)Create a SupportedFeatures (Grouped AVP) instance using required AVP values.UserDatacreateUserData(byte[] value)Create an instance of UserData that can be set in the User-Data AVP.UserDatacreateUserData(String value)Create an instance of UserData that can be set in the User-Data AVP.UserDatacreateUserData(org.jainslee.resources.diameter.sh.types.userdata.rel12.ShData value)Create an instance of UserData that can be set in the User-Data AVP.UserIdentitycreateUserIdentity()Create an empty UserIdentity (Grouped AVP) instance.<T extends DiameterAvp>
TdecodeAvp(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.DiameterMessageFactorygetBaseMessageFactory()Get a factory to create AVPs and messages defined by Diameter Base.org.jainslee.resources.diameter.sh.types.userdata.rel12.UserDataObjectFactorygetUserDataObjectFactory()Get a factory to create objects that can be marshalled into the User-Data XML documentbooleanisRecognizedAvp(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
org.jainslee.resources.diameter.sh.types.userdata.rel12.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(org.jainslee.resources.diameter.sh.types.userdata.rel12.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 ofUserDataObjectFactory.- Returns:
- a UserData instance
- Throws:
UserDataException
-
createRepositoryDataId
RepositoryDataId createRepositoryDataId(byte[] serviceIndication, long sequenceNumber)
Create a RepositoryDataId (Grouped AVP) instance using required AVP values.
-
createRepositoryDataId
RepositoryDataId createRepositoryDataId()
Create an empty RepositoryDataId (Grouped AVP) instance.
-
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.
-
createOcOlr
OcOlr createOcOlr(long ocSequenceNumber, OcReportType ocReportType)
Create a OcOlr (Grouped AVP) instance using required AVP values.
-
createOcOlr
OcOlr createOcOlr()
Create an empty OcOlr (Grouped AVP) instance.
-
createCallReferenceInfo
CallReferenceInfo createCallReferenceInfo(byte[] callReferenceNumber, byte[] asNumber)
Create a CallReferenceInfo (Grouped AVP) instance using required AVP values.
-
createCallReferenceInfo
CallReferenceInfo createCallReferenceInfo()
Create an empty CallReferenceInfo (Grouped AVP) instance.
-
createOcSupportedFeatures
OcSupportedFeatures createOcSupportedFeatures()
Create an empty OcSupportedFeatures (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.
-
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.
-
-