public interface EventReportIndication extends GroupedAvp
5.3.30 Event-Report-Indication The Event-Report-Indication AVP (AVP code 1033) is of type Grouped. When sent from the PCRF to the PCEF, it is used to report an event coming from the Access Network GW (BBERF) and relevant info to the PCEF. When sent from the PCEF to the PCRF, it is used to provide the information about the required event triggers to the PCRF. Only Event-Trigger AVP will be supplied in this case. The PCEF may require adding new event triggers or removing the already provided ones. In order to do so, the PCEF shall provide the new complete list of applicable event triggers within the Event-Trigger AVP included in the Event-Report-Indication AVP to the PCRF. The PCEF may require removing all previously provided event triggers by providing the Event-Trigger AVP set to the value NO_EVENT_TRIGGERS included in the Event-Report-Indication AVP to the PCRF. If the event triggers required by the PCEF are associated with certain parameter values, the PCRF shall provide those values to the PCEF. Whenever the PCEF subscribes to an event report indication by using the CCR command, the PCRF shall only send the corresponding currently applicable values which have been updated (e.g. 3GPP-User-Location-Info, 3GPP2-BSID, etc.) to the PCEF in the CCA if available. In this case, the Event-Trigger AVPs shall not be included. NOTE: The PCRF can get the currently applicable values during the IP-CAN session establishment procedure or during the information reporting from the BBERF when the BBERF gets event subscription from the PCRF as defined in subclause 5.3.7. The PCEF may subscribe to different or common set of event triggers at different BBERFs by including the Routing-IP-Address AVP in the Event-Report-Indication AVP to the PCRF. The PCEF may provide the following Event-Trigger values to the PCRF: QOS_CHANGE, RAI_CHANGE, RAT_CHANGE, USER_LOCATION_CHANGE, UE_TIME_ZONE_CHANGE, USER_CSG_INFORMATION_CHANGE, USER_CSG_HYBRID_SUBSCRIBED_INFORMATION_CHANGE, USER_CSG_HYBRID_UNSUBSCRIBED_INFORMATION_CHANGE, TAI_CHANGE and ECGI_CHANGE. Event-Trigger value QOS_CHANGE shall be used to report a change in APN-Aggregate-Max-Bitrate-DL AVP and/or APN-Aggregate-Max-Bitrate-UL AVP included within the QoS-Information AVP. Applicability of the Event-Triggers to the different accesses is defined in clause 5.3.7. It has the following ABNF grammar: Event-Report-Indication ::= < AVP Header: 1033 > *[Event-Trigger] [User-CSG-Information] [IP-CAN-Type] 0*2[AN-GW-Address] [TGPP-SGSN-Address] [TGPP-SGSN-IPv6-Address] [TGPP-SGSN-MCC-MNC] [Framed-IP-Address] [RAT-Type] [QoS-Information] [RAI] [TGPP-User-Location-Info] [Trace-Data] [Trace-Reference] [TGPP2-BSID] [TGPP-MS-TimeZone] [Routing-IP-Address] *[AVP]
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
Address[] |
getAnGwAddresses()
Returns the set of AN-GW-Address AVPs.
|
EventTrigger[] |
getEventTriggers()
Returns the set of Event-Trigger AVPs.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
byte[] |
getFramedIpAddress()
Returns the value of the Framed-IP-Address AVP, of type OctetString.
|
IpCanType |
getIpCanType()
Returns the value of the IP-CAN-Type AVP, of type Enumerated.
|
QosInformation |
getQosInformation()
Returns the value of the QoS-Information AVP, of type Grouped.
|
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.
|
Address |
getRoutingIpAddress()
Returns the value of the Routing-IP-Address AVP, of type Address.
|
java.lang.String |
getTgpp2Bsid()
Returns the value of the TGPP2-BSID 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.
|
TraceData |
getTraceData()
Returns the value of the Trace-Data AVP, of type Grouped.
|
byte[] |
getTraceReference()
Returns the value of the Trace-Reference AVP, of type OctetString.
|
UserCsgInformation |
getUserCsgInformation()
Returns the value of the User-CSG-Information AVP, of type Grouped.
|
boolean |
hasFramedIpAddress()
Returns true if the Framed-IP-Address AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasIpCanType()
Returns true if the IP-CAN-Type AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasQosInformation()
Returns true if the QoS-Information AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasRai()
Returns true if the RAI AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasRatType()
Returns true if the RAT-Type AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasRoutingIpAddress()
Returns true if the Routing-IP-Address AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasTgpp2Bsid()
Returns true if the TGPP2-BSID AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasTgppMsTimezone()
Returns true if the TGPP-MS-TimeZone AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasTgppSgsnAddress()
Returns true if the TGPP-SGSN-Address AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasTgppSgsnIpv6Address()
Returns true if the TGPP-SGSN-IPv6-Address AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasTgppSgsnMccMnc()
Returns true if the TGPP-SGSN-MCC-MNC AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasTgppUserLocationInfo()
Returns true if the TGPP-User-Location-Info AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasTraceData()
Returns true if the Trace-Data AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasTraceReference()
Returns true if the Trace-Reference AVP is present in the Event-Report-Indication AVP.
|
boolean |
hasUserCsgInformation()
Returns true if the User-CSG-Information AVP is present in the Event-Report-Indication AVP.
|
void |
removeAnGwAddresses()
Removes all AN-GW-Address AVPs from the Event-Report-Indication AVP.
|
void |
removeEventTriggers()
Removes all Event-Trigger AVPs from the Event-Report-Indication AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the Event-Report-Indication AVP.
|
void |
removeFramedIpAddress()
Removes the Framed-IP-Address AVP from the Event-Report-Indication AVP.
|
void |
removeIpCanType()
Removes the IP-CAN-Type AVP from the Event-Report-Indication AVP.
|
void |
removeQosInformation()
Removes the QoS-Information AVP from the Event-Report-Indication AVP.
|
void |
removeRai()
Removes the RAI AVP from the Event-Report-Indication AVP.
|
void |
removeRatType()
Removes the RAT-Type AVP from the Event-Report-Indication AVP.
|
void |
removeRoutingIpAddress()
Removes the Routing-IP-Address AVP from the Event-Report-Indication AVP.
|
void |
removeTgpp2Bsid()
Removes the TGPP2-BSID AVP from the Event-Report-Indication AVP.
|
void |
removeTgppMsTimezone()
Removes the TGPP-MS-TimeZone AVP from the Event-Report-Indication AVP.
|
void |
removeTgppSgsnAddress()
Removes the TGPP-SGSN-Address AVP from the Event-Report-Indication AVP.
|
void |
removeTgppSgsnIpv6Address()
Removes the TGPP-SGSN-IPv6-Address AVP from the Event-Report-Indication AVP.
|
void |
removeTgppSgsnMccMnc()
Removes the TGPP-SGSN-MCC-MNC AVP from the Event-Report-Indication AVP.
|
void |
removeTgppUserLocationInfo()
Removes the TGPP-User-Location-Info AVP from the Event-Report-Indication AVP.
|
void |
removeTraceData()
Removes the Trace-Data AVP from the Event-Report-Indication AVP.
|
void |
removeTraceReference()
Removes the Trace-Reference AVP from the Event-Report-Indication AVP.
|
void |
removeUserCsgInformation()
Removes the User-CSG-Information AVP from the Event-Report-Indication AVP.
|
void |
setAnGwAddress(Address anGwAddress)
Sets a single AN-GW-Address AVP in the Event-Report-Indication AVP, of type Address.
|
void |
setAnGwAddresses(Address[] anGwAddresses)
Sets the set of AN-GW-Address AVPs, with all the values in the given array.
|
void |
setEventTrigger(EventTrigger eventTrigger)
Sets a single Event-Trigger AVP in the Event-Report-Indication AVP, 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 |
setFramedIpAddress(byte[] framedIpAddress)
Sets the value of the Framed-IP-Address AVP, of type OctetString.
|
void |
setIpCanType(IpCanType ipCanType)
Sets the value of the IP-CAN-Type AVP, of type Enumerated.
|
void |
setQosInformation(QosInformation qosInformation)
Sets the value of the QoS-Information AVP, of type Grouped.
|
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 |
setRoutingIpAddress(Address routingIpAddress)
Sets the value of the Routing-IP-Address AVP, of type Address.
|
void |
setTgpp2Bsid(java.lang.String tgpp2Bsid)
Sets the value of the TGPP2-BSID 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.
|
void |
setTraceData(TraceData traceData)
Sets the value of the Trace-Data AVP, of type Grouped.
|
void |
setTraceReference(byte[] traceReference)
Sets the value of the Trace-Reference AVP, of type OctetString.
|
void |
setUserCsgInformation(UserCsgInformation userCsgInformation)
Sets the value of the User-CSG-Information AVP, of type Grouped.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
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 hasUserCsgInformation()
UserCsgInformation getUserCsgInformation()
void setUserCsgInformation(UserCsgInformation userCsgInformation)
java.lang.NullPointerException
- if userCsgInformation
is null
.void removeUserCsgInformation()
boolean hasIpCanType()
IpCanType getIpCanType()
void setIpCanType(IpCanType ipCanType)
java.lang.NullPointerException
- if ipCanType
is null
.void removeIpCanType()
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 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 hasTgppSgsnMccMnc()
java.lang.String getTgppSgsnMccMnc()
void setTgppSgsnMccMnc(java.lang.String tgppSgsnMccMnc)
java.lang.NullPointerException
- if tgppSgsnMccMnc
is null
.void removeTgppSgsnMccMnc()
boolean hasFramedIpAddress()
byte[] getFramedIpAddress()
void setFramedIpAddress(byte[] framedIpAddress)
java.lang.NullPointerException
- if framedIpAddress
is null
.void removeFramedIpAddress()
boolean hasRatType()
RatType getRatType()
void setRatType(RatType ratType)
java.lang.NullPointerException
- if ratType
is null
.void removeRatType()
boolean hasQosInformation()
QosInformation getQosInformation()
void setQosInformation(QosInformation qosInformation)
java.lang.NullPointerException
- if qosInformation
is null
.void removeQosInformation()
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 hasTraceData()
TraceData getTraceData()
void setTraceData(TraceData traceData)
java.lang.NullPointerException
- if traceData
is null
.void removeTraceData()
boolean hasTraceReference()
byte[] getTraceReference()
void setTraceReference(byte[] traceReference)
java.lang.NullPointerException
- if traceReference
is null
.void removeTraceReference()
boolean hasTgpp2Bsid()
java.lang.String getTgpp2Bsid()
void setTgpp2Bsid(java.lang.String tgpp2Bsid)
java.lang.NullPointerException
- if tgpp2Bsid
is null
.void removeTgpp2Bsid()
boolean hasTgppMsTimezone()
byte[] getTgppMsTimezone()
void setTgppMsTimezone(byte[] tgppMsTimezone)
java.lang.NullPointerException
- if tgppMsTimezone
is null
.void removeTgppMsTimezone()
boolean hasRoutingIpAddress()
Address getRoutingIpAddress()
void setRoutingIpAddress(Address routingIpAddress)
java.lang.NullPointerException
- if routingIpAddress
is null
.void removeRoutingIpAddress()
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()