public interface PushNotificationAnswer extends DiameterShMessage
6.1.8 Push-Notification-Answer (PNA) Command The Push-Notifications-Answer (PNA) command, indicated by the Command-Code field set to 309 and the 'R' bit cleared in the Command Flags field, is sent by a client in response to the Push-Notification-Request command. The Experimental-Result AVP may contain one of the values defined in section 6.2 or in 3GPP TS 29.229 [6]. Message Format < Push-Notification-Answer > ::=< Diameter Header: 309, PXY, 16777217 > < Session-Id > { Vendor-Specific-Application-Id } [ Result-Code ] [ Experimental-Result ] { Auth-Session-State } { Origin-Host } { Origin-Realm } *[ Supported-Features ] *[ AVP ] *[ Failed-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.
|
ExperimentalResult |
getExperimentalResult()
Returns the value of the Experimental-Result AVP, of type Grouped.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
FailedAvp[] |
getFailedAvps()
Returns the set of Failed-AVP 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.
|
long |
getResultCode()
Returns the value of the Result-Code AVP, of type Unsigned32.
|
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.
|
VendorSpecificApplicationId |
getVendorSpecificApplicationId()
Returns the value of the Vendor-Specific-Application-Id AVP, of type Grouped.
|
boolean |
hasAuthSessionState()
Returns true if the Auth-Session-State AVP is present in the message.
|
boolean |
hasExperimentalResult()
Returns true if the Experimental-Result 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 |
hasResultCode()
Returns true if the Result-Code AVP is present in the message.
|
boolean |
hasSessionId()
Returns true if the Session-Id AVP is present in the message.
|
boolean |
hasVendorSpecificApplicationId()
Returns true if the Vendor-Specific-Application-Id AVP is present in the message.
|
void |
removeAuthSessionState()
Removes the Auth-Session-State AVP from the message.
|
void |
removeExperimentalResult()
Removes the Experimental-Result AVP from the message.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the message.
|
void |
removeFailedAvps()
Removes all Failed-AVP 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 |
removeResultCode()
Removes the Result-Code AVP 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 |
removeVendorSpecificApplicationId()
Removes the Vendor-Specific-Application-Id AVP from the message.
|
void |
setAuthSessionState(AuthSessionState authSessionState)
Sets the value of the Auth-Session-State AVP, of type Enumerated.
|
void |
setExperimentalResult(ExperimentalResult experimentalResult)
Sets the value of the Experimental-Result AVP, of type Grouped.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setFailedAvp(FailedAvp failedAvp)
Sets a single Failed-AVP AVP in the message, of type Grouped.
|
void |
setFailedAvps(FailedAvp[] failedAvps)
Sets the set of Failed-AVP 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 |
setResultCode(long resultCode)
Sets the value of the Result-Code AVP, of type Unsigned32.
|
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 |
setVendorSpecificApplicationId(VendorSpecificApplicationId vendorSpecificApplicationId)
Sets the value of the Vendor-Specific-Application-Id AVP, of type Grouped.
|
clone, getAvps, getCommand, getDestinationHost, getDestinationRealm, getHeader, setDestinationHost, setDestinationRealm
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 hasResultCode()
long getResultCode()
hasResultCode()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Result-Code AVP has not been set on this messagevoid setResultCode(long resultCode)
void removeResultCode()
boolean hasExperimentalResult()
ExperimentalResult getExperimentalResult()
void setExperimentalResult(ExperimentalResult experimentalResult)
java.lang.NullPointerException
- if experimentalResult
is null
.void removeExperimentalResult()
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()
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()
FailedAvp[] getFailedAvps()
void setFailedAvp(FailedAvp failedAvp)
java.lang.NullPointerException
- if failedAvp
is null
.void setFailedAvps(FailedAvp[] failedAvps)
java.lang.NullPointerException
- if failedAvps
is null
.void removeFailedAvps()
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()