Package org.jainslee.resources.diameter.ro.types.v960

Interface WlanRadioContainer

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface WlanRadioContainer
extends GroupedAvp
    Defines an interface representing the WLAN-Radio-Container grouped AVP type. From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V9.6.0) specification: 
     7.2.247     WLAN-Radio-Container AVP
 
 The WLAN-Radio-Container AVP (AVP code 892) is of type Grouped. The WLAN-
 Radio-Container AVP has the following format:
 
 The Operator-Name, Location-Type and Location-Information AVPs are defined
 in TS 29.234 [212].
 
        WLAN-Radio-Container ::=  < AVP Header: 892>
                                  [ Operator-Name ] #exclude
                                  [ Location-Type ]
                                  [ Location-Information ] #exclude
                                  [ WLAN-Technology ]
    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

      • hasLocationType

        boolean hasLocationType()
        Returns true if the Location-Type AVP is present in the WLAN-Radio-Container AVP.

      • getLocationType

        LocationType getLocationType()
        Returns the value of the Location-Type AVP, of type Grouped.
        Returns:
        the value of the Location-Type AVP, or null if it has not been set.

      • setLocationType

        void setLocationType​(LocationType locationType)
        Sets the value of the Location-Type AVP, of type Grouped.
        Throws:
        NullPointerException - if locationType is null.

      • removeLocationType

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

      • hasWlanTechnology

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

      • getWlanTechnology

        long getWlanTechnology()
        Returns the value of the WLAN-Technology AVP, of type Unsigned32. Use hasWlanTechnology() to check the existence of this AVP.
        Returns:
        the value of the WLAN-Technology AVP
        Throws:
        IllegalStateException - if the WLAN-Technology AVP has not been set.

      • setWlanTechnology

        void setWlanTechnology​(long wlanTechnology)
        Sets the value of the WLAN-Technology AVP, of type Unsigned32.

      • removeWlanTechnology

        void removeWlanTechnology()
        Removes the WLAN-Technology AVP from the WLAN-Radio-Container AVP. If the WLAN-Technology 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-Radio-Container 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-Radio-Container 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-Radio-Container AVP. If no extension AVPs are present, this method returns silently.