Interface InterOperatorIdentifier
-
- All Superinterfaces:
Cloneable
,DiameterAvp
,GroupedAvp
public interface InterOperatorIdentifier extends GroupedAvp
Defines an interface representing the Inter-Operator-Identifier grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification:7.2.80 Inter-Operator-Identifier AVP The Inter-Operator-Identifier AVP (AVP code 838) is of type Grouped and holds the identification of the network neighbours (originating and terminating) as exchanged via SIP signalling and described in RFC 7315 [404]. It has the following ABNF grammar: Inter-Operator-Identifier ::= < AVP Header: 838 > [ Originating-IOI ] [ Terminating-IOI ]
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 DiameterAvp[]
getExtensionAvps()
Returns the set of extension AVPs.String
getOriginatingIoi()
Returns the value of the Originating-IOI AVP, of type UTF8String.String
getTerminatingIoi()
Returns the value of the Terminating-IOI AVP, of type UTF8String.boolean
hasOriginatingIoi()
Returns true if the Originating-IOI AVP is present in the Inter-Operator-Identifier AVP.boolean
hasTerminatingIoi()
Returns true if the Terminating-IOI AVP is present in the Inter-Operator-Identifier AVP.void
removeExtensionAvps()
Removes all extension AVPs from the Inter-Operator-Identifier AVP.void
removeOriginatingIoi()
Removes the Originating-IOI AVP from the Inter-Operator-Identifier AVP.void
removeTerminatingIoi()
Removes the Terminating-IOI AVP from the Inter-Operator-Identifier AVP.void
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.void
setOriginatingIoi(String originatingIoi)
Sets the value of the Originating-IOI AVP, of type UTF8String.void
setTerminatingIoi(String terminatingIoi)
Sets the value of the Terminating-IOI AVP, of type UTF8String.-
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
-
hasOriginatingIoi
boolean hasOriginatingIoi()
Returns true if the Originating-IOI AVP is present in the Inter-Operator-Identifier AVP.
-
getOriginatingIoi
String getOriginatingIoi()
Returns the value of the Originating-IOI AVP, of type UTF8String.- Returns:
- the value of the Originating-IOI AVP, or null if it has not been set.
-
setOriginatingIoi
void setOriginatingIoi(String originatingIoi)
Sets the value of the Originating-IOI AVP, of type UTF8String.- Throws:
NullPointerException
- iforiginatingIoi
isnull
.
-
removeOriginatingIoi
void removeOriginatingIoi()
Removes the Originating-IOI AVP from the Inter-Operator-Identifier AVP. If the Originating-IOI AVP is not present, this method returns silently.
-
hasTerminatingIoi
boolean hasTerminatingIoi()
Returns true if the Terminating-IOI AVP is present in the Inter-Operator-Identifier AVP.
-
getTerminatingIoi
String getTerminatingIoi()
Returns the value of the Terminating-IOI AVP, of type UTF8String.- Returns:
- the value of the Terminating-IOI AVP, or null if it has not been set.
-
setTerminatingIoi
void setTerminatingIoi(String terminatingIoi)
Sets the value of the Terminating-IOI AVP, of type UTF8String.- Throws:
NullPointerException
- ifterminatingIoi
isnull
.
-
removeTerminatingIoi
void removeTerminatingIoi()
Removes the Terminating-IOI AVP from the Inter-Operator-Identifier AVP. If the Terminating-IOI 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 Inter-Operator-Identifier 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 Inter-Operator-Identifier 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 Inter-Operator-Identifier AVP. If no extension AVPs are present, this method returns silently.
-
-