Package org.jainslee.resources.diameter.rf.types.vb80

Interface WlanInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface WlanInformation
extends GroupedAvp
    Defines an interface representing the WLAN-Information grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V10.0.0) specification: 
     7.2.246     WLAN-Information AVP
 
 The WLAN-Information AVP (AVP code 875) is of type Grouped. Its purpose is
 to allow the transmission of additional WLAN service specific information
 elements.  The format and the contents of the fields inside the WLAN-
 Information AVP is specified in TS 32.252 [22].
 It has the following ABNF grammar:
 
     WLAN-Information ::=  < AVP Header: 875>
                           [ WLAN-Session-Id ]
                           [ PDG-Address ]
                           [ PDG-Charging-Id ]
                           [ WAG-Address ]
                           [ WAG-PLMN-Id ]
                           [ WLAN-Radio-Container ]
                           [ WLAN-UE-Local-IPAddress ]
    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.

    • Method Detail

      • hasWlanSessionId

        boolean hasWlanSessionId()
        Returns true if the WLAN-Session-Id AVP is present in the WLAN-Information AVP.

      • getWlanSessionId

        String getWlanSessionId()
        Returns the value of the WLAN-Session-Id AVP, of type UTF8String.
        Returns:
        the value of the WLAN-Session-Id AVP, or null if it has not been set.

      • setWlanSessionId

        void setWlanSessionId​(String wlanSessionId)
        Sets the value of the WLAN-Session-Id AVP, of type UTF8String.
        Throws:
        NullPointerException - if wlanSessionId is null.

      • removeWlanSessionId

        void removeWlanSessionId()
        Removes the WLAN-Session-Id AVP from the WLAN-Information AVP. If the WLAN-Session-Id AVP is not present, this method returns silently.

      • hasPdgAddress

        boolean hasPdgAddress()
        Returns true if the PDG-Address AVP is present in the WLAN-Information AVP.

      • getPdgAddress

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

      • setPdgAddress

        void setPdgAddress​(Address pdgAddress)
        Sets the value of the PDG-Address AVP, of type Address.
        Throws:
        NullPointerException - if pdgAddress is null.

      • removePdgAddress

        void removePdgAddress()
        Removes the PDG-Address AVP from the WLAN-Information AVP. If the PDG-Address AVP is not present, this method returns silently.

      • hasPdgChargingId

        boolean hasPdgChargingId()
        Returns true if the PDG-Charging-Id AVP is present in the WLAN-Information AVP.

      • getPdgChargingId

        long getPdgChargingId()
        Returns the value of the PDG-Charging-Id AVP, of type Unsigned32. Use hasPdgChargingId() to check the existence of this AVP.
        Returns:
        the value of the PDG-Charging-Id AVP
        Throws:
        IllegalStateException - if the PDG-Charging-Id AVP has not been set.

      • setPdgChargingId

        void setPdgChargingId​(long pdgChargingId)
        Sets the value of the PDG-Charging-Id AVP, of type Unsigned32.

      • removePdgChargingId

        void removePdgChargingId()
        Removes the PDG-Charging-Id AVP from the WLAN-Information AVP. If the PDG-Charging-Id AVP is not present, this method returns silently.

      • hasWagAddress

        boolean hasWagAddress()
        Returns true if the WAG-Address AVP is present in the WLAN-Information AVP.

      • getWagAddress

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

      • setWagAddress

        void setWagAddress​(Address wagAddress)
        Sets the value of the WAG-Address AVP, of type Address.
        Throws:
        NullPointerException - if wagAddress is null.

      • removeWagAddress

        void removeWagAddress()
        Removes the WAG-Address AVP from the WLAN-Information AVP. If the WAG-Address AVP is not present, this method returns silently.

      • hasWagPlmnId

        boolean hasWagPlmnId()
        Returns true if the WAG-PLMN-Id AVP is present in the WLAN-Information AVP.

      • getWagPlmnId

        byte[] getWagPlmnId()
        Returns the value of the WAG-PLMN-Id AVP, of type OctetString.
        Returns:
        the value of the WAG-PLMN-Id AVP, or null if it has not been set.

      • setWagPlmnId

        void setWagPlmnId​(byte[] wagPlmnId)
        Sets the value of the WAG-PLMN-Id AVP, of type OctetString.
        Throws:
        NullPointerException - if wagPlmnId is null.

      • removeWagPlmnId

        void removeWagPlmnId()
        Removes the WAG-PLMN-Id AVP from the WLAN-Information AVP. If the WAG-PLMN-Id AVP is not present, this method returns silently.

      • hasWlanRadioContainer

        boolean hasWlanRadioContainer()
        Returns true if the WLAN-Radio-Container AVP is present in the WLAN-Information AVP.

      • getWlanRadioContainer

        WlanRadioContainer getWlanRadioContainer()
        Returns the value of the WLAN-Radio-Container AVP, of type Grouped.
        Returns:
        the value of the WLAN-Radio-Container AVP, or null if it has not been set.

      • setWlanRadioContainer

        void setWlanRadioContainer​(WlanRadioContainer wlanRadioContainer)
        Sets the value of the WLAN-Radio-Container AVP, of type Grouped.
        Throws:
        NullPointerException - if wlanRadioContainer is null.

      • removeWlanRadioContainer

        void removeWlanRadioContainer()
        Removes the WLAN-Radio-Container AVP from the WLAN-Information AVP. If the WLAN-Radio-Container AVP is not present, this method returns silently.

      • hasWlanUeLocalIpaddress

        boolean hasWlanUeLocalIpaddress()
        Returns true if the WLAN-UE-Local-IPAddress AVP is present in the WLAN-Information AVP.

      • getWlanUeLocalIpaddress

        Address getWlanUeLocalIpaddress()
        Returns the value of the WLAN-UE-Local-IPAddress AVP, of type Address.
        Returns:
        the value of the WLAN-UE-Local-IPAddress AVP, or null if it has not been set.

      • setWlanUeLocalIpaddress

        void setWlanUeLocalIpaddress​(Address wlanUeLocalIpaddress)
        Sets the value of the WLAN-UE-Local-IPAddress AVP, of type Address.
        Throws:
        NullPointerException - if wlanUeLocalIpaddress is null.

      • removeWlanUeLocalIpaddress

        void removeWlanUeLocalIpaddress()
        Removes the WLAN-UE-Local-IPAddress AVP from the WLAN-Information AVP. If the WLAN-UE-Local-IPAddress 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 WLAN-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 WLAN-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 WLAN-Information AVP. If no extension AVPs are present, this method returns silently.