Package org.jainslee.resources.diameter.sh

Interface DiameterShBaseMessage

    • Method Detail

      • hasVendorSpecificApplicationId

        boolean hasVendorSpecificApplicationId()
        Returns true if the Vendor-Specific-Application-Id AVP is present in the message.

      • getVendorSpecificApplicationId

        VendorSpecificApplicationId getVendorSpecificApplicationId()
        Returns the value of the Vendor-Specific-Application-Id AVP, of type Grouped. A return value of null implies that the AVP has not been set.

      • setVendorSpecificApplicationId

        void setVendorSpecificApplicationId​(VendorSpecificApplicationId vendorSpecificApplicationId)
        Sets the value of the Vendor-Specific-Application-Id AVP, of type Grouped.
        Throws:
        IllegalStateException - if setVendorSpecificApplicationId has already been called

      • hasAuthSessionState

        boolean hasAuthSessionState()
        Returns true if the Auth-Session-State AVP is present in the message.

      • getAuthSessionState

        AuthSessionState getAuthSessionState()
        Returns the value of the Auth-Session-State AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

      • setAuthSessionState

        void setAuthSessionState​(AuthSessionState authSessionState)
        Sets the value of the Auth-Session-State AVP, of type Enumerated.
        Throws:
        IllegalStateException - if setAuthSessionState has already been called

      • getProxyInfos

        ProxyInfo[] getProxyInfos()
        Returns the set of Proxy-Info AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Proxy-Info AVPs have been set. The elements in the given array are ProxyInfo objects.

      • setProxyInfo

        void setProxyInfo​(ProxyInfo proxyInfo)
        Sets a single Proxy-Info AVP in the message, of type Grouped.
        Throws:
        IllegalStateException - if setProxyInfo or setProxyInfos has already been called

      • setProxyInfos

        void setProxyInfos​(ProxyInfo[] proxyInfos)
        Sets the set of Proxy-Info AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getProxyInfos() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        IllegalStateException - if setProxyInfo or setProxyInfos has already been called

      • getRouteRecords

        DiameterIdentity[] getRouteRecords()
        Returns the set of Route-Record AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Route-Record AVPs have been set. The elements in the given array are DiameterIdentity objects.

      • setRouteRecord

        void setRouteRecord​(DiameterIdentity routeRecord)
        Sets a single Route-Record AVP in the message, of type DiameterIdentity.
        Throws:
        IllegalStateException - if setRouteRecord or setRouteRecords has already been called

      • setRouteRecords

        void setRouteRecords​(DiameterIdentity[] routeRecords)
        Sets the set of Route-Record AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getRouteRecords() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        IllegalStateException - if setRouteRecord or setRouteRecords has already been called

      • getExtensionAvps

        DiameterAvp[] getExtensionAvps()
        Returns the set of extension AVPs. The returned array contains the extension AVPs in the order they appear in the message. 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 message 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)
        IllegalStateException - if setExtensionAvps has already been called