Package org.jainslee.resources.diameter.gx.types.va10

Interface CoaInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface CoaInformation
extends GroupedAvp
    Defines an interface representing the CoA-Information grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V10.1.0) specification: 
     5.3.37 CoA-Information
 
     The CoA-Information AVP (AVP code 1039) is of type Grouped, and it contains care-of-address and the tunnel
     information related to the care of address. The CoA-Information AVP is sent from the PCEF to the PCRF.
 
     When used, the CoA-Information AVP shall include a CoA-IP-Address AVP. The CoA-Information AVP shall also
     include a Tunnel-Information AVP, which provides the tunnel header length and tunnel header filter information related
     to the specific care-of-address.
 
     AVP Format:
 
     CoA-Information ::= < AVP Header: 1039>
                         { Tunnel-Information }
                         { CoA-IP-Address }
                        *[ AVP ]

    • Method Detail

      • hasTunnelInformation

        boolean hasTunnelInformation()
        Returns true if the Tunnel-Information AVP is present in the CoA-Information AVP.

      • getTunnelInformation

        TunnelInformation getTunnelInformation()
        Returns the value of the Tunnel-Information AVP, of type Grouped.
        Returns:
        the value of the Tunnel-Information AVP, or null if it has not been set.

      • setTunnelInformation

        void setTunnelInformation​(TunnelInformation tunnelInformation)
        Sets the value of the Tunnel-Information AVP, of type Grouped.
        Throws:
        NullPointerException - if tunnelInformation is null.

      • removeTunnelInformation

        void removeTunnelInformation()
        Removes the Tunnel-Information AVP from the CoA-Information AVP. If the Tunnel-Information AVP is not present, this method returns silently.

      • hasCoaIpAddress

        boolean hasCoaIpAddress()
        Returns true if the CoA-IP-Address AVP is present in the CoA-Information AVP.

      • getCoaIpAddress

        Address getCoaIpAddress()
        Returns the value of the CoA-IP-Address AVP, of type Address.
        Returns:
        the value of the CoA-IP-Address AVP, or null if it has not been set.

      • setCoaIpAddress

        void setCoaIpAddress​(Address coaIpAddress)
        Sets the value of the CoA-IP-Address AVP, of type Address.
        Throws:
        NullPointerException - if coaIpAddress is null.

      • removeCoaIpAddress

        void removeCoaIpAddress()
        Removes the CoA-IP-Address AVP from the CoA-Information AVP. If the CoA-IP-Address 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 CoA-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 CoA-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 - if avps is null.

      • removeExtensionAvps

        void removeExtensionAvps()
        Removes all extension AVPs from the CoA-Information AVP. If no extension AVPs are present, this method returns silently.