net.java.slee.resource.diameter.base.events.avp
Interface ProxyInfoAvp

All Superinterfaces:
java.lang.Cloneable, DiameterAvp, GroupedAvp
All Known Implementing Classes:
ProxyInfoAvpImpl

public interface ProxyInfoAvp
extends GroupedAvp

Defines an interface representing the Proxy-Info grouped AVP type. From the Diameter Base Protocol (rfc3588.txt) specification:

 6.7.2.  Proxy-Info AVP
 
    The Proxy-Info AVP (AVP Code 284) is of type Grouped.  The Grouped
    Data field has the following ABNF grammar:
 
       Proxy-Info ::= < AVP Header: 284 >
                      { Proxy-Host }
                      { Proxy-State }
                    * [ AVP ]
 


Field Summary
 
Fields inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
 
Method Summary
 DiameterIdentityAvp 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 message.
 boolean hasProxyState()
          Returns true if the Proxy-State AVP is present in the message.
 void setProxyHost(DiameterIdentityAvp 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 net.java.slee.resource.diameter.base.events.avp.GroupedAvp
getExtensionAvps, hasExtensionAvps, setExtensionAvps
 
Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorId, intValue, longValue, stringValue
 

Method Detail

hasProxyHost

boolean hasProxyHost()
Returns true if the Proxy-Host AVP is present in the message.


getProxyHost

DiameterIdentityAvp getProxyHost()
Returns the value of the Proxy-Host AVP, of type DiameterIdentity. A return value of null implies that the AVP has not been set.


setProxyHost

void setProxyHost(DiameterIdentityAvp proxyHost)
Sets the value of the Proxy-Host AVP, of type DiameterIdentity.

Throws:
java.lang.IllegalStateException - if setProxyHost has already been called

hasProxyState

boolean hasProxyState()
Returns true if the Proxy-State AVP is present in the message.


getProxyState

byte[] getProxyState()
Returns the value of the Proxy-State AVP, of type OctetString. A return value of null implies that the AVP has not been set.


setProxyState

void setProxyState(byte[] proxyState)
Sets the value of the Proxy-State AVP, of type OctetString.

Throws:
java.lang.IllegalStateException - if setProxyState has already been called


Copyright © 2008. All Rights Reserved.