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

Interface SupportedApplications

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface SupportedApplications
extends GroupedAvp
    Defines an interface representing the Supported-Applications grouped AVP type. From the Diameter Sh Reference Point Protocol Details (3GPP TS 29.329 V8.8.0) specification: 
     6.3.32        Supported-Applications AVP
 
 The Supported-Applications AVP is of type Grouped and it contains the supported
 application identifiers of a Diameter node.
 
 AVP format
 Supported-Applications ::=    < AVP Header: 631 10415 >
                               *{ Auth-Application-Id }
                               *{ Acct-Application-Id }
                               *{ Vendor-Specific-Application-Id }
                               *[ AVP ]

    • Method Detail

      • getAuthApplicationIds

        long[] getAuthApplicationIds()
        Returns the set of Auth-Application-Id AVPs. The returned array contains the AVPs in the order they appear in the Supported-Applications AVP. A return value of null implies that no Auth-Application-Id AVPs have been set. The elements in the given array are long objects.

      • setAuthApplicationId

        void setAuthApplicationId​(long authApplicationId)
        Sets a single Auth-Application-Id AVP in the Supported-Applications AVP, of type Unsigned32.

      • setAuthApplicationIds

        void setAuthApplicationIds​(long[] authApplicationIds)
        Sets the set of Auth-Application-Id AVPs, with all the values in the given array. The AVPs will be added to the Supported-Applications 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 getAuthApplicationIds() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if authApplicationIds is null.

      • removeAuthApplicationIds

        void removeAuthApplicationIds()
        Removes all Auth-Application-Id AVPs from the Supported-Applications AVP. If no Auth-Application-Id AVPs are present, this method returns silently.

      • getAcctApplicationIds

        long[] getAcctApplicationIds()
        Returns the set of Acct-Application-Id AVPs. The returned array contains the AVPs in the order they appear in the Supported-Applications AVP. A return value of null implies that no Acct-Application-Id AVPs have been set. The elements in the given array are long objects.

      • setAcctApplicationId

        void setAcctApplicationId​(long acctApplicationId)
        Sets a single Acct-Application-Id AVP in the Supported-Applications AVP, of type Unsigned32.

      • setAcctApplicationIds

        void setAcctApplicationIds​(long[] acctApplicationIds)
        Sets the set of Acct-Application-Id AVPs, with all the values in the given array. The AVPs will be added to the Supported-Applications 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 getAcctApplicationIds() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if acctApplicationIds is null.

      • removeAcctApplicationIds

        void removeAcctApplicationIds()
        Removes all Acct-Application-Id AVPs from the Supported-Applications AVP. If no Acct-Application-Id AVPs are present, this method returns silently.

      • getVendorSpecificApplicationIds

        VendorSpecificApplicationId[] getVendorSpecificApplicationIds()
        Returns the set of Vendor-Specific-Application-Id AVPs. The returned array contains the AVPs in the order they appear in the Supported-Applications AVP. A return value of null implies that no Vendor-Specific-Application-Id AVPs have been set. The elements in the given array are VendorSpecificApplicationId objects.

      • setVendorSpecificApplicationId

        void setVendorSpecificApplicationId​(VendorSpecificApplicationId vendorSpecificApplicationId)
        Sets a single Vendor-Specific-Application-Id AVP in the Supported-Applications AVP, of type Grouped.
        Throws:
        NullPointerException - if vendorSpecificApplicationId is null.

      • setVendorSpecificApplicationIds

        void setVendorSpecificApplicationIds​(VendorSpecificApplicationId[] vendorSpecificApplicationIds)
        Sets the set of Vendor-Specific-Application-Id AVPs, with all the values in the given array. The AVPs will be added to the Supported-Applications 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 getVendorSpecificApplicationIds() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if vendorSpecificApplicationIds is null.

      • removeVendorSpecificApplicationIds

        void removeVendorSpecificApplicationIds()
        Removes all Vendor-Specific-Application-Id AVPs from the Supported-Applications AVP. If no Vendor-Specific-Application-Id AVPs are 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 Supported-Applications 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 Supported-Applications 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 Supported-Applications AVP. If no extension AVPs are present, this method returns silently.