public interface ReAuthRequest extends DiameterMessage
5.6.4 Re-Auth-Request (RAR) Command The RAR command, indicated by the Command-Code field set to 258 and the 'R' bit set in the Command Flags field, is sent by the PCRF to the BBERF/PCEF in order to provision QoS/PCC rules using the PUSH procedure initiate the provision of unsolicited QoS/PCC rules. It is used to provision QoS/PCC rules, event triggers and event report indications for the session. If the PCRF performs the bearer binding, PCC rules will be provisioned at bearer level. Message Format: <Re-Auth-Request> ::= < Diameter Header: 258, REQ, PXY > < Session-Id > { Auth-Application-Id } { Origin-Host } { Origin-Realm } { Destination-Realm } { Destination-Host } { Re-Auth-Request-Type } [ Session-Release-Cause ] [ Origin-State-Id ] *[ Event-Trigger ] [ Event-Report-Indication ] *[ Charging-Rule-Remove ] *[ Charging-Rule-Install ] [ Default-EPS-Bearer-QoS ] *[ QoS-Information ] [ Revalidation-Time ] *[ Usage-Monitoring-Information ] *[ Proxy-Info ] *[ Route-Record ] *[ AVP]
Modifier and Type | Field and Description |
---|---|
static int |
commandCode |
Modifier and Type | Method and Description |
---|---|
long |
getAuthApplicationId()
Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
|
ChargingRuleInstall[] |
getChargingRuleInstalls()
Returns the set of Charging-Rule-Install AVPs.
|
ChargingRuleRemove[] |
getChargingRuleRemoves()
Returns the set of Charging-Rule-Remove AVPs.
|
DefaultEpsBearerQos |
getDefaultEpsBearerQos()
Returns the value of the Default-EPS-Bearer-QoS AVP, of type Grouped.
|
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.
|
EventReportIndication |
getEventReportIndication()
Returns the value of the Event-Report-Indication AVP, of type Grouped.
|
EventTrigger[] |
getEventTriggers()
Returns the set of Event-Trigger AVPs.
|
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.
|
long |
getOriginStateId()
Returns the value of the Origin-State-Id AVP, of type Unsigned32.
|
ProxyInfo[] |
getProxyInfos()
Returns the set of Proxy-Info AVPs.
|
QosInformation[] |
getQosInformations()
Returns the set of QoS-Information AVPs.
|
ReAuthRequestType |
getReAuthRequestType()
Returns the value of the Re-Auth-Request-Type AVP, of type Enumerated.
|
java.util.Date |
getRevalidationTime()
Returns the value of the Revalidation-Time AVP, of type Time.
|
DiameterIdentity[] |
getRouteRecords()
Returns the set of Route-Record AVPs.
|
java.lang.String |
getSessionId()
Returns the value of the Session-Id AVP, of type UTF8String.
|
SessionReleaseCause |
getSessionReleaseCause()
Returns the value of the Session-Release-Cause AVP, of type Enumerated.
|
UsageMonitoringInformation[] |
getUsageMonitoringInformations()
Returns the set of Usage-Monitoring-Information AVPs.
|
boolean |
hasAuthApplicationId()
Returns true if the Auth-Application-Id AVP is present in the message.
|
boolean |
hasDefaultEpsBearerQos()
Returns true if the Default-EPS-Bearer-QoS 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 |
hasEventReportIndication()
Returns true if the Event-Report-Indication 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 |
hasReAuthRequestType()
Returns true if the Re-Auth-Request-Type AVP is present in the message.
|
boolean |
hasRevalidationTime()
Returns true if the Revalidation-Time AVP is present in the message.
|
boolean |
hasSessionId()
Returns true if the Session-Id AVP is present in the message.
|
boolean |
hasSessionReleaseCause()
Returns true if the Session-Release-Cause AVP is present in the message.
|
void |
removeAuthApplicationId()
Removes the Auth-Application-Id AVP from the message.
|
void |
removeChargingRuleInstalls()
Removes all Charging-Rule-Install AVPs from the message.
|
void |
removeChargingRuleRemoves()
Removes all Charging-Rule-Remove AVPs from the message.
|
void |
removeDefaultEpsBearerQos()
Removes the Default-EPS-Bearer-QoS 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 |
removeEventReportIndication()
Removes the Event-Report-Indication AVP from the message.
|
void |
removeEventTriggers()
Removes all Event-Trigger AVPs 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 |
removeOriginStateId()
Removes the Origin-State-Id AVP from the message.
|
void |
removeProxyInfos()
Removes all Proxy-Info AVPs from the message.
|
void |
removeQosInformations()
Removes all QoS-Information AVPs from the message.
|
void |
removeReAuthRequestType()
Removes the Re-Auth-Request-Type AVP from the message.
|
void |
removeRevalidationTime()
Removes the Revalidation-Time 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 |
removeSessionReleaseCause()
Removes the Session-Release-Cause AVP from the message.
|
void |
removeUsageMonitoringInformations()
Removes all Usage-Monitoring-Information AVPs from the message.
|
void |
setAuthApplicationId(long authApplicationId)
Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
|
void |
setChargingRuleInstall(ChargingRuleInstall chargingRuleInstall)
Sets a single Charging-Rule-Install AVP in the message, of type Grouped.
|
void |
setChargingRuleInstalls(ChargingRuleInstall[] chargingRuleInstalls)
Sets the set of Charging-Rule-Install AVPs, with all the values in the given array.
|
void |
setChargingRuleRemove(ChargingRuleRemove chargingRuleRemove)
Sets a single Charging-Rule-Remove AVP in the message, of type Grouped.
|
void |
setChargingRuleRemoves(ChargingRuleRemove[] chargingRuleRemoves)
Sets the set of Charging-Rule-Remove AVPs, with all the values in the given array.
|
void |
setDefaultEpsBearerQos(DefaultEpsBearerQos defaultEpsBearerQos)
Sets the value of the Default-EPS-Bearer-QoS AVP, of type Grouped.
|
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 |
setEventReportIndication(EventReportIndication eventReportIndication)
Sets the value of the Event-Report-Indication AVP, of type Grouped.
|
void |
setEventTrigger(EventTrigger eventTrigger)
Sets a single Event-Trigger AVP in the message, of type Enumerated.
|
void |
setEventTriggers(EventTrigger[] eventTriggers)
Sets the set of Event-Trigger AVPs, with all the values in the given array.
|
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 |
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 |
setQosInformation(QosInformation qosInformation)
Sets a single QoS-Information AVP in the message, of type Grouped.
|
void |
setQosInformations(QosInformation[] qosInformations)
Sets the set of QoS-Information AVPs, with all the values in the given array.
|
void |
setReAuthRequestType(ReAuthRequestType reAuthRequestType)
Sets the value of the Re-Auth-Request-Type AVP, of type Enumerated.
|
void |
setRevalidationTime(java.util.Date revalidationTime)
Sets the value of the Revalidation-Time AVP, of type Time.
|
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 |
setSessionReleaseCause(SessionReleaseCause sessionReleaseCause)
Sets the value of the Session-Release-Cause AVP, of type Enumerated.
|
void |
setUsageMonitoringInformation(UsageMonitoringInformation usageMonitoringInformation)
Sets a single Usage-Monitoring-Information AVP in the message, of type Grouped.
|
void |
setUsageMonitoringInformations(UsageMonitoringInformation[] usageMonitoringInformations)
Sets the set of Usage-Monitoring-Information AVPs, with all the values in the given array.
|
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 hasAuthApplicationId()
long getAuthApplicationId()
hasAuthApplicationId()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Auth-Application-Id AVP has not been set on this messagevoid setAuthApplicationId(long authApplicationId)
void removeAuthApplicationId()
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 hasDestinationRealm()
DiameterIdentity getDestinationRealm()
getDestinationRealm
in interface DiameterMessage
void setDestinationRealm(DiameterIdentity destinationRealm)
setDestinationRealm
in interface DiameterMessage
java.lang.NullPointerException
- if destinationRealm
is null
.void removeDestinationRealm()
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 hasReAuthRequestType()
ReAuthRequestType getReAuthRequestType()
void setReAuthRequestType(ReAuthRequestType reAuthRequestType)
java.lang.NullPointerException
- if reAuthRequestType
is null
.void removeReAuthRequestType()
boolean hasSessionReleaseCause()
SessionReleaseCause getSessionReleaseCause()
void setSessionReleaseCause(SessionReleaseCause sessionReleaseCause)
java.lang.NullPointerException
- if sessionReleaseCause
is null
.void removeSessionReleaseCause()
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()
EventTrigger[] getEventTriggers()
void setEventTrigger(EventTrigger eventTrigger)
java.lang.NullPointerException
- if eventTrigger
is null
.void setEventTriggers(EventTrigger[] eventTriggers)
java.lang.NullPointerException
- if eventTriggers
is null
.void removeEventTriggers()
boolean hasEventReportIndication()
EventReportIndication getEventReportIndication()
void setEventReportIndication(EventReportIndication eventReportIndication)
java.lang.NullPointerException
- if eventReportIndication
is null
.void removeEventReportIndication()
ChargingRuleRemove[] getChargingRuleRemoves()
void setChargingRuleRemove(ChargingRuleRemove chargingRuleRemove)
java.lang.NullPointerException
- if chargingRuleRemove
is null
.void setChargingRuleRemoves(ChargingRuleRemove[] chargingRuleRemoves)
java.lang.NullPointerException
- if chargingRuleRemoves
is null
.void removeChargingRuleRemoves()
ChargingRuleInstall[] getChargingRuleInstalls()
void setChargingRuleInstall(ChargingRuleInstall chargingRuleInstall)
java.lang.NullPointerException
- if chargingRuleInstall
is null
.void setChargingRuleInstalls(ChargingRuleInstall[] chargingRuleInstalls)
java.lang.NullPointerException
- if chargingRuleInstalls
is null
.void removeChargingRuleInstalls()
boolean hasDefaultEpsBearerQos()
DefaultEpsBearerQos getDefaultEpsBearerQos()
void setDefaultEpsBearerQos(DefaultEpsBearerQos defaultEpsBearerQos)
java.lang.NullPointerException
- if defaultEpsBearerQos
is null
.void removeDefaultEpsBearerQos()
QosInformation[] getQosInformations()
void setQosInformation(QosInformation qosInformation)
java.lang.NullPointerException
- if qosInformation
is null
.void setQosInformations(QosInformation[] qosInformations)
java.lang.NullPointerException
- if qosInformations
is null
.void removeQosInformations()
boolean hasRevalidationTime()
java.util.Date getRevalidationTime()
void setRevalidationTime(java.util.Date revalidationTime)
java.lang.NullPointerException
- if revalidationTime
is null
.void removeRevalidationTime()
UsageMonitoringInformation[] getUsageMonitoringInformations()
void setUsageMonitoringInformation(UsageMonitoringInformation usageMonitoringInformation)
java.lang.NullPointerException
- if usageMonitoringInformation
is null
.void setUsageMonitoringInformations(UsageMonitoringInformation[] usageMonitoringInformations)
java.lang.NullPointerException
- if usageMonitoringInformations
is null
.void removeUsageMonitoringInformations()
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()
DiameterIdentity[] getRouteRecords()
void setRouteRecord(DiameterIdentity routeRecord)
java.lang.NullPointerException
- if routeRecord
is null
.void setRouteRecords(DiameterIdentity[] routeRecords)
java.lang.NullPointerException
- if routeRecords
is null
.void removeRouteRecords()
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()