Package org.jainslee.resources.diameter.cca.types

Interface UserEquipmentInfo

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface UserEquipmentInfo
extends GroupedAvp
    Defines an interface representing the User-Equipment-Info grouped AVP type. From the Diameter Credit-Control Application (rfc4006.txt) specification: 
     8.49.  User-Equipment-Info AVP
 
    The User-Equipment-Info AVP (AVP Code 458) is of type Grouped and
    allows the credit-control client to indicate the identity and
    capability of the terminal the subscriber is using for the connection
    to network.
 
    It is defined as follows (per the grouped-avp-def of RFC 3588
    [DIAMBASE]):
 
       User-Equipment-Info ::= < AVP Header: 458 >
                               { User-Equipment-Info-Type }
                               { User-Equipment-Info-Value }
    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

      • hasUserEquipmentInfoType

        boolean hasUserEquipmentInfoType()
        Returns true if the User-Equipment-Info-Type AVP is present in the User-Equipment-Info AVP.

      • getUserEquipmentInfoType

        UserEquipmentInfoType getUserEquipmentInfoType()
        Returns the value of the User-Equipment-Info-Type AVP, of type Enumerated.
        Returns:
        the value of the User-Equipment-Info-Type AVP, or null if it has not been set.

      • setUserEquipmentInfoType

        void setUserEquipmentInfoType​(UserEquipmentInfoType userEquipmentInfoType)
        Sets the value of the User-Equipment-Info-Type AVP, of type Enumerated.
        Throws:
        NullPointerException - if userEquipmentInfoType is null.

      • removeUserEquipmentInfoType

        void removeUserEquipmentInfoType()
        Removes the User-Equipment-Info-Type AVP from the User-Equipment-Info AVP. If the User-Equipment-Info-Type AVP is not present, this method returns silently.

      • hasUserEquipmentInfoValue

        boolean hasUserEquipmentInfoValue()
        Returns true if the User-Equipment-Info-Value AVP is present in the User-Equipment-Info AVP.

      • getUserEquipmentInfoValue

        byte[] getUserEquipmentInfoValue()
        Returns the value of the User-Equipment-Info-Value AVP, of type OctetString.
        Returns:
        the value of the User-Equipment-Info-Value AVP, or null if it has not been set.

      • setUserEquipmentInfoValue

        void setUserEquipmentInfoValue​(byte[] userEquipmentInfoValue)
        Sets the value of the User-Equipment-Info-Value AVP, of type OctetString.
        Throws:
        NullPointerException - if userEquipmentInfoValue is null.

      • removeUserEquipmentInfoValue

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