public interface SubscribeNotificationsRequest extends DiameterShMessage
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 ]
Modifier and Type | Field and Description |
---|---|
static int |
commandCode |
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.
|
clone, getAvps, getCommand, getHeader
static final int commandCode
boolean hasSessionId()
java.lang.String getSessionId()
getSessionId
in interface DiameterMessage
void setSessionId(java.lang.String sessionId)
setSessionId
in interface DiameterMessage
java.lang.NullPointerException
- if sessionId
is null
.void removeSessionId()
boolean hasVendorSpecificApplicationId()
hasVendorSpecificApplicationId
in interface DiameterShBaseMessage
VendorSpecificApplicationId getVendorSpecificApplicationId()
getVendorSpecificApplicationId
in interface DiameterShBaseMessage
void setVendorSpecificApplicationId(VendorSpecificApplicationId vendorSpecificApplicationId)
setVendorSpecificApplicationId
in interface DiameterShBaseMessage
java.lang.NullPointerException
- if vendorSpecificApplicationId
is null
.void removeVendorSpecificApplicationId()
boolean hasAuthSessionState()
hasAuthSessionState
in interface DiameterShBaseMessage
AuthSessionState getAuthSessionState()
getAuthSessionState
in interface DiameterShBaseMessage
void setAuthSessionState(AuthSessionState authSessionState)
setAuthSessionState
in interface DiameterShBaseMessage
java.lang.NullPointerException
- if authSessionState
is null
.void removeAuthSessionState()
boolean hasOriginHost()
DiameterIdentity getOriginHost()
getOriginHost
in interface DiameterMessage
void setOriginHost(DiameterIdentity originHost)
setOriginHost
in interface DiameterMessage
java.lang.NullPointerException
- if originHost
is null
.void removeOriginHost()
boolean hasOriginRealm()
DiameterIdentity getOriginRealm()
getOriginRealm
in interface DiameterMessage
void setOriginRealm(DiameterIdentity originRealm)
setOriginRealm
in interface DiameterMessage
java.lang.NullPointerException
- if originRealm
is null
.void removeOriginRealm()
boolean hasDestinationHost()
DiameterIdentity getDestinationHost()
getDestinationHost
in interface DiameterMessage
void setDestinationHost(DiameterIdentity destinationHost)
setDestinationHost
in interface DiameterMessage
java.lang.NullPointerException
- if destinationHost
is null
.void removeDestinationHost()
boolean hasDestinationRealm()
DiameterIdentity getDestinationRealm()
getDestinationRealm
in interface DiameterMessage
void setDestinationRealm(DiameterIdentity destinationRealm)
setDestinationRealm
in interface DiameterMessage
java.lang.NullPointerException
- if destinationRealm
is null
.void removeDestinationRealm()
SupportedFeatures[] getSupportedFeatureses()
getSupportedFeatureses
in interface DiameterShMessage
void setSupportedFeatures(SupportedFeatures supportedFeatures)
setSupportedFeatures
in interface DiameterShMessage
java.lang.NullPointerException
- if supportedFeatures
is null
.void setSupportedFeatureses(SupportedFeatures[] supportedFeatureses)
setSupportedFeatureses
in interface DiameterShMessage
java.lang.NullPointerException
- if supportedFeatureses
is null
.void removeSupportedFeatureses()
boolean hasUserIdentity()
UserIdentity getUserIdentity()
void setUserIdentity(UserIdentity userIdentity)
java.lang.NullPointerException
- if userIdentity
is null
.void removeUserIdentity()
boolean hasWildcardedPublicIdentity()
java.lang.String getWildcardedPublicIdentity()
void setWildcardedPublicIdentity(java.lang.String wildcardedPublicIdentity)
java.lang.NullPointerException
- if wildcardedPublicIdentity
is null
.void removeWildcardedPublicIdentity()
boolean hasWildcardedImpu()
java.lang.String getWildcardedImpu()
void setWildcardedImpu(java.lang.String wildcardedImpu)
java.lang.NullPointerException
- if wildcardedImpu
is null
.void removeWildcardedImpu()
byte[][] getServiceIndications()
void setServiceIndication(byte[] serviceIndication)
java.lang.NullPointerException
- if serviceIndication
is null
.void setServiceIndications(byte[][] serviceIndications)
java.lang.NullPointerException
- if serviceIndications
is null
.void removeServiceIndications()
boolean hasSendDataIndication()
SendDataIndication getSendDataIndication()
void setSendDataIndication(SendDataIndication sendDataIndication)
java.lang.NullPointerException
- if sendDataIndication
is null
.void removeSendDataIndication()
boolean hasServerName()
java.lang.String getServerName()
void setServerName(java.lang.String serverName)
java.lang.NullPointerException
- if serverName
is null
.void removeServerName()
boolean hasSubsReqType()
SubsReqType getSubsReqType()
void setSubsReqType(SubsReqType subsReqType)
java.lang.NullPointerException
- if subsReqType
is null
.void removeSubsReqType()
DataReference[] getDataReferences()
void setDataReference(DataReference dataReference)
java.lang.NullPointerException
- if dataReference
is null
.void setDataReferences(DataReference[] dataReferences)
java.lang.NullPointerException
- if dataReferences
is null
.void removeDataReferences()
IdentitySet[] getIdentitySets()
void setIdentitySet(IdentitySet identitySet)
java.lang.NullPointerException
- if identitySet
is null
.void setIdentitySets(IdentitySet[] identitySets)
java.lang.NullPointerException
- if identitySets
is null
.void removeIdentitySets()
boolean hasExpiryTime()
java.util.Date getExpiryTime()
void setExpiryTime(java.util.Date expiryTime)
java.lang.NullPointerException
- if expiryTime
is null
.void removeExpiryTime()
byte[][] getDsaiTags()
void setDsaiTag(byte[] dsaiTag)
java.lang.NullPointerException
- if dsaiTag
is null
.void setDsaiTags(byte[][] dsaiTags)
java.lang.NullPointerException
- if dsaiTags
is null
.void removeDsaiTags()
boolean hasOneTimeNotification()
OneTimeNotification getOneTimeNotification()
void setOneTimeNotification(OneTimeNotification oneTimeNotification)
java.lang.NullPointerException
- if oneTimeNotification
is null
.void removeOneTimeNotification()
boolean hasUserName()
java.lang.String getUserName()
void setUserName(java.lang.String userName)
java.lang.NullPointerException
- if userName
is null
.void removeUserName()
boolean hasOcSupportedFeatures()
OcSupportedFeatures getOcSupportedFeatures()
void setOcSupportedFeatures(OcSupportedFeatures ocSupportedFeatures)
java.lang.NullPointerException
- if ocSupportedFeatures
is null
.void removeOcSupportedFeatures()
ProxyInfo[] getProxyInfos()
getProxyInfos
in interface DiameterShBaseMessage
void setProxyInfo(ProxyInfo proxyInfo)
setProxyInfo
in interface DiameterShBaseMessage
java.lang.NullPointerException
- if proxyInfo
is null
.void setProxyInfos(ProxyInfo[] proxyInfos)
setProxyInfos
in interface DiameterShBaseMessage
java.lang.NullPointerException
- if proxyInfos
is null
.void removeProxyInfos()
DiameterIdentity[] getRouteRecords()
getRouteRecords
in interface DiameterShBaseMessage
void setRouteRecord(DiameterIdentity routeRecord)
setRouteRecord
in interface DiameterShBaseMessage
java.lang.NullPointerException
- if routeRecord
is null
.void setRouteRecords(DiameterIdentity[] routeRecords)
setRouteRecords
in interface DiameterShBaseMessage
java.lang.NullPointerException
- if routeRecords
is null
.void removeRouteRecords()
DiameterAvp[] getExtensionAvps()
getExtensionAvps
in interface DiameterShBaseMessage
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
setExtensionAvps
in interface DiameterShBaseMessage
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
.void removeExtensionAvps()