public interface ReAuthAnswer extends DiameterMessage
5.6.5 Re-Auth-Answer (RAA) Command The RAA command, indicated by the Command-Code field set to 258 and the 'R' bit cleared in the Command Flags field, is sent by the PCEF to the PCRF in response to the RAR command. Message Format: <Re-Auth-Answer> ::= < Diameter Header: 258, PXY > < Session-Id > { Origin-Host } { Origin-Realm } [ Result-Code ] [ Experimental-Result ] [ Origin-State-Id ] [ IP-CAN-Type ] [ RAT-Type ] 0*2 [ AN-GW-Address ] [ TGPP-SGSN-MCC-MNC ] [ TGPP-SGSN-Address ] [ TGPP-SGSN-IPv6-Address ] [ RAI ] [ TGPP-User-Location-Info ] [ TGPP-MS-TimeZone ] * [ Charging-Rule-Report] [ Error-Message ] [ Error-Reporting-Host ] * [ Failed-AVP ] * [ Proxy-Info ] * [ AVP ]
Modifier and Type | Field and Description |
---|---|
static int |
commandCode |
Modifier and Type | Method and Description |
---|---|
Address[] |
getAnGwAddresses()
Returns the set of AN-GW-Address AVPs.
|
ChargingRuleReport[] |
getChargingRuleReports()
Returns the set of Charging-Rule-Report AVPs.
|
java.lang.String |
getErrorMessage()
Returns the value of the Error-Message AVP, of type UTF8String.
|
DiameterIdentity |
getErrorReportingHost()
Returns the value of the Error-Reporting-Host AVP, of type DiameterIdentity.
|
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.
|
IpCanType |
getIpCanType()
Returns the value of the IP-CAN-Type 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.
|
long |
getOriginStateId()
Returns the value of the Origin-State-Id AVP, of type Unsigned32.
|
ProxyInfo[] |
getProxyInfos()
Returns the set of Proxy-Info AVPs.
|
java.lang.String |
getRai()
Returns the value of the RAI AVP, of type UTF8String.
|
RatType |
getRatType()
Returns the value of the RAT-Type AVP, of type Enumerated.
|
long |
getResultCode()
Returns the value of the Result-Code AVP, of type Unsigned32.
|
java.lang.String |
getSessionId()
Returns the value of the Session-Id AVP, of type UTF8String.
|
byte[] |
getTgppMsTimezone()
Returns the value of the TGPP-MS-TimeZone AVP, of type OctetString.
|
byte[] |
getTgppSgsnAddress()
Returns the value of the TGPP-SGSN-Address AVP, of type OctetString.
|
byte[] |
getTgppSgsnIpv6Address()
Returns the value of the TGPP-SGSN-IPv6-Address AVP, of type OctetString.
|
java.lang.String |
getTgppSgsnMccMnc()
Returns the value of the TGPP-SGSN-MCC-MNC AVP, of type UTF8String.
|
byte[] |
getTgppUserLocationInfo()
Returns the value of the TGPP-User-Location-Info AVP, of type OctetString.
|
boolean |
hasErrorMessage()
Returns true if the Error-Message AVP is present in the message.
|
boolean |
hasErrorReportingHost()
Returns true if the Error-Reporting-Host AVP is present in the message.
|
boolean |
hasExperimentalResult()
Returns true if the Experimental-Result AVP is present in the message.
|
boolean |
hasIpCanType()
Returns true if the IP-CAN-Type 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 |
hasOriginStateId()
Returns true if the Origin-State-Id AVP is present in the message.
|
boolean |
hasRai()
Returns true if the RAI AVP is present in the message.
|
boolean |
hasRatType()
Returns true if the RAT-Type 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 |
hasTgppMsTimezone()
Returns true if the TGPP-MS-TimeZone AVP is present in the message.
|
boolean |
hasTgppSgsnAddress()
Returns true if the TGPP-SGSN-Address AVP is present in the message.
|
boolean |
hasTgppSgsnIpv6Address()
Returns true if the TGPP-SGSN-IPv6-Address AVP is present in the message.
|
boolean |
hasTgppSgsnMccMnc()
Returns true if the TGPP-SGSN-MCC-MNC AVP is present in the message.
|
boolean |
hasTgppUserLocationInfo()
Returns true if the TGPP-User-Location-Info AVP is present in the message.
|
void |
removeAnGwAddresses()
Removes all AN-GW-Address AVPs from the message.
|
void |
removeChargingRuleReports()
Removes all Charging-Rule-Report AVPs from the message.
|
void |
removeErrorMessage()
Removes the Error-Message AVP from the message.
|
void |
removeErrorReportingHost()
Removes the Error-Reporting-Host 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 |
removeIpCanType()
Removes the IP-CAN-Type 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 |
removeOriginStateId()
Removes the Origin-State-Id AVP from the message.
|
void |
removeProxyInfos()
Removes all Proxy-Info AVPs from the message.
|
void |
removeRai()
Removes the RAI AVP from the message.
|
void |
removeRatType()
Removes the RAT-Type AVP from the message.
|
void |
removeResultCode()
Removes the Result-Code AVP from the message.
|
void |
removeSessionId()
Removes the Session-Id AVP from the message.
|
void |
removeTgppMsTimezone()
Removes the TGPP-MS-TimeZone AVP from the message.
|
void |
removeTgppSgsnAddress()
Removes the TGPP-SGSN-Address AVP from the message.
|
void |
removeTgppSgsnIpv6Address()
Removes the TGPP-SGSN-IPv6-Address AVP from the message.
|
void |
removeTgppSgsnMccMnc()
Removes the TGPP-SGSN-MCC-MNC AVP from the message.
|
void |
removeTgppUserLocationInfo()
Removes the TGPP-User-Location-Info AVP from the message.
|
void |
setAnGwAddress(Address anGwAddress)
Sets a single AN-GW-Address AVP in the message, of type Address.
|
void |
setAnGwAddresses(Address[] anGwAddresses)
Sets the set of AN-GW-Address AVPs, with all the values in the given array.
|
void |
setChargingRuleReport(ChargingRuleReport chargingRuleReport)
Sets a single Charging-Rule-Report AVP in the message, of type Grouped.
|
void |
setChargingRuleReports(ChargingRuleReport[] chargingRuleReports)
Sets the set of Charging-Rule-Report AVPs, with all the values in the given array.
|
void |
setErrorMessage(java.lang.String errorMessage)
Sets the value of the Error-Message AVP, of type UTF8String.
|
void |
setErrorReportingHost(DiameterIdentity errorReportingHost)
Sets the value of the Error-Reporting-Host AVP, of type DiameterIdentity.
|
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 |
setIpCanType(IpCanType ipCanType)
Sets the value of the IP-CAN-Type 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 |
setOriginStateId(long originStateId)
Sets the value of the Origin-State-Id AVP, of type Unsigned32.
|
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 |
setRai(java.lang.String rai)
Sets the value of the RAI AVP, of type UTF8String.
|
void |
setRatType(RatType ratType)
Sets the value of the RAT-Type AVP, of type Enumerated.
|
void |
setResultCode(long resultCode)
Sets the value of the Result-Code AVP, of type Unsigned32.
|
void |
setSessionId(java.lang.String sessionId)
Sets the value of the Session-Id AVP, of type UTF8String.
|
void |
setTgppMsTimezone(byte[] tgppMsTimezone)
Sets the value of the TGPP-MS-TimeZone AVP, of type OctetString.
|
void |
setTgppSgsnAddress(byte[] tgppSgsnAddress)
Sets the value of the TGPP-SGSN-Address AVP, of type OctetString.
|
void |
setTgppSgsnIpv6Address(byte[] tgppSgsnIpv6Address)
Sets the value of the TGPP-SGSN-IPv6-Address AVP, of type OctetString.
|
void |
setTgppSgsnMccMnc(java.lang.String tgppSgsnMccMnc)
Sets the value of the TGPP-SGSN-MCC-MNC AVP, of type UTF8String.
|
void |
setTgppUserLocationInfo(byte[] tgppUserLocationInfo)
Sets the value of the TGPP-User-Location-Info AVP, of type OctetString.
|
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 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 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 hasOriginStateId()
long getOriginStateId()
hasOriginStateId()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Origin-State-Id AVP has not been set on this messagevoid setOriginStateId(long originStateId)
void removeOriginStateId()
boolean hasIpCanType()
IpCanType getIpCanType()
void setIpCanType(IpCanType ipCanType)
java.lang.NullPointerException
- if ipCanType
is null
.void removeIpCanType()
boolean hasRatType()
RatType getRatType()
void setRatType(RatType ratType)
java.lang.NullPointerException
- if ratType
is null
.void removeRatType()
Address[] getAnGwAddresses()
void setAnGwAddress(Address anGwAddress)
java.lang.NullPointerException
- if anGwAddress
is null
.void setAnGwAddresses(Address[] anGwAddresses)
java.lang.NullPointerException
- if anGwAddresses
is null
.void removeAnGwAddresses()
boolean hasTgppSgsnMccMnc()
java.lang.String getTgppSgsnMccMnc()
void setTgppSgsnMccMnc(java.lang.String tgppSgsnMccMnc)
java.lang.NullPointerException
- if tgppSgsnMccMnc
is null
.void removeTgppSgsnMccMnc()
boolean hasTgppSgsnAddress()
byte[] getTgppSgsnAddress()
void setTgppSgsnAddress(byte[] tgppSgsnAddress)
java.lang.NullPointerException
- if tgppSgsnAddress
is null
.void removeTgppSgsnAddress()
boolean hasTgppSgsnIpv6Address()
byte[] getTgppSgsnIpv6Address()
void setTgppSgsnIpv6Address(byte[] tgppSgsnIpv6Address)
java.lang.NullPointerException
- if tgppSgsnIpv6Address
is null
.void removeTgppSgsnIpv6Address()
boolean hasRai()
java.lang.String getRai()
void setRai(java.lang.String rai)
java.lang.NullPointerException
- if rai
is null
.void removeRai()
boolean hasTgppUserLocationInfo()
byte[] getTgppUserLocationInfo()
void setTgppUserLocationInfo(byte[] tgppUserLocationInfo)
java.lang.NullPointerException
- if tgppUserLocationInfo
is null
.void removeTgppUserLocationInfo()
boolean hasTgppMsTimezone()
byte[] getTgppMsTimezone()
void setTgppMsTimezone(byte[] tgppMsTimezone)
java.lang.NullPointerException
- if tgppMsTimezone
is null
.void removeTgppMsTimezone()
ChargingRuleReport[] getChargingRuleReports()
void setChargingRuleReport(ChargingRuleReport chargingRuleReport)
java.lang.NullPointerException
- if chargingRuleReport
is null
.void setChargingRuleReports(ChargingRuleReport[] chargingRuleReports)
java.lang.NullPointerException
- if chargingRuleReports
is null
.void removeChargingRuleReports()
boolean hasErrorMessage()
java.lang.String getErrorMessage()
void setErrorMessage(java.lang.String errorMessage)
java.lang.NullPointerException
- if errorMessage
is null
.void removeErrorMessage()
boolean hasErrorReportingHost()
DiameterIdentity getErrorReportingHost()
void setErrorReportingHost(DiameterIdentity errorReportingHost)
java.lang.NullPointerException
- if errorReportingHost
is null
.void removeErrorReportingHost()
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()
void setProxyInfo(ProxyInfo proxyInfo)
java.lang.NullPointerException
- if proxyInfo
is null
.void setProxyInfos(ProxyInfo[] proxyInfos)
java.lang.NullPointerException
- if proxyInfos
is null
.void removeProxyInfos()
DiameterAvp[] getExtensionAvps()
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
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()