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

Interface SubscribeNotificationsAnswer

  • All Superinterfaces:
    Cloneable, DiameterMessage, DiameterShBaseMessage, DiameterShMessage
    public interface SubscribeNotificationsAnswer
extends DiameterShMessage
    Defines an interface representing the Subscribe-Notifications-Answer command. From the Diameter Sh Reference Point Protocol Details (3GPP TS 29.329 V12.6.0) specification: 
     6.1.6        Subscribe-Notifications-Answer (SNA) Command
 
 The Subscribe-Notifications-Answer command, indicated by the Command-Code field
 set to 308 and the 'R' bit cleared in the Command Flags field, is sent by a
 server in response to the Subscribe-Notifications-Request command. The
 Result-Code or Experimental-Result AVP may contain one of the values defined in
 section 6.2 or in 3GPP TS 29.229 [6].
 
 Message Format
 < Subscribe-Notifications-Answer > ::=      < Diameter Header: 308, PXY, 16777217 >
                                             < Session-Id >
                                             { Vendor-Specific-Application-Id }
                                             { Auth-Session-State }
                                             [ Result-Code ]
                                             [ Experimental-Result ]
                                             { Origin-Host }
                                             { Origin-Realm }
                                             [ Wildcarded-Public-Identity ]
                                             [ Wildcarded-IMPU ]
                                             *[ Supported-Features ]
                                             [ User-Data ]
                                             [ Expiry-Time ]
                                             [ OC-Supported-Features ]
                                             [ OC-OLR ]
                                             *[ AVP ]
                                             *[ Failed-AVP ]
                                             *[ Proxy-Info ]
                                             *[ Route-Record ]

    • Method Detail

      • hasSessionId

        boolean hasSessionId()
        Returns true if the Session-Id AVP is present in the message.

      • getSessionId

        String getSessionId()
        Returns the value of the Session-Id AVP, of type UTF8String.
        Specified by:
        getSessionId in interface DiameterMessage
        Returns:
        the value of the Session-Id AVP or null if it has not been set on this message

      • removeSessionId

        void removeSessionId()
        Removes the Session-Id AVP from the message. If the Session-Id AVP is not present, this method returns silently.

      • removeVendorSpecificApplicationId

        void removeVendorSpecificApplicationId()
        Removes the Vendor-Specific-Application-Id AVP from the message. If the Vendor-Specific-Application-Id AVP is not present, this method returns silently.

      • getAuthSessionState

        AuthSessionState getAuthSessionState()
        Returns the value of the Auth-Session-State AVP, of type Enumerated.
        Specified by:
        getAuthSessionState in interface DiameterShBaseMessage
        Returns:
        the value of the Auth-Session-State AVP or null if it has not been set on this message

      • removeAuthSessionState

        void removeAuthSessionState()
        Removes the Auth-Session-State AVP from the message. If the Auth-Session-State AVP is not present, this method returns silently.

      • hasResultCode

        boolean hasResultCode()
        Returns true if the Result-Code AVP is present in the message.

      • getResultCode

        long getResultCode()
        Returns the value of the Result-Code AVP, of type Unsigned32. Use hasResultCode() to check the existence of this AVP.
        Returns:
        the value of the Result-Code AVP
        Throws:
        IllegalStateException - if the Result-Code AVP has not been set on this message

      • setResultCode

        void setResultCode​(long resultCode)
        Sets the value of the Result-Code AVP, of type Unsigned32.

      • removeResultCode

        void removeResultCode()
        Removes the Result-Code AVP from the message. If the Result-Code AVP is not present, this method returns silently.

      • hasExperimentalResult

        boolean hasExperimentalResult()
        Returns true if the Experimental-Result AVP is present in the message.

      • getExperimentalResult

        ExperimentalResult getExperimentalResult()
        Returns the value of the Experimental-Result AVP, of type Grouped.
        Returns:
        the value of the Experimental-Result AVP or null if it has not been set on this message

      • setExperimentalResult

        void setExperimentalResult​(ExperimentalResult experimentalResult)
        Sets the value of the Experimental-Result AVP, of type Grouped.
        Throws:
        NullPointerException - if experimentalResult is null.

      • removeExperimentalResult

        void removeExperimentalResult()
        Removes the Experimental-Result AVP from the message. If the Experimental-Result AVP is not present, this method returns silently.

      • hasOriginHost

        boolean hasOriginHost()
        Returns true if the Origin-Host AVP is present in the message.

      • getOriginHost

        DiameterIdentity getOriginHost()
        Returns the value of the Origin-Host AVP, of type DiameterIdentity.
        Specified by:
        getOriginHost in interface DiameterMessage
        Returns:
        the value of the Origin-Host AVP or null if it has not been set on this message

      • removeOriginHost

        void removeOriginHost()
        Removes the Origin-Host AVP from the message. If the Origin-Host AVP is not present, this method returns silently.

      • hasOriginRealm

        boolean hasOriginRealm()
        Returns true if the Origin-Realm AVP is present in the message.

      • getOriginRealm

        DiameterIdentity getOriginRealm()
        Returns the value of the Origin-Realm AVP, of type DiameterIdentity.
        Specified by:
        getOriginRealm in interface DiameterMessage
        Returns:
        the value of the Origin-Realm AVP or null if it has not been set on this message

      • removeOriginRealm

        void removeOriginRealm()
        Removes the Origin-Realm AVP from the message. If the Origin-Realm AVP is not present, this method returns silently.

      • hasWildcardedPublicIdentity

        boolean hasWildcardedPublicIdentity()
        Returns true if the Wildcarded-Public-Identity AVP is present in the message.

      • getWildcardedPublicIdentity

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

      • setWildcardedPublicIdentity

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

      • removeWildcardedPublicIdentity

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

      • hasWildcardedImpu

        boolean hasWildcardedImpu()
        Returns true if the Wildcarded-IMPU AVP is present in the message.

      • getWildcardedImpu

        String getWildcardedImpu()
        Returns the value of the Wildcarded-IMPU AVP, of type UTF8String.
        Returns:
        the value of the Wildcarded-IMPU AVP or null if it has not been set on this message

      • setWildcardedImpu

        void setWildcardedImpu​(String wildcardedImpu)
        Sets the value of the Wildcarded-IMPU AVP, of type UTF8String.
        Throws:
        NullPointerException - if wildcardedImpu is null.

      • removeWildcardedImpu

        void removeWildcardedImpu()
        Removes the Wildcarded-IMPU AVP from the message. If the Wildcarded-IMPU AVP is not present, this method returns silently.

      • getSupportedFeatureses

        SupportedFeatures[] getSupportedFeatureses()
        Returns the set of Supported-Features AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Supported-Features AVPs have been set. The elements in the given array are SupportedFeatures objects.
        Specified by:
        getSupportedFeatureses in interface DiameterShMessage

      • setSupportedFeatureses

        void setSupportedFeatureses​(SupportedFeatures[] supportedFeatureses)
        Sets the set of Supported-Features 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 getSupportedFeatureses() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Specified by:
        setSupportedFeatureses in interface DiameterShMessage
        Throws:
        NullPointerException - if supportedFeatureses is null.

      • removeSupportedFeatureses

        void removeSupportedFeatureses()
        Removes all Supported-Features AVPs from the message. If no Supported-Features AVPs are present, this method returns silently.

      • hasUserData

        boolean hasUserData()
        Returns true if the User-Data AVP is present in the message.

      • getUserData

        UserData getUserData()
        Returns the value of the User-Data AVP, of type UserData.
        Returns:
        the value of the User-Data AVP or null if it has not been set on this message

      • setUserData

        void setUserData​(UserData userData)
        Sets the value of the User-Data AVP, of type UserData.
        Throws:
        NullPointerException - if userData is null.

      • removeUserData

        void removeUserData()
        Removes the User-Data AVP from the message. If the User-Data AVP is not present, this method returns silently.

      • hasExpiryTime

        boolean hasExpiryTime()
        Returns true if the Expiry-Time AVP is present in the message.

      • getExpiryTime

        Date getExpiryTime()
        Returns the value of the Expiry-Time AVP, of type Time.
        Returns:
        the value of the Expiry-Time AVP or null if it has not been set on this message

      • setExpiryTime

        void setExpiryTime​(Date expiryTime)
        Sets the value of the Expiry-Time AVP, of type Time.
        Throws:
        NullPointerException - if expiryTime is null.

      • removeExpiryTime

        void removeExpiryTime()
        Removes the Expiry-Time AVP from the message. If the Expiry-Time AVP is not present, this method returns silently.

      • hasOcSupportedFeatures

        boolean hasOcSupportedFeatures()
        Returns true if the OC-Supported-Features AVP is present in the message.

      • getOcSupportedFeatures

        OcSupportedFeatures getOcSupportedFeatures()
        Returns the value of the OC-Supported-Features AVP, of type Grouped.
        Returns:
        the value of the OC-Supported-Features AVP or null if it has not been set on this message

      • setOcSupportedFeatures

        void setOcSupportedFeatures​(OcSupportedFeatures ocSupportedFeatures)
        Sets the value of the OC-Supported-Features AVP, of type Grouped.
        Throws:
        NullPointerException - if ocSupportedFeatures is null.

      • removeOcSupportedFeatures

        void removeOcSupportedFeatures()
        Removes the OC-Supported-Features AVP from the message. If the OC-Supported-Features AVP is not present, this method returns silently.

      • hasOcOlr

        boolean hasOcOlr()
        Returns true if the OC-OLR AVP is present in the message.

      • getOcOlr

        OcOlr getOcOlr()
        Returns the value of the OC-OLR AVP, of type Grouped.
        Returns:
        the value of the OC-OLR AVP or null if it has not been set on this message

      • setOcOlr

        void setOcOlr​(OcOlr ocOlr)
        Sets the value of the OC-OLR AVP, of type Grouped.
        Throws:
        NullPointerException - if ocOlr is null.

      • removeOcOlr

        void removeOcOlr()
        Removes the OC-OLR AVP from the message. If the OC-OLR AVP is not present, this method returns silently.

      • getFailedAvps

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

      • setFailedAvp

        void setFailedAvp​(FailedAvp failedAvp)
        Sets a single Failed-AVP AVP in the message, of type Grouped.
        Throws:
        NullPointerException - if failedAvp is null.

      • setFailedAvps

        void setFailedAvps​(FailedAvp[] failedAvps)
        Sets the set of Failed-AVP 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 getFailedAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
        Throws:
        NullPointerException - if failedAvps is null.

      • removeFailedAvps

        void removeFailedAvps()
        Removes all Failed-AVP AVPs from the message. If no Failed-AVP AVPs are present, this method returns silently.

      • 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.
        Specified by:
        getProxyInfos in interface DiameterShBaseMessage

      • 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.
        Specified by:
        setProxyInfos in interface DiameterShBaseMessage
        Throws:
        NullPointerException - if proxyInfos is null.

      • removeProxyInfos

        void removeProxyInfos()
        Removes all Proxy-Info AVPs from the message. If no Proxy-Info AVPs are present, this method returns silently.

      • 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.
        Specified by:
        getRouteRecords in interface DiameterShBaseMessage

      • 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.
        Specified by:
        setRouteRecords in interface DiameterShBaseMessage
        Throws:
        NullPointerException - if routeRecords is null.

      • removeRouteRecords

        void removeRouteRecords()
        Removes all Route-Record AVPs from the message. If no Route-Record 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 message. A return value of null implies that no extensions AVPs have been set.
        Specified by:
        getExtensionAvps in interface DiameterShBaseMessage

      • 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.
        Specified by:
        setExtensionAvps in interface DiameterShBaseMessage
        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 message. If no extension AVPs are present, this method returns silently.