Interface AdditionalContentInformation
-
- All Superinterfaces:
Cloneable
,DiameterAvp
,GroupedAvp
public interface AdditionalContentInformation extends GroupedAvp
Defines an interface representing the Additional-Content-Information grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V10.0.0) specification:7.2.5 Additional-Content-Information AVP The Additional-Content-Information AVP (AVP code 1207) is of type Grouped and identifies any subsequent content types. It is used to identify each content (including re-occurences) within an MM when the Type-Number AVP or Additional-Type-Information AVP from the Content-Type AVP indicate a multi- part content. It has the following ABNF grammar: Additional-Content-Information::= < AVP Header: 1207 > [ Type-Number ] [ Additional-Type-Information ] [ Content-Size ]
Note:
The support for extension AVPs is present even thou the ABNF grammar for this AVP does not contain the "* [ AVP ]" line. Be aware that adding any extension AVPs may result in interoperability problems with products that strongly validate the incoming diameter message for it's adherence to the specification.
-
-
Field Summary
-
Fields inherited from interface org.jainslee.resources.diameter.base.DiameterAvp
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getAdditionalTypeInformation()
Returns the value of the Additional-Type-Information AVP, of type UTF8String.long
getContentSize()
Returns the value of the Content-Size AVP, of type Unsigned32.DiameterAvp[]
getExtensionAvps()
Returns the set of extension AVPs.TypeNumber
getTypeNumber()
Returns the value of the Type-Number AVP, of type Enumerated.boolean
hasAdditionalTypeInformation()
Returns true if the Additional-Type-Information AVP is present in the Additional-Content-Information AVP.boolean
hasContentSize()
Returns true if the Content-Size AVP is present in the Additional-Content-Information AVP.boolean
hasTypeNumber()
Returns true if the Type-Number AVP is present in the Additional-Content-Information AVP.void
removeAdditionalTypeInformation()
Removes the Additional-Type-Information AVP from the Additional-Content-Information AVP.void
removeContentSize()
Removes the Content-Size AVP from the Additional-Content-Information AVP.void
removeExtensionAvps()
Removes all extension AVPs from the Additional-Content-Information AVP.void
removeTypeNumber()
Removes the Type-Number AVP from the Additional-Content-Information AVP.void
setAdditionalTypeInformation(String additionalTypeInformation)
Sets the value of the Additional-Type-Information AVP, of type UTF8String.void
setContentSize(long contentSize)
Sets the value of the Content-Size AVP, of type Unsigned32.void
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.void
setTypeNumber(TypeNumber typeNumber)
Sets the value of the Type-Number AVP, of type Enumerated.-
Methods inherited from interface org.jainslee.resources.diameter.base.DiameterAvp
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
-
-
-
-
Method Detail
-
hasTypeNumber
boolean hasTypeNumber()
Returns true if the Type-Number AVP is present in the Additional-Content-Information AVP.
-
getTypeNumber
TypeNumber getTypeNumber()
Returns the value of the Type-Number AVP, of type Enumerated.- Returns:
- the value of the Type-Number AVP, or null if it has not been set.
-
setTypeNumber
void setTypeNumber(TypeNumber typeNumber)
Sets the value of the Type-Number AVP, of type Enumerated.- Throws:
NullPointerException
- iftypeNumber
isnull
.
-
removeTypeNumber
void removeTypeNumber()
Removes the Type-Number AVP from the Additional-Content-Information AVP. If the Type-Number AVP is not present, this method returns silently.
-
hasAdditionalTypeInformation
boolean hasAdditionalTypeInformation()
Returns true if the Additional-Type-Information AVP is present in the Additional-Content-Information AVP.
-
getAdditionalTypeInformation
String getAdditionalTypeInformation()
Returns the value of the Additional-Type-Information AVP, of type UTF8String.- Returns:
- the value of the Additional-Type-Information AVP, or null if it has not been set.
-
setAdditionalTypeInformation
void setAdditionalTypeInformation(String additionalTypeInformation)
Sets the value of the Additional-Type-Information AVP, of type UTF8String.- Throws:
NullPointerException
- ifadditionalTypeInformation
isnull
.
-
removeAdditionalTypeInformation
void removeAdditionalTypeInformation()
Removes the Additional-Type-Information AVP from the Additional-Content-Information AVP. If the Additional-Type-Information AVP is not present, this method returns silently.
-
hasContentSize
boolean hasContentSize()
Returns true if the Content-Size AVP is present in the Additional-Content-Information AVP.
-
getContentSize
long getContentSize()
Returns the value of the Content-Size AVP, of type Unsigned32. UsehasContentSize()
to check the existence of this AVP.- Returns:
- the value of the Content-Size AVP
- Throws:
IllegalStateException
- if the Content-Size AVP has not been set.
-
setContentSize
void setContentSize(long contentSize)
Sets the value of the Content-Size AVP, of type Unsigned32.
-
removeContentSize
void removeContentSize()
Removes the Content-Size AVP from the Additional-Content-Information AVP. If the Content-Size AVP is not present, this method returns silently.
-
getExtensionAvps
DiameterAvp[] getExtensionAvps()
Returns the set of extension AVPs. The returned array contains the extension AVPs in the order they appear in the Additional-Content-Information AVP. A return value of null implies that no extensions AVPs have been set.
-
setExtensionAvps
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
Sets the set of extension AVPs with all the values in the given array. The AVPs will be added to Additional-Content-Information AVP in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getExtensionAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.- Throws:
AvpNotAllowedException
- if an AVP is encountered of a type already known to this class (i.e. an AVP for which get/set methods already appear in this class)NullPointerException
- ifavps
isnull
.
-
removeExtensionAvps
void removeExtensionAvps()
Removes all extension AVPs from the Additional-Content-Information AVP. If no extension AVPs are present, this method returns silently.
-
-