SubscribeNotificationsRequest (Diameter Resource Adaptor Types)

All Superinterfaces:: java.lang.Cloneable, DiameterMessage, DiameterShBaseMessage, DiameterShMessage

public interface SubscribeNotificationsRequest
extends DiameterShMessage

Defines an interface representing the Subscribe-Notifications-Request command. From the Diameter Sh Reference Point Protocol Details (3GPP TS 29.329 V12.6.0) specification:

 6.1.5        Subscribe-Notifications-Request (SNR) Command
 
 The Subscribe-Notifications-Request (SNR) command, indicated by the
 Command-Code field set to 308 and the 'R' bit set in the Command Flags field,
 is sent by a Diameter client to a Diameter server in order to request
 notifications of changes in user data.
 
 Message Format
 < Subscribe-Notifications-Request > ::= < Diameter Header: 308, REQ, PXY, 16777217 >
                                         < Session-Id >
                                         { Vendor-Specific-Application-Id }
                                         { Auth-Session-State }
                                         { Origin-Host }
                                         { Origin-Realm }
                                         [ Destination-Host ]
                                         { Destination-Realm }
                                         *[ Supported-Features ]
                                         { User-Identity }
                                         [ Wildcarded-Public-Identity ]
                                         [ Wildcarded-IMPU ]
                                         *[ Service-Indication ]
                                         [ Send-Data-Indication ]
                                         [ Server-Name ]
                                         { Subs-Req-Type }
                                         *{ Data-Reference }
                                         *[ Identity-Set ]
                                         [ Expiry-Time ]
                                         *[ DSAI-Tag ]
                                         [One-Time-Notification]
                                         [ User-Name ]
                                         [ OC-Supported-Features ]
                                         *[ AVP ]
                                         *[ Proxy-Info ]
                                         *[ Route-Record ]

Field Summary

Fields
Modifier and Type Field and Description

static int commandCode

Fields
Modifier and Type	Field and Description
`static int`	`commandCode`

Method Summary

Methods
Modifier and Type	Method and Description
`AuthSessionState`	`getAuthSessionState()` Returns the value of the Auth-Session-State AVP, of type Enumerated.
`DataReference[]`	`getDataReferences()` Returns the set of Data-Reference AVPs.
`DiameterIdentity`	`getDestinationHost()` Returns the value of the Destination-Host AVP, of type DiameterIdentity.
`DiameterIdentity`	`getDestinationRealm()` Returns the value of the Destination-Realm AVP, of type DiameterIdentity.
`byte[][]`	`getDsaiTags()` Returns the set of DSAI-Tag AVPs.
`java.util.Date`	`getExpiryTime()` Returns the value of the Expiry-Time AVP, of type Time.
`DiameterAvp[]`	`getExtensionAvps()` Returns the set of extension AVPs.
`IdentitySet[]`	`getIdentitySets()` Returns the set of Identity-Set AVPs.
`OcSupportedFeatures`	`getOcSupportedFeatures()` Returns the value of the OC-Supported-Features AVP, of type Grouped.
`OneTimeNotification`	`getOneTimeNotification()` Returns the value of the One-Time-Notification AVP, of type Enumerated.
`DiameterIdentity`	`getOriginHost()` Returns the value of the Origin-Host AVP, of type DiameterIdentity.
`DiameterIdentity`	`getOriginRealm()` Returns the value of the Origin-Realm AVP, of type DiameterIdentity.
`ProxyInfo[]`	`getProxyInfos()` Returns the set of Proxy-Info AVPs.
`DiameterIdentity[]`	`getRouteRecords()` Returns the set of Route-Record AVPs.
`SendDataIndication`	`getSendDataIndication()` Returns the value of the Send-Data-Indication AVP, of type Enumerated.
`java.lang.String`	`getServerName()` Returns the value of the Server-Name AVP, of type UTF8String.
`byte[][]`	`getServiceIndications()` Returns the set of Service-Indication AVPs.
`java.lang.String`	`getSessionId()` Returns the value of the Session-Id AVP, of type UTF8String.
`SubsReqType`	`getSubsReqType()` Returns the value of the Subs-Req-Type AVP, of type Enumerated.
`SupportedFeatures[]`	`getSupportedFeatureses()` Returns the set of Supported-Features AVPs.
`UserIdentity`	`getUserIdentity()` Returns the value of the User-Identity AVP, of type Grouped.
`java.lang.String`	`getUserName()` Returns the value of the User-Name AVP, of type UTF8String.
`VendorSpecificApplicationId`	`getVendorSpecificApplicationId()` Returns the value of the Vendor-Specific-Application-Id AVP, of type Grouped.
`java.lang.String`	`getWildcardedImpu()` Returns the value of the Wildcarded-IMPU AVP, of type UTF8String.
`java.lang.String`	`getWildcardedPublicIdentity()` Returns the value of the Wildcarded-Public-Identity AVP, of type UTF8String.
`boolean`	`hasAuthSessionState()` Returns true if the Auth-Session-State AVP is present in the message.
`boolean`	`hasDestinationHost()` Returns true if the Destination-Host AVP is present in the message.
`boolean`	`hasDestinationRealm()` Returns true if the Destination-Realm AVP is present in the message.
`boolean`	`hasExpiryTime()` Returns true if the Expiry-Time AVP is present in the message.
`boolean`	`hasOcSupportedFeatures()` Returns true if the OC-Supported-Features AVP is present in the message.
`boolean`	`hasOneTimeNotification()` Returns true if the One-Time-Notification AVP is present in the message.
`boolean`	`hasOriginHost()` Returns true if the Origin-Host AVP is present in the message.
`boolean`	`hasOriginRealm()` Returns true if the Origin-Realm AVP is present in the message.
`boolean`	`hasSendDataIndication()` Returns true if the Send-Data-Indication AVP is present in the message.
`boolean`	`hasServerName()` Returns true if the Server-Name AVP is present in the message.
`boolean`	`hasSessionId()` Returns true if the Session-Id AVP is present in the message.
`boolean`	`hasSubsReqType()` Returns true if the Subs-Req-Type AVP is present in the message.
`boolean`	`hasUserIdentity()` Returns true if the User-Identity AVP is present in the message.
`boolean`	`hasUserName()` Returns true if the User-Name AVP is present in the message.
`boolean`	`hasVendorSpecificApplicationId()` Returns true if the Vendor-Specific-Application-Id AVP is present in the message.
`boolean`	`hasWildcardedImpu()` Returns true if the Wildcarded-IMPU AVP is present in the message.
`boolean`	`hasWildcardedPublicIdentity()` Returns true if the Wildcarded-Public-Identity AVP is present in the message.
`void`	`removeAuthSessionState()` Removes the Auth-Session-State AVP from the message.
`void`	`removeDataReferences()` Removes all Data-Reference AVPs from the message.
`void`	`removeDestinationHost()` Removes the Destination-Host AVP from the message.
`void`	`removeDestinationRealm()` Removes the Destination-Realm AVP from the message.
`void`	`removeDsaiTags()` Removes all DSAI-Tag AVPs from the message.
`void`	`removeExpiryTime()` Removes the Expiry-Time AVP from the message.
`void`	`removeExtensionAvps()` Removes all extension AVPs from the message.
`void`	`removeIdentitySets()` Removes all Identity-Set AVPs from the message.
`void`	`removeOcSupportedFeatures()` Removes the OC-Supported-Features AVP from the message.
`void`	`removeOneTimeNotification()` Removes the One-Time-Notification AVP from the message.
`void`	`removeOriginHost()` Removes the Origin-Host AVP from the message.
`void`	`removeOriginRealm()` Removes the Origin-Realm AVP from the message.
`void`	`removeProxyInfos()` Removes all Proxy-Info AVPs from the message.
`void`	`removeRouteRecords()` Removes all Route-Record AVPs from the message.
`void`	`removeSendDataIndication()` Removes the Send-Data-Indication AVP from the message.
`void`	`removeServerName()` Removes the Server-Name AVP from the message.
`void`	`removeServiceIndications()` Removes all Service-Indication AVPs from the message.
`void`	`removeSessionId()` Removes the Session-Id AVP from the message.
`void`	`removeSubsReqType()` Removes the Subs-Req-Type AVP from the message.
`void`	`removeSupportedFeatureses()` Removes all Supported-Features AVPs from the message.
`void`	`removeUserIdentity()` Removes the User-Identity AVP from the message.
`void`	`removeUserName()` Removes the User-Name AVP from the message.
`void`	`removeVendorSpecificApplicationId()` Removes the Vendor-Specific-Application-Id AVP from the message.
`void`	`removeWildcardedImpu()` Removes the Wildcarded-IMPU AVP from the message.
`void`	`removeWildcardedPublicIdentity()` Removes the Wildcarded-Public-Identity AVP from the message.
`void`	`setAuthSessionState(AuthSessionState authSessionState)` Sets the value of the Auth-Session-State AVP, of type Enumerated.
`void`	`setDataReference(DataReference dataReference)` Sets a single Data-Reference AVP in the message, of type Enumerated.
`void`	`setDataReferences(DataReference[] dataReferences)` Sets the set of Data-Reference AVPs, with all the values in the given array.
`void`	`setDestinationHost(DiameterIdentity destinationHost)` Sets the value of the Destination-Host AVP, of type DiameterIdentity.
`void`	`setDestinationRealm(DiameterIdentity destinationRealm)` Sets the value of the Destination-Realm AVP, of type DiameterIdentity.
`void`	`setDsaiTag(byte[] dsaiTag)` Sets a single DSAI-Tag AVP in the message, of type OctetString.
`void`	`setDsaiTags(byte[][] dsaiTags)` Sets the set of DSAI-Tag AVPs, with all the values in the given array.
`void`	`setExpiryTime(java.util.Date expiryTime)` Sets the value of the Expiry-Time AVP, of type Time.
`void`	`setExtensionAvps(DiameterAvp[] avps)` Sets the set of extension AVPs with all the values in the given array.
`void`	`setIdentitySet(IdentitySet identitySet)` Sets a single Identity-Set AVP in the message, of type Enumerated.
`void`	`setIdentitySets(IdentitySet[] identitySets)` Sets the set of Identity-Set AVPs, with all the values in the given array.
`void`	`setOcSupportedFeatures(OcSupportedFeatures ocSupportedFeatures)` Sets the value of the OC-Supported-Features AVP, of type Grouped.
`void`	`setOneTimeNotification(OneTimeNotification oneTimeNotification)` Sets the value of the One-Time-Notification AVP, of type Enumerated.
`void`	`setOriginHost(DiameterIdentity originHost)` Sets the value of the Origin-Host AVP, of type DiameterIdentity.
`void`	`setOriginRealm(DiameterIdentity originRealm)` Sets the value of the Origin-Realm AVP, of type DiameterIdentity.
`void`	`setProxyInfo(ProxyInfo proxyInfo)` Sets a single Proxy-Info AVP in the message, of type Grouped.
`void`	`setProxyInfos(ProxyInfo[] proxyInfos)` Sets the set of Proxy-Info AVPs, with all the values in the given array.
`void`	`setRouteRecord(DiameterIdentity routeRecord)` Sets a single Route-Record AVP in the message, of type DiameterIdentity.
`void`	`setRouteRecords(DiameterIdentity[] routeRecords)` Sets the set of Route-Record AVPs, with all the values in the given array.
`void`	`setSendDataIndication(SendDataIndication sendDataIndication)` Sets the value of the Send-Data-Indication AVP, of type Enumerated.
`void`	`setServerName(java.lang.String serverName)` Sets the value of the Server-Name AVP, of type UTF8String.
`void`	`setServiceIndication(byte[] serviceIndication)` Sets a single Service-Indication AVP in the message, of type OctetString.
`void`	`setServiceIndications(byte[][] serviceIndications)` Sets the set of Service-Indication AVPs, with all the values in the given array.
`void`	`setSessionId(java.lang.String sessionId)` Sets the value of the Session-Id AVP, of type UTF8String.
`void`	`setSubsReqType(SubsReqType subsReqType)` Sets the value of the Subs-Req-Type AVP, of type Enumerated.
`void`	`setSupportedFeatures(SupportedFeatures supportedFeatures)` Sets a single Supported-Features AVP in the message, of type Grouped.
`void`	`setSupportedFeatureses(SupportedFeatures[] supportedFeatureses)` Sets the set of Supported-Features AVPs, with all the values in the given array.
`void`	`setUserIdentity(UserIdentity userIdentity)` Sets the value of the User-Identity AVP, of type Grouped.
`void`	`setUserName(java.lang.String userName)` Sets the value of the User-Name AVP, of type UTF8String.
`void`	`setVendorSpecificApplicationId(VendorSpecificApplicationId vendorSpecificApplicationId)` Sets the value of the Vendor-Specific-Application-Id AVP, of type Grouped.
`void`	`setWildcardedImpu(java.lang.String wildcardedImpu)` Sets the value of the Wildcarded-IMPU AVP, of type UTF8String.
`void`	`setWildcardedPublicIdentity(java.lang.String wildcardedPublicIdentity)` Sets the value of the Wildcarded-Public-Identity AVP, of type UTF8String.

Methods inherited from interface org.jainslee.resources.diameter.base.DiameterMessage
clone, getAvps, getCommand, getHeader

- Field Detail
  - commandCode
```
static final int commandCode
```
    See Also:
    Constant Field Values
- Method Detail
  - hasSessionId
```
boolean hasSessionId()
```
    Returns true if the Session-Id AVP is present in the message.
  - getSessionId
```
java.lang.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
  - setSessionId
```
void setSessionId(java.lang.String sessionId)
```
    Sets the value of the Session-Id AVP, of type UTF8String.
    
    Specified by:
    
    setSessionId in interface DiameterMessage
    
    Throws:
    
    java.lang.NullPointerException - if sessionId is null.
  - removeSessionId
```
void removeSessionId()
```
    Removes the Session-Id AVP from the message. If the Session-Id AVP is not present, this method returns silently.
  - hasVendorSpecificApplicationId
```
boolean hasVendorSpecificApplicationId()
```
    Returns true if the Vendor-Specific-Application-Id AVP is present in the message.
    
    Specified by:
    
    hasVendorSpecificApplicationId in interface DiameterShBaseMessage
  - getVendorSpecificApplicationId
```
VendorSpecificApplicationId getVendorSpecificApplicationId()
```
    Returns the value of the Vendor-Specific-Application-Id AVP, of type Grouped.
    
    Specified by:
    
    getVendorSpecificApplicationId in interface DiameterShBaseMessage
    
    Returns:
    the value of the Vendor-Specific-Application-Id AVP or null if it has not been set on this message
  - setVendorSpecificApplicationId
```
void setVendorSpecificApplicationId(VendorSpecificApplicationId vendorSpecificApplicationId)
```
    Sets the value of the Vendor-Specific-Application-Id AVP, of type Grouped.
    
    Specified by:
    
    setVendorSpecificApplicationId in interface DiameterShBaseMessage
    
    Throws:
    
    java.lang.NullPointerException - if vendorSpecificApplicationId is null.
  - 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.
  - hasAuthSessionState
```
boolean hasAuthSessionState()
```
    Returns true if the Auth-Session-State AVP is present in the message.
    
    Specified by:
    
    hasAuthSessionState in interface DiameterShBaseMessage
  - 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
  - setAuthSessionState
```
void setAuthSessionState(AuthSessionState authSessionState)
```
    Sets the value of the Auth-Session-State AVP, of type Enumerated.
    
    Specified by:
    
    setAuthSessionState in interface DiameterShBaseMessage
    
    Throws:
    
    java.lang.NullPointerException - if authSessionState is null.
  - 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.
  - 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
  - setOriginHost
```
void setOriginHost(DiameterIdentity originHost)
```
    Sets the value of the Origin-Host AVP, of type DiameterIdentity.
    
    Specified by:
    
    setOriginHost in interface DiameterMessage
    
    Throws:
    
    java.lang.NullPointerException - if originHost is null.
  - 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
  - setOriginRealm
```
void setOriginRealm(DiameterIdentity originRealm)
```
    Sets the value of the Origin-Realm AVP, of type DiameterIdentity.
    
    Specified by:
    
    setOriginRealm in interface DiameterMessage
    
    Throws:
    
    java.lang.NullPointerException - if originRealm is null.
  - removeOriginRealm
```
void removeOriginRealm()
```
    Removes the Origin-Realm AVP from the message. If the Origin-Realm AVP is not present, this method returns silently.
  - hasDestinationHost
```
boolean hasDestinationHost()
```
    Returns true if the Destination-Host AVP is present in the message.
  - getDestinationHost
```
DiameterIdentity getDestinationHost()
```
    Returns the value of the Destination-Host AVP, of type DiameterIdentity.
    
    Specified by:
    
    getDestinationHost in interface DiameterMessage
    
    Returns:
    the value of the Destination-Host AVP or null if it has not been set on this message
  - setDestinationHost
```
void setDestinationHost(DiameterIdentity destinationHost)
```
    Sets the value of the Destination-Host AVP, of type DiameterIdentity.
    
    Specified by:
    
    setDestinationHost in interface DiameterMessage
    
    Throws:
    
    java.lang.NullPointerException - if destinationHost is null.
  - removeDestinationHost
```
void removeDestinationHost()
```
    Removes the Destination-Host AVP from the message. If the Destination-Host AVP is not present, this method returns silently.
  - hasDestinationRealm
```
boolean hasDestinationRealm()
```
    Returns true if the Destination-Realm AVP is present in the message.
  - getDestinationRealm
```
DiameterIdentity getDestinationRealm()
```
    Returns the value of the Destination-Realm AVP, of type DiameterIdentity.
    
    Specified by:
    
    getDestinationRealm in interface DiameterMessage
    
    Returns:
    the value of the Destination-Realm AVP or null if it has not been set on this message
  - setDestinationRealm
```
void setDestinationRealm(DiameterIdentity destinationRealm)
```
    Sets the value of the Destination-Realm AVP, of type DiameterIdentity.
    
    Specified by:
    
    setDestinationRealm in interface DiameterMessage
    
    Throws:
    
    java.lang.NullPointerException - if destinationRealm is null.
  - removeDestinationRealm
```
void removeDestinationRealm()
```
    Removes the Destination-Realm AVP from the message. If the Destination-Realm 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
  - setSupportedFeatures
```
void setSupportedFeatures(SupportedFeatures supportedFeatures)
```
    Sets a single Supported-Features AVP in the message, of type Grouped.
    
    Specified by:
    
    setSupportedFeatures in interface DiameterShMessage
    
    Throws:
    
    java.lang.NullPointerException - if supportedFeatures is null.
  - 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:
    
    java.lang.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.
  - hasUserIdentity
```
boolean hasUserIdentity()
```
    Returns true if the User-Identity AVP is present in the message.
  - getUserIdentity
```
UserIdentity getUserIdentity()
```
    Returns the value of the User-Identity AVP, of type Grouped.
    
    Returns:
    the value of the User-Identity AVP or null if it has not been set on this message
  - setUserIdentity
```
void setUserIdentity(UserIdentity userIdentity)
```
    Sets the value of the User-Identity AVP, of type Grouped.
    
    Throws:
    
    java.lang.NullPointerException - if userIdentity is null.
  - removeUserIdentity
```
void removeUserIdentity()
```
    Removes the User-Identity AVP from the message. If the User-Identity 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
```
java.lang.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(java.lang.String wildcardedPublicIdentity)
```
    Sets the value of the Wildcarded-Public-Identity AVP, of type UTF8String.
    
    Throws:
    
    java.lang.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
```
java.lang.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(java.lang.String wildcardedImpu)
```
    Sets the value of the Wildcarded-IMPU AVP, of type UTF8String.
    
    Throws:
    
    java.lang.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.
  - getServiceIndications
```
byte[][] getServiceIndications()
```
    Returns the set of Service-Indication AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Service-Indication AVPs have been set. The elements in the given array are byte[] objects.
  - setServiceIndication
```
void setServiceIndication(byte[] serviceIndication)
```
    Sets a single Service-Indication AVP in the message, of type OctetString.
    
    Throws:
    
    java.lang.NullPointerException - if serviceIndication is null.
  - setServiceIndications
```
void setServiceIndications(byte[][] serviceIndications)
```
    Sets the set of Service-Indication 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 getServiceIndications() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
    
    Throws:
    
    java.lang.NullPointerException - if serviceIndications is null.
  - removeServiceIndications
```
void removeServiceIndications()
```
    Removes all Service-Indication AVPs from the message. If no Service-Indication AVPs are present, this method returns silently.
  - hasSendDataIndication
```
boolean hasSendDataIndication()
```
    Returns true if the Send-Data-Indication AVP is present in the message.
  - getSendDataIndication
```
SendDataIndication getSendDataIndication()
```
    Returns the value of the Send-Data-Indication AVP, of type Enumerated.
    
    Returns:
    the value of the Send-Data-Indication AVP or null if it has not been set on this message
  - setSendDataIndication
```
void setSendDataIndication(SendDataIndication sendDataIndication)
```
    Sets the value of the Send-Data-Indication AVP, of type Enumerated.
    
    Throws:
    
    java.lang.NullPointerException - if sendDataIndication is null.
  - removeSendDataIndication
```
void removeSendDataIndication()
```
    Removes the Send-Data-Indication AVP from the message. If the Send-Data-Indication AVP is not present, this method returns silently.
  - hasServerName
```
boolean hasServerName()
```
    Returns true if the Server-Name AVP is present in the message.
  - getServerName
```
java.lang.String getServerName()
```
    Returns the value of the Server-Name AVP, of type UTF8String.
    
    Returns:
    the value of the Server-Name AVP or null if it has not been set on this message
  - setServerName
```
void setServerName(java.lang.String serverName)
```
    Sets the value of the Server-Name AVP, of type UTF8String.
    
    Throws:
    
    java.lang.NullPointerException - if serverName is null.
  - removeServerName
```
void removeServerName()
```
    Removes the Server-Name AVP from the message. If the Server-Name AVP is not present, this method returns silently.
  - hasSubsReqType
```
boolean hasSubsReqType()
```
    Returns true if the Subs-Req-Type AVP is present in the message.
  - getSubsReqType
```
SubsReqType getSubsReqType()
```
    Returns the value of the Subs-Req-Type AVP, of type Enumerated.
    
    Returns:
    the value of the Subs-Req-Type AVP or null if it has not been set on this message
  - setSubsReqType
```
void setSubsReqType(SubsReqType subsReqType)
```
    Sets the value of the Subs-Req-Type AVP, of type Enumerated.
    
    Throws:
    
    java.lang.NullPointerException - if subsReqType is null.
  - removeSubsReqType
```
void removeSubsReqType()
```
    Removes the Subs-Req-Type AVP from the message. If the Subs-Req-Type AVP is not present, this method returns silently.
  - getDataReferences
```
DataReference[] getDataReferences()
```
    Returns the set of Data-Reference AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Data-Reference AVPs have been set. The elements in the given array are DataReference objects.
  - setDataReference
```
void setDataReference(DataReference dataReference)
```
    Sets a single Data-Reference AVP in the message, of type Enumerated.
    
    Throws:
    
    java.lang.NullPointerException - if dataReference is null.
  - setDataReferences
```
void setDataReferences(DataReference[] dataReferences)
```
    Sets the set of Data-Reference 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 getDataReferences() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
    
    Throws:
    
    java.lang.NullPointerException - if dataReferences is null.
  - removeDataReferences
```
void removeDataReferences()
```
    Removes all Data-Reference AVPs from the message. If no Data-Reference AVPs are present, this method returns silently.
  - getIdentitySets
```
IdentitySet[] getIdentitySets()
```
    Returns the set of Identity-Set AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Identity-Set AVPs have been set. The elements in the given array are IdentitySet objects.
  - setIdentitySet
```
void setIdentitySet(IdentitySet identitySet)
```
    Sets a single Identity-Set AVP in the message, of type Enumerated.
    
    Throws:
    
    java.lang.NullPointerException - if identitySet is null.
  - setIdentitySets
```
void setIdentitySets(IdentitySet[] identitySets)
```
    Sets the set of Identity-Set 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 getIdentitySets() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
    
    Throws:
    
    java.lang.NullPointerException - if identitySets is null.
  - removeIdentitySets
```
void removeIdentitySets()
```
    Removes all Identity-Set AVPs from the message. If no Identity-Set AVPs are present, this method returns silently.
  - hasExpiryTime
```
boolean hasExpiryTime()
```
    Returns true if the Expiry-Time AVP is present in the message.
  - getExpiryTime
```
java.util.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(java.util.Date expiryTime)
```
    Sets the value of the Expiry-Time AVP, of type Time.
    
    Throws:
    
    java.lang.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.
  - getDsaiTags
```
byte[][] getDsaiTags()
```
    Returns the set of DSAI-Tag AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no DSAI-Tag AVPs have been set. The elements in the given array are byte[] objects.
  - setDsaiTag
```
void setDsaiTag(byte[] dsaiTag)
```
    Sets a single DSAI-Tag AVP in the message, of type OctetString.
    
    Throws:
    
    java.lang.NullPointerException - if dsaiTag is null.
  - setDsaiTags
```
void setDsaiTags(byte[][] dsaiTags)
```
    Sets the set of DSAI-Tag 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 getDsaiTags() is not guaranteed to return the same array instance, e.g. an "==" check would fail.
    
    Throws:
    
    java.lang.NullPointerException - if dsaiTags is null.
  - removeDsaiTags
```
void removeDsaiTags()
```
    Removes all DSAI-Tag AVPs from the message. If no DSAI-Tag AVPs are present, this method returns silently.
  - hasOneTimeNotification
```
boolean hasOneTimeNotification()
```
    Returns true if the One-Time-Notification AVP is present in the message.
  - getOneTimeNotification
```
OneTimeNotification getOneTimeNotification()
```
    Returns the value of the One-Time-Notification AVP, of type Enumerated.
    
    Returns:
    the value of the One-Time-Notification AVP or null if it has not been set on this message
  - setOneTimeNotification
```
void setOneTimeNotification(OneTimeNotification oneTimeNotification)
```
    Sets the value of the One-Time-Notification AVP, of type Enumerated.
    
    Throws:
    
    java.lang.NullPointerException - if oneTimeNotification is null.
  - removeOneTimeNotification
```
void removeOneTimeNotification()
```
    Removes the One-Time-Notification AVP from the message. If the One-Time-Notification AVP is not present, this method returns silently.
  - hasUserName
```
boolean hasUserName()
```
    Returns true if the User-Name AVP is present in the message.
  - getUserName
```
java.lang.String getUserName()
```
    Returns the value of the User-Name AVP, of type UTF8String.
    
    Returns:
    the value of the User-Name AVP or null if it has not been set on this message
  - setUserName
```
void setUserName(java.lang.String userName)
```
    Sets the value of the User-Name AVP, of type UTF8String.
    
    Throws:
    
    java.lang.NullPointerException - if userName is null.
  - removeUserName
```
void removeUserName()
```
    Removes the User-Name AVP from the message. If the User-Name 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:
    
    java.lang.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.
  - 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
  - setProxyInfo
```
void setProxyInfo(ProxyInfo proxyInfo)
```
    Sets a single Proxy-Info AVP in the message, of type Grouped.
    
    Specified by:
    
    setProxyInfo in interface DiameterShBaseMessage
    
    Throws:
    
    java.lang.NullPointerException - if proxyInfo is null.
  - 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:
    
    java.lang.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
  - setRouteRecord
```
void setRouteRecord(DiameterIdentity routeRecord)
```
    Sets a single Route-Record AVP in the message, of type DiameterIdentity.
    
    Specified by:
    
    setRouteRecord in interface DiameterShBaseMessage
    
    Throws:
    
    java.lang.NullPointerException - if routeRecord is null.
  - 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:
    
    java.lang.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)
    
    java.lang.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.

Interface SubscribeNotificationsRequest

Field Summary

Method Summary

Methods inherited from interface org.jainslee.resources.diameter.base.DiameterMessage

Field Detail

commandCode

Method Detail

hasSessionId

getSessionId

setSessionId

removeSessionId

hasVendorSpecificApplicationId

getVendorSpecificApplicationId

setVendorSpecificApplicationId

removeVendorSpecificApplicationId

hasAuthSessionState

getAuthSessionState

setAuthSessionState

removeAuthSessionState

hasOriginHost

getOriginHost

setOriginHost

removeOriginHost

hasOriginRealm

getOriginRealm

setOriginRealm

removeOriginRealm

hasDestinationHost

getDestinationHost

setDestinationHost

removeDestinationHost

hasDestinationRealm

getDestinationRealm

setDestinationRealm

removeDestinationRealm

getSupportedFeatureses

setSupportedFeatures

setSupportedFeatureses

removeSupportedFeatureses

hasUserIdentity

getUserIdentity

setUserIdentity

removeUserIdentity

hasWildcardedPublicIdentity

getWildcardedPublicIdentity

setWildcardedPublicIdentity

removeWildcardedPublicIdentity

hasWildcardedImpu

getWildcardedImpu

setWildcardedImpu

removeWildcardedImpu

getServiceIndications

setServiceIndication

setServiceIndications

removeServiceIndications

hasSendDataIndication

getSendDataIndication

setSendDataIndication

removeSendDataIndication

hasServerName

getServerName

setServerName

removeServerName

hasSubsReqType

getSubsReqType

setSubsReqType

removeSubsReqType

getDataReferences

setDataReference

setDataReferences

removeDataReferences

getIdentitySets

setIdentitySet

setIdentitySets

removeIdentitySets

hasExpiryTime

getExpiryTime

setExpiryTime

removeExpiryTime

getDsaiTags