Interface OriginatorInterface
-
- All Superinterfaces:
Cloneable
,DiameterAvp
,GroupedAvp
public interface OriginatorInterface extends GroupedAvp
Defines an interface representing the Originator-Interface grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V8.13.0) specification:7.2.97 Originator-Interface AVP The Originator-Interface AVP (AVP code 2009) is the group AVP which contains information related to the Interface on which the message originated. Originator-Interface ::= < AVP Header: 2009 > [ Interface-Id ] [ Interface-Text ] [ Interface-Port ] [ Interface-Type ]
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
getInterfaceId()
Returns the value of the Interface-Id AVP, of type UTF8String.String
getInterfacePort()
Returns the value of the Interface-Port AVP, of type UTF8String.String
getInterfaceText()
Returns the value of the Interface-Text AVP, of type UTF8String.InterfaceType
getInterfaceType()
Returns the value of the Interface-Type AVP, of type Enumerated.boolean
hasInterfaceId()
Returns true if the Interface-Id AVP is present in the Originator-Interface AVP.boolean
hasInterfacePort()
Returns true if the Interface-Port AVP is present in the Originator-Interface AVP.boolean
hasInterfaceText()
Returns true if the Interface-Text AVP is present in the Originator-Interface AVP.boolean
hasInterfaceType()
Returns true if the Interface-Type AVP is present in the Originator-Interface AVP.void
removeExtensionAvps()
Removes all extension AVPs from the Originator-Interface AVP.void
removeInterfaceId()
Removes the Interface-Id AVP from the Originator-Interface AVP.void
removeInterfacePort()
Removes the Interface-Port AVP from the Originator-Interface AVP.void
removeInterfaceText()
Removes the Interface-Text AVP from the Originator-Interface AVP.void
removeInterfaceType()
Removes the Interface-Type AVP from the Originator-Interface AVP.void
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.void
setInterfaceId(String interfaceId)
Sets the value of the Interface-Id AVP, of type UTF8String.void
setInterfacePort(String interfacePort)
Sets the value of the Interface-Port AVP, of type UTF8String.void
setInterfaceText(String interfaceText)
Sets the value of the Interface-Text AVP, of type UTF8String.void
setInterfaceType(InterfaceType interfaceType)
Sets the value of the Interface-Type 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
-
hasInterfaceId
boolean hasInterfaceId()
Returns true if the Interface-Id AVP is present in the Originator-Interface AVP.
-
getInterfaceId
String getInterfaceId()
Returns the value of the Interface-Id AVP, of type UTF8String.- Returns:
- the value of the Interface-Id AVP, or null if it has not been set.
-
setInterfaceId
void setInterfaceId(String interfaceId)
Sets the value of the Interface-Id AVP, of type UTF8String.- Throws:
NullPointerException
- ifinterfaceId
isnull
.
-
removeInterfaceId
void removeInterfaceId()
Removes the Interface-Id AVP from the Originator-Interface AVP. If the Interface-Id AVP is not present, this method returns silently.
-
hasInterfaceText
boolean hasInterfaceText()
Returns true if the Interface-Text AVP is present in the Originator-Interface AVP.
-
getInterfaceText
String getInterfaceText()
Returns the value of the Interface-Text AVP, of type UTF8String.- Returns:
- the value of the Interface-Text AVP, or null if it has not been set.
-
setInterfaceText
void setInterfaceText(String interfaceText)
Sets the value of the Interface-Text AVP, of type UTF8String.- Throws:
NullPointerException
- ifinterfaceText
isnull
.
-
removeInterfaceText
void removeInterfaceText()
Removes the Interface-Text AVP from the Originator-Interface AVP. If the Interface-Text AVP is not present, this method returns silently.
-
hasInterfacePort
boolean hasInterfacePort()
Returns true if the Interface-Port AVP is present in the Originator-Interface AVP.
-
getInterfacePort
String getInterfacePort()
Returns the value of the Interface-Port AVP, of type UTF8String.- Returns:
- the value of the Interface-Port AVP, or null if it has not been set.
-
setInterfacePort
void setInterfacePort(String interfacePort)
Sets the value of the Interface-Port AVP, of type UTF8String.- Throws:
NullPointerException
- ifinterfacePort
isnull
.
-
removeInterfacePort
void removeInterfacePort()
Removes the Interface-Port AVP from the Originator-Interface AVP. If the Interface-Port AVP is not present, this method returns silently.
-
hasInterfaceType
boolean hasInterfaceType()
Returns true if the Interface-Type AVP is present in the Originator-Interface AVP.
-
getInterfaceType
InterfaceType getInterfaceType()
Returns the value of the Interface-Type AVP, of type Enumerated.- Returns:
- the value of the Interface-Type AVP, or null if it has not been set.
-
setInterfaceType
void setInterfaceType(InterfaceType interfaceType)
Sets the value of the Interface-Type AVP, of type Enumerated.- Throws:
NullPointerException
- ifinterfaceType
isnull
.
-
removeInterfaceType
void removeInterfaceType()
Removes the Interface-Type AVP from the Originator-Interface AVP. If the Interface-Type 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 Originator-Interface 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 Originator-Interface 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 Originator-Interface AVP. If no extension AVPs are present, this method returns silently.
-
-