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

Interface ApplicationServerInformation

  • All Superinterfaces:
    Cloneable, DiameterAvp, GroupedAvp
    public interface ApplicationServerInformation
extends GroupedAvp
    Defines an interface representing the Application-Server-Information grouped AVP type. From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V9.6.0) specification: 
     7.2.24      Application-Server-Information AVP
 
 The Application-Server-Information AVP (AVP code 850) is of type Grouped
 and contains information about application servers visited through ISC
 interface.
 It has the following ABNF grammar:
 
       Application-Server-Information ::= <AVP Header: 850 >
                                            [ Application-Server ]
                                          * [ Application-Provided-Called-Party-Address ]
    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

      • hasApplicationServer

        boolean hasApplicationServer()
        Returns true if the Application-Server AVP is present in the Application-Server-Information AVP.

      • getApplicationServer

        String getApplicationServer()
        Returns the value of the Application-Server AVP, of type UTF8String.
        Returns:
        the value of the Application-Server AVP, or null if it has not been set.

      • setApplicationServer

        void setApplicationServer​(String applicationServer)
        Sets the value of the Application-Server AVP, of type UTF8String.
        Throws:
        NullPointerException - if applicationServer is null.

      • removeApplicationServer

        void removeApplicationServer()
        Removes the Application-Server AVP from the Application-Server-Information AVP. If the Application-Server AVP is not present, this method returns silently.

      • getApplicationProvidedCalledPartyAddresses

        String[] getApplicationProvidedCalledPartyAddresses()
        Returns the set of Application-Provided-Called-Party-Address AVPs. The returned array contains the AVPs in the order they appear in the Application-Server-Information AVP. A return value of null implies that no Application-Provided-Called-Party-Address AVPs have been set. The elements in the given array are String objects.

      • setApplicationProvidedCalledPartyAddress

        void setApplicationProvidedCalledPartyAddress​(String applicationProvidedCalledPartyAddress)
        Sets a single Application-Provided-Called-Party-Address AVP in the Application-Server-Information AVP, of type UTF8String.
        Throws:
        NullPointerException - if applicationProvidedCalledPartyAddress is null.

      • setApplicationProvidedCalledPartyAddresses

        void setApplicationProvidedCalledPartyAddresses​(String[] applicationProvidedCalledPartyAddresses)
        Sets the set of Application-Provided-Called-Party-Address AVPs, with all the values in the given array. The AVPs will be added to the Application-Server-Information 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 getApplicationProvidedCalledPartyAddresses() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if applicationProvidedCalledPartyAddresses is null.

      • removeApplicationProvidedCalledPartyAddresses

        void removeApplicationProvidedCalledPartyAddresses()
        Removes all Application-Provided-Called-Party-Address AVPs from the Application-Server-Information AVP. If no Application-Provided-Called-Party-Address 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 Application-Server-Information 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 Application-Server-Information 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 Application-Server-Information AVP. If no extension AVPs are present, this method returns silently.