Interface ProxyInfo
-
- All Superinterfaces:
Cloneable
,DiameterAvp
,GroupedAvp
public interface ProxyInfo extends GroupedAvp
Defines an interface representing the Proxy-Info grouped AVP type. From the Diameter Base Protocol (rfc6733.txt) specification:6.7.2. Proxy-Info AVP The Proxy-Info AVP (AVP Code 284) is of type Grouped. This AVP contains the identity and local state information of the Diameter node that creates and adds it to a message. The Grouped Data field has the following CCF grammar: Proxy-Info ::= < AVP Header: 284 > { Proxy-Host } { Proxy-State } * [ AVP ]
-
-
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.DiameterIdentity
getProxyHost()
Returns the value of the Proxy-Host AVP, of type DiameterIdentity.byte[]
getProxyState()
Returns the value of the Proxy-State AVP, of type OctetString.boolean
hasProxyHost()
Returns true if the Proxy-Host AVP is present in the Proxy-Info AVP.boolean
hasProxyState()
Returns true if the Proxy-State AVP is present in the Proxy-Info AVP.void
removeExtensionAvps()
Removes all extension AVPs from the Proxy-Info AVP.void
removeProxyHost()
Removes the Proxy-Host AVP from the Proxy-Info AVP.void
removeProxyState()
Removes the Proxy-State AVP from the Proxy-Info AVP.void
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.void
setProxyHost(DiameterIdentity proxyHost)
Sets the value of the Proxy-Host AVP, of type DiameterIdentity.void
setProxyState(byte[] proxyState)
Sets the value of the Proxy-State AVP, of type OctetString.-
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
-
hasProxyHost
boolean hasProxyHost()
Returns true if the Proxy-Host AVP is present in the Proxy-Info AVP.
-
getProxyHost
DiameterIdentity getProxyHost()
Returns the value of the Proxy-Host AVP, of type DiameterIdentity.- Returns:
- the value of the Proxy-Host AVP, or null if it has not been set.
-
setProxyHost
void setProxyHost(DiameterIdentity proxyHost)
Sets the value of the Proxy-Host AVP, of type DiameterIdentity.- Throws:
NullPointerException
- ifproxyHost
isnull
.
-
removeProxyHost
void removeProxyHost()
Removes the Proxy-Host AVP from the Proxy-Info AVP. If the Proxy-Host AVP is not present, this method returns silently.
-
hasProxyState
boolean hasProxyState()
Returns true if the Proxy-State AVP is present in the Proxy-Info AVP.
-
getProxyState
byte[] getProxyState()
Returns the value of the Proxy-State AVP, of type OctetString.- Returns:
- the value of the Proxy-State AVP, or null if it has not been set.
-
setProxyState
void setProxyState(byte[] proxyState)
Sets the value of the Proxy-State AVP, of type OctetString.- Throws:
NullPointerException
- ifproxyState
isnull
.
-
removeProxyState
void removeProxyState()
Removes the Proxy-State AVP from the Proxy-Info AVP. If the Proxy-State 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 Proxy-Info 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 Proxy-Info 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 Proxy-Info AVP. If no extension AVPs are present, this method returns silently.
-
-