Interface PushNotificationRequest
-
- All Superinterfaces:
Cloneable
,DiameterMessage
,DiameterShBaseMessage
,DiameterShMessage
public interface PushNotificationRequest extends DiameterShMessage
Defines an interface representing the Push-Notification-Request command. From the Diameter Sh Reference Point Protocol Details (3GPP TS 29.329 V8.8.0) specification: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 ] [ Wildcarded-IMPU ] { User-Data } *[ AVP ] *[ Proxy-Info ] *[ Route-Record ]
-
-
Field Summary
Fields Modifier and Type Field Description static int
commandCode
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.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.String
getWildcardedImpu()
Returns the value of the Wildcarded-IMPU AVP, of type UTF8String.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
hasWildcardedImpu()
Returns true if the Wildcarded-IMPU 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
removeWildcardedImpu()
Removes the Wildcarded-IMPU 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(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
setWildcardedImpu(String wildcardedImpu)
Sets the value of the Wildcarded-IMPU AVP, of type UTF8String.void
setWildcardedPsi(String wildcardedPsi)
Sets the value of the Wildcarded-PSI 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
String getSessionId()
Returns the value of the Session-Id AVP, of type UTF8String.- Specified by:
getSessionId
in interfaceDiameterMessage
- Returns:
- the value of the Session-Id AVP or null if it has not been set on this message
-
setSessionId
void setSessionId(String sessionId)
Sets the value of the Session-Id AVP, of type UTF8String.- Specified by:
setSessionId
in interfaceDiameterMessage
- Throws:
NullPointerException
- ifsessionId
isnull
.
-
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 interfaceDiameterShBaseMessage
-
getVendorSpecificApplicationId
VendorSpecificApplicationId getVendorSpecificApplicationId()
Returns the value of the Vendor-Specific-Application-Id AVP, of type Grouped.- Specified by:
getVendorSpecificApplicationId
in interfaceDiameterShBaseMessage
- 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 interfaceDiameterShBaseMessage
- Throws:
NullPointerException
- ifvendorSpecificApplicationId
isnull
.
-
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 interfaceDiameterShBaseMessage
-
getAuthSessionState
AuthSessionState getAuthSessionState()
Returns the value of the Auth-Session-State AVP, of type Enumerated.- Specified by:
getAuthSessionState
in interfaceDiameterShBaseMessage
- 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 interfaceDiameterShBaseMessage
- Throws:
NullPointerException
- ifauthSessionState
isnull
.
-
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 interfaceDiameterMessage
- 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 interfaceDiameterMessage
- Throws:
NullPointerException
- iforiginHost
isnull
.
-
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 interfaceDiameterMessage
- 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 interfaceDiameterMessage
- Throws:
NullPointerException
- iforiginRealm
isnull
.
-
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 interfaceDiameterMessage
- 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 interfaceDiameterMessage
- Throws:
NullPointerException
- ifdestinationHost
isnull
.
-
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 interfaceDiameterMessage
- 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 interfaceDiameterMessage
- Throws:
NullPointerException
- ifdestinationRealm
isnull
.
-
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 interfaceDiameterShMessage
-
setSupportedFeatures
void setSupportedFeatures(SupportedFeatures supportedFeatures)
Sets a single Supported-Features AVP in the message, of type Grouped.- Specified by:
setSupportedFeatures
in interfaceDiameterShMessage
- Throws:
NullPointerException
- ifsupportedFeatures
isnull
.
-
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 interfaceDiameterShMessage
- Throws:
NullPointerException
- ifsupportedFeatureses
isnull
.
-
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:
NullPointerException
- ifuserIdentity
isnull
.
-
removeUserIdentity
void removeUserIdentity()
Removes the User-Identity AVP from the message. If the User-Identity AVP is not present, this method returns silently.
-
hasWildcardedPsi
boolean hasWildcardedPsi()
Returns true if the Wildcarded-PSI AVP is present in the message.
-
getWildcardedPsi
String getWildcardedPsi()
Returns the value of the Wildcarded-PSI AVP, of type UTF8String.- Returns:
- the value of the Wildcarded-PSI AVP or null if it has not been set on this message
-
setWildcardedPsi
void setWildcardedPsi(String wildcardedPsi)
Sets the value of the Wildcarded-PSI AVP, of type UTF8String.- Throws:
NullPointerException
- ifwildcardedPsi
isnull
.
-
removeWildcardedPsi
void removeWildcardedPsi()
Removes the Wildcarded-PSI AVP from the message. If the Wildcarded-PSI 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
- ifwildcardedImpu
isnull
.
-
removeWildcardedImpu
void removeWildcardedImpu()
Removes the Wildcarded-IMPU AVP from the message. If the Wildcarded-IMPU AVP is not 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
- ifuserData
isnull
.
-
removeUserData
void removeUserData()
Removes the User-Data AVP from the message. If the User-Data 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 interfaceDiameterShBaseMessage
-
setProxyInfo
void setProxyInfo(ProxyInfo proxyInfo)
Sets a single Proxy-Info AVP in the message, of type Grouped.- Specified by:
setProxyInfo
in interfaceDiameterShBaseMessage
- Throws:
NullPointerException
- ifproxyInfo
isnull
.
-
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 interfaceDiameterShBaseMessage
- Throws:
NullPointerException
- ifproxyInfos
isnull
.
-
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 interfaceDiameterShBaseMessage
-
setRouteRecord
void setRouteRecord(DiameterIdentity routeRecord)
Sets a single Route-Record AVP in the message, of type DiameterIdentity.- Specified by:
setRouteRecord
in interfaceDiameterShBaseMessage
- Throws:
NullPointerException
- ifrouteRecord
isnull
.
-
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 interfaceDiameterShBaseMessage
- Throws:
NullPointerException
- ifrouteRecords
isnull
.
-
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 interfaceDiameterShBaseMessage
-
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 interfaceDiameterShBaseMessage
- 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
- ifavps
isnull
.
-
removeExtensionAvps
void removeExtensionAvps()
Removes all extension AVPs from the message. If no extension AVPs are present, this method returns silently.
-
-