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

Interface LcsClientName

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface LcsClientName
extends GroupedAvp
    Defines an interface representing the LCS-Client-Name grouped AVP type. From the Diameter Rf Reference Point Protocol Details (3GPP TS 32.299 V12.11.0) specification: 
     7.2.85      LCS-Client-Name AVP
 
 The LCS-Client-Name AVP (AVP code 1235) is of type Grouped and contains the information related to the name of the LCS Client.
 It has the following ABNF grammar:
 
       LCS-Client-Name ::=   < AVP Header: 1235>
                             [ LCS-Data-Coding-Scheme ]
                             [ LCS-Name-String ]
                             [ LCS-Format-Indicator ]
    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

      • hasLcsDataCodingScheme

        boolean hasLcsDataCodingScheme()
        Returns true if the LCS-Data-Coding-Scheme AVP is present in the LCS-Client-Name AVP.

      • getLcsDataCodingScheme

        String getLcsDataCodingScheme()
        Returns the value of the LCS-Data-Coding-Scheme AVP, of type UTF8String.
        Returns:
        the value of the LCS-Data-Coding-Scheme AVP, or null if it has not been set.

      • setLcsDataCodingScheme

        void setLcsDataCodingScheme​(String lcsDataCodingScheme)
        Sets the value of the LCS-Data-Coding-Scheme AVP, of type UTF8String.
        Throws:
        NullPointerException - if lcsDataCodingScheme is null.

      • removeLcsDataCodingScheme

        void removeLcsDataCodingScheme()
        Removes the LCS-Data-Coding-Scheme AVP from the LCS-Client-Name AVP. If the LCS-Data-Coding-Scheme AVP is not present, this method returns silently.

      • hasLcsNameString

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

      • getLcsNameString

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

      • setLcsNameString

        void setLcsNameString​(String lcsNameString)
        Sets the value of the LCS-Name-String AVP, of type UTF8String.
        Throws:
        NullPointerException - if lcsNameString is null.

      • removeLcsNameString

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

      • hasLcsFormatIndicator

        boolean hasLcsFormatIndicator()
        Returns true if the LCS-Format-Indicator AVP is present in the LCS-Client-Name AVP.

      • getLcsFormatIndicator

        LcsFormatIndicator getLcsFormatIndicator()
        Returns the value of the LCS-Format-Indicator AVP, of type Enumerated.
        Returns:
        the value of the LCS-Format-Indicator AVP, or null if it has not been set.

      • setLcsFormatIndicator

        void setLcsFormatIndicator​(LcsFormatIndicator lcsFormatIndicator)
        Sets the value of the LCS-Format-Indicator AVP, of type Enumerated.
        Throws:
        NullPointerException - if lcsFormatIndicator is null.

      • removeLcsFormatIndicator

        void removeLcsFormatIndicator()
        Removes the LCS-Format-Indicator AVP from the LCS-Client-Name AVP. If the LCS-Format-Indicator 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-Name 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-Name 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-Name AVP. If no extension AVPs are present, this method returns silently.