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

Interface LcsClientId

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface LcsClientId
extends GroupedAvp
    Defines an interface representing the LCS-Client-Id grouped AVP type. From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V11.8.0) specification: 
     7.2.84      LCS-Client-Id AVP
 
 The LCS-Client-Id AVP (AVP code 1232) is of type Grouped and holds
 information related to the identity of an LCS client.
 It has the following ABNF grammar:
 
       LCS-Client-Id ::= < AVP Header: 1232 >
                           [ LCS-Client-Type ]
                           [ LCS-Client-External-ID ]
                           [ LCS-Client-Dialed-By-MS ]
                           [ LCS-Client-Name ]
                           [ LCS-APN ]
                           [ LCS-Requestor-ID ]
    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

      • hasLcsClientType

        boolean hasLcsClientType()
        Returns true if the LCS-Client-Type AVP is present in the LCS-Client-Id AVP.

      • getLcsClientType

        LcsClientType getLcsClientType()
        Returns the value of the LCS-Client-Type AVP, of type Enumerated.
        Returns:
        the value of the LCS-Client-Type AVP, or null if it has not been set.

      • setLcsClientType

        void setLcsClientType​(LcsClientType lcsClientType)
        Sets the value of the LCS-Client-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if lcsClientType is null.

      • removeLcsClientType

        void removeLcsClientType()
        Removes the LCS-Client-Type AVP from the LCS-Client-Id AVP. If the LCS-Client-Type AVP is not present, this method returns silently.

      • hasLcsClientExternalId

        boolean hasLcsClientExternalId()
        Returns true if the LCS-Client-External-ID AVP is present in the LCS-Client-Id AVP.

      • getLcsClientExternalId

        String getLcsClientExternalId()
        Returns the value of the LCS-Client-External-ID AVP, of type UTF8String.
        Returns:
        the value of the LCS-Client-External-ID AVP, or null if it has not been set.

      • setLcsClientExternalId

        void setLcsClientExternalId​(String lcsClientExternalId)
        Sets the value of the LCS-Client-External-ID AVP, of type UTF8String.
        Throws:
        NullPointerException - if lcsClientExternalId is null.

      • removeLcsClientExternalId

        void removeLcsClientExternalId()
        Removes the LCS-Client-External-ID AVP from the LCS-Client-Id AVP. If the LCS-Client-External-ID AVP is not present, this method returns silently.

      • hasLcsClientDialedByMs

        boolean hasLcsClientDialedByMs()
        Returns true if the LCS-Client-Dialed-By-MS AVP is present in the LCS-Client-Id AVP.

      • getLcsClientDialedByMs

        String getLcsClientDialedByMs()
        Returns the value of the LCS-Client-Dialed-By-MS AVP, of type UTF8String.
        Returns:
        the value of the LCS-Client-Dialed-By-MS AVP, or null if it has not been set.

      • setLcsClientDialedByMs

        void setLcsClientDialedByMs​(String lcsClientDialedByMs)
        Sets the value of the LCS-Client-Dialed-By-MS AVP, of type UTF8String.
        Throws:
        NullPointerException - if lcsClientDialedByMs is null.

      • removeLcsClientDialedByMs

        void removeLcsClientDialedByMs()
        Removes the LCS-Client-Dialed-By-MS AVP from the LCS-Client-Id AVP. If the LCS-Client-Dialed-By-MS AVP is not present, this method returns silently.

      • hasLcsClientName

        boolean hasLcsClientName()
        Returns true if the LCS-Client-Name AVP is present in the LCS-Client-Id AVP.

      • getLcsClientName

        LcsClientName getLcsClientName()
        Returns the value of the LCS-Client-Name AVP, of type Grouped.
        Returns:
        the value of the LCS-Client-Name AVP, or null if it has not been set.

      • setLcsClientName

        void setLcsClientName​(LcsClientName lcsClientName)
        Sets the value of the LCS-Client-Name AVP, of type Grouped.
        Throws:
        NullPointerException - if lcsClientName is null.

      • removeLcsClientName

        void removeLcsClientName()
        Removes the LCS-Client-Name AVP from the LCS-Client-Id AVP. If the LCS-Client-Name AVP is not present, this method returns silently.

      • hasLcsApn

        boolean hasLcsApn()
        Returns true if the LCS-APN AVP is present in the LCS-Client-Id AVP.

      • getLcsApn

        String getLcsApn()
        Returns the value of the LCS-APN AVP, of type UTF8String.
        Returns:
        the value of the LCS-APN AVP, or null if it has not been set.

      • setLcsApn

        void setLcsApn​(String lcsApn)
        Sets the value of the LCS-APN AVP, of type UTF8String.
        Throws:
        NullPointerException - if lcsApn is null.

      • removeLcsApn

        void removeLcsApn()
        Removes the LCS-APN AVP from the LCS-Client-Id AVP. If the LCS-APN AVP is not present, this method returns silently.

      • hasLcsRequestorId

        boolean hasLcsRequestorId()
        Returns true if the LCS-Requestor-ID AVP is present in the LCS-Client-Id AVP.

      • getLcsRequestorId

        LcsRequestorId getLcsRequestorId()
        Returns the value of the LCS-Requestor-ID AVP, of type Grouped.
        Returns:
        the value of the LCS-Requestor-ID AVP, or null if it has not been set.

      • setLcsRequestorId

        void setLcsRequestorId​(LcsRequestorId lcsRequestorId)
        Sets the value of the LCS-Requestor-ID AVP, of type Grouped.
        Throws:
        NullPointerException - if lcsRequestorId is null.

      • removeLcsRequestorId

        void removeLcsRequestorId()
        Removes the LCS-Requestor-ID AVP from the LCS-Client-Id AVP. If the LCS-Requestor-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 LCS-Client-Id 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 LCS-Client-Id 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 LCS-Client-Id AVP. If no extension AVPs are present, this method returns silently.