public interface PushNotificationRequest extends DiameterShMessage
6.1.7 Push-Notification-Request (PNR) Command The Push-Notification-Request (PNR) command, indicated by the Command-Code field set to 309 and the 'R' bit set in the Command Flags field, is sent by a Diameter server to a Diameter client in order to notify changes in the user data in the server. Message Format < Push-Notification-Request > ::= < Diameter Header: 309, 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-PSI ] { User-Data } *[ 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.
|
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.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
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.
|
java.lang.String |
getSessionId()
Returns the value of the Session-Id AVP, of type UTF8String.
|
SupportedFeatures[] |
getSupportedFeatureses()
Returns the set of Supported-Features AVPs.
|
UserData |
getUserData()
Returns the value of the User-Data AVP, of type UserData.
|
UserIdentity |
getUserIdentity()
Returns the value of the User-Identity AVP, of type Grouped.
|
VendorSpecificApplicationId |
getVendorSpecificApplicationId()
Returns the value of the Vendor-Specific-Application-Id AVP, of type Grouped.
|
java.lang.String |
getWildcardedPsi()
Returns the value of the Wildcarded-PSI 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 |
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 |
hasSessionId()
Returns true if the Session-Id AVP is present in the message.
|
boolean |
hasUserData()
Returns true if the User-Data AVP is present in the message.
|
boolean |
hasUserIdentity()
Returns true if the User-Identity AVP is present in the message.
|
boolean |
hasVendorSpecificApplicationId()
Returns true if the Vendor-Specific-Application-Id AVP is present in the message.
|
boolean |
hasWildcardedPsi()
Returns true if the Wildcarded-PSI AVP is present in the message.
|
void |
removeAuthSessionState()
Removes the Auth-Session-State AVP from the message.
|
void |
removeDestinationHost()
Removes the Destination-Host AVP from the message.
|
void |
removeDestinationRealm()
Removes the Destination-Realm AVP from the message.
|
void |
removeExtensionAvps()
Removes all extension AVPs 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 |
removeSessionId()
Removes the Session-Id AVP from the message.
|
void |
removeSupportedFeatureses()
Removes all Supported-Features AVPs from the message.
|
void |
removeUserData()
Removes the User-Data AVP from the message.
|
void |
removeUserIdentity()
Removes the User-Identity AVP from the message.
|
void |
removeVendorSpecificApplicationId()
Removes the Vendor-Specific-Application-Id AVP from the message.
|
void |
removeWildcardedPsi()
Removes the Wildcarded-PSI AVP from the message.
|
void |
setAuthSessionState(AuthSessionState authSessionState)
Sets the value of the Auth-Session-State AVP, of type Enumerated.
|
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 |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
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 |
setSessionId(java.lang.String sessionId)
Sets the value of the Session-Id AVP, of type UTF8String.
|
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 |
setUserData(UserData userData)
Sets the value of the User-Data AVP, of type UserData.
|
void |
setUserIdentity(UserIdentity userIdentity)
Sets the value of the User-Identity AVP, of type Grouped.
|
void |
setVendorSpecificApplicationId(VendorSpecificApplicationId vendorSpecificApplicationId)
Sets the value of the Vendor-Specific-Application-Id AVP, of type Grouped.
|
void |
setWildcardedPsi(java.lang.String wildcardedPsi)
Sets the value of the Wildcarded-PSI 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 hasWildcardedPsi()
java.lang.String getWildcardedPsi()
void setWildcardedPsi(java.lang.String wildcardedPsi)
java.lang.NullPointerException
- if wildcardedPsi
is null
.void removeWildcardedPsi()
boolean hasUserData()
UserData getUserData()
void setUserData(UserData userData)
java.lang.NullPointerException
- if userData
is null
.void removeUserData()
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()