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

Interface FixedUserLocationInfo

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface FixedUserLocationInfo
extends GroupedAvp
    Defines an interface representing the Fixed-User-Location-Info grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V11.9.0) specification: 
     5.3.112 Fixed-User-Location-Info AVP (FBA access type)
 
     The Fixed-User-Location-Info AVP (AVP code 2825) is of type Grouped and contains the UE location in a Fixed Access Network.
     AVP Format:
 
     Fixed-User-Location-Info ::=  < AVP Header: 2825 >
                              [ SSID ]
                              [ BSSID ]
                              [ Logical-Access-ID ]
                              [ Physical-Access-ID ]
                             *[ AVP ]

    • Method Detail

      • hasSsid

        boolean hasSsid()
        Returns true if the SSID AVP is present in the Fixed-User-Location-Info AVP.

      • getSsid

        String getSsid()
        Returns the value of the SSID AVP, of type UTF8String.
        Returns:
        the value of the SSID AVP, or null if it has not been set.

      • setSsid

        void setSsid​(String ssid)
        Sets the value of the SSID AVP, of type UTF8String.
        Throws:
        NullPointerException - if ssid is null.

      • removeSsid

        void removeSsid()
        Removes the SSID AVP from the Fixed-User-Location-Info AVP. If the SSID AVP is not present, this method returns silently.

      • hasBssid

        boolean hasBssid()
        Returns true if the BSSID AVP is present in the Fixed-User-Location-Info AVP.

      • getBssid

        String getBssid()
        Returns the value of the BSSID AVP, of type UTF8String.
        Returns:
        the value of the BSSID AVP, or null if it has not been set.

      • setBssid

        void setBssid​(String bssid)
        Sets the value of the BSSID AVP, of type UTF8String.
        Throws:
        NullPointerException - if bssid is null.

      • removeBssid

        void removeBssid()
        Removes the BSSID AVP from the Fixed-User-Location-Info AVP. If the BSSID AVP is not present, this method returns silently.

      • hasLogicalAccessId

        boolean hasLogicalAccessId()
        Returns true if the Logical-Access-ID AVP is present in the Fixed-User-Location-Info AVP.

      • getLogicalAccessId

        byte[] getLogicalAccessId()
        Returns the value of the Logical-Access-ID AVP, of type OctetString.
        Returns:
        the value of the Logical-Access-ID AVP, or null if it has not been set.

      • setLogicalAccessId

        void setLogicalAccessId​(byte[] logicalAccessId)
        Sets the value of the Logical-Access-ID AVP, of type OctetString.
        Throws:
        NullPointerException - if logicalAccessId is null.

      • removeLogicalAccessId

        void removeLogicalAccessId()
        Removes the Logical-Access-ID AVP from the Fixed-User-Location-Info AVP. If the Logical-Access-ID AVP is not present, this method returns silently.

      • hasPhysicalAccessId

        boolean hasPhysicalAccessId()
        Returns true if the Physical-Access-ID AVP is present in the Fixed-User-Location-Info AVP.

      • getPhysicalAccessId

        String getPhysicalAccessId()
        Returns the value of the Physical-Access-ID AVP, of type UTF8String.
        Returns:
        the value of the Physical-Access-ID AVP, or null if it has not been set.

      • setPhysicalAccessId

        void setPhysicalAccessId​(String physicalAccessId)
        Sets the value of the Physical-Access-ID AVP, of type UTF8String.
        Throws:
        NullPointerException - if physicalAccessId is null.

      • removePhysicalAccessId

        void removePhysicalAccessId()
        Removes the Physical-Access-ID AVP from the Fixed-User-Location-Info AVP. If the Physical-Access-ID 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 Fixed-User-Location-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 Fixed-User-Location-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 - if avps is null.

      • removeExtensionAvps

        void removeExtensionAvps()
        Removes all extension AVPs from the Fixed-User-Location-Info AVP. If no extension AVPs are present, this method returns silently.