Package org.jainslee.resources.diameter.sh.types.v940

Interface UserIdentity

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface UserIdentity
extends GroupedAvp
    Defines an interface representing the User-Identity grouped AVP type. From the Diameter Sh Reference Point Protocol Details (3GPP TS 29.329 V9.4.0) specification: 
     6.3.1        User-Identity AVP
 
 The User-Identity AVP is of type Grouped. This AVP contains either a Public-Identity AVP
 or an MSISDN AVP.
 
 AVP format
 User-Identity ::=   <AVP Header: 700 10415>
                     [Public-Identity]
                     [MSISDN]
                     *[AVP]

    • Method Detail

      • hasPublicIdentity

        boolean hasPublicIdentity()
        Returns true if the Public-Identity AVP is present in the User-Identity AVP.

      • getPublicIdentity

        String getPublicIdentity()
        Returns the value of the Public-Identity AVP, of type UTF8String.
        Returns:
        the value of the Public-Identity AVP, or null if it has not been set.

      • setPublicIdentity

        void setPublicIdentity​(String publicIdentity)
        Sets the value of the Public-Identity AVP, of type UTF8String.
        Throws:
        NullPointerException - if publicIdentity is null.

      • removePublicIdentity

        void removePublicIdentity()
        Removes the Public-Identity AVP from the User-Identity AVP. If the Public-Identity AVP is not present, this method returns silently.

      • hasMsisdn

        boolean hasMsisdn()
        Returns true if the MSISDN AVP is present in the User-Identity AVP.

      • getMsisdn

        byte[] getMsisdn()
        Returns the value of the MSISDN AVP, of type OctetString.
        Returns:
        the value of the MSISDN AVP, or null if it has not been set.

      • setMsisdn

        void setMsisdn​(byte[] msisdn)
        Sets the value of the MSISDN AVP, of type OctetString.
        Throws:
        NullPointerException - if msisdn is null.

      • removeMsisdn

        void removeMsisdn()
        Removes the MSISDN AVP from the User-Identity AVP. If the MSISDN 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 User-Identity 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 User-Identity 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 User-Identity AVP. If no extension AVPs are present, this method returns silently.