public interface UsageMonitoringInformation extends GroupedAvp
5.3.60 Usage-Monitoring-Information AVP The Usage-Monitoring-Information AVP (AVP code 1067) is of type Grouped, and it contains the usage monitoring control information. The Monitoring-Key AVP identifies the usage monitoring control instance. The Granted-Service-Unit AVP shall be used by the PCRF to provide the threshold level to the PCEF. The CC-Total- Octets AVP shall be used for providing threshold level for the total volume, or the CC-Input-Octets and/or CC-Output- Octets AVPs shall be used for providing threshold level for the uplink volume and/or the downlink volume. Monitoring-Time AVP shall be used for providing the time at which the PCEF shall reapply the threshold value provided by the PCRF. The Used-Service-Unit AVP shall be used by the PCEF to provide the measured usage to the PCRF. Reporting shall be done, as requested by the PCRF, in CC-Total-Octets, CC-Input-Octets or CC-Output-Octets AVPs of Used-Service- Unit AVP. Monitoring-Time AVP shall be used to indicate the time at which the PCEF shall reapply the threshold value provided by the PCRF. The Usage-Monitoring-Level AVP determines the scope of the usage monitoring instance. The Usage-Monitoring-Report AVP determines if accumulated usage shall be reported for the usage monitoring key included in Monitoring-Key AVP. The Usage-Monitoring-Support AVP determines if a usage monitoring instance is disabled. AVP Format: Usage-Monitoring-Information::= < AVP Header: 1067 > [ Monitoring-Key ] 0*2[ Granted-Service-Unit ] 0*2[ Used-Service-Unit ] [ Usage-Monitoring-Level ] [ Usage-Monitoring-Report ] [ Usage-Monitoring-Support ] *[ AVP ]
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
GrantedServiceUnit[] |
getGrantedServiceUnits()
Returns the set of Granted-Service-Unit AVPs.
|
byte[] |
getMonitoringKey()
Returns the value of the Monitoring-Key AVP, of type OctetString.
|
UsageMonitoringLevel |
getUsageMonitoringLevel()
Returns the value of the Usage-Monitoring-Level AVP, of type Enumerated.
|
UsageMonitoringReport |
getUsageMonitoringReport()
Returns the value of the Usage-Monitoring-Report AVP, of type Enumerated.
|
UsageMonitoringSupport |
getUsageMonitoringSupport()
Returns the value of the Usage-Monitoring-Support AVP, of type Enumerated.
|
UsedServiceUnit[] |
getUsedServiceUnits()
Returns the set of Used-Service-Unit AVPs.
|
boolean |
hasMonitoringKey()
Returns true if the Monitoring-Key AVP is present in the Usage-Monitoring-Information AVP.
|
boolean |
hasUsageMonitoringLevel()
Returns true if the Usage-Monitoring-Level AVP is present in the Usage-Monitoring-Information AVP.
|
boolean |
hasUsageMonitoringReport()
Returns true if the Usage-Monitoring-Report AVP is present in the Usage-Monitoring-Information AVP.
|
boolean |
hasUsageMonitoringSupport()
Returns true if the Usage-Monitoring-Support AVP is present in the Usage-Monitoring-Information AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the Usage-Monitoring-Information AVP.
|
void |
removeGrantedServiceUnits()
Removes all Granted-Service-Unit AVPs from the Usage-Monitoring-Information AVP.
|
void |
removeMonitoringKey()
Removes the Monitoring-Key AVP from the Usage-Monitoring-Information AVP.
|
void |
removeUsageMonitoringLevel()
Removes the Usage-Monitoring-Level AVP from the Usage-Monitoring-Information AVP.
|
void |
removeUsageMonitoringReport()
Removes the Usage-Monitoring-Report AVP from the Usage-Monitoring-Information AVP.
|
void |
removeUsageMonitoringSupport()
Removes the Usage-Monitoring-Support AVP from the Usage-Monitoring-Information AVP.
|
void |
removeUsedServiceUnits()
Removes all Used-Service-Unit AVPs from the Usage-Monitoring-Information AVP.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setGrantedServiceUnit(GrantedServiceUnit grantedServiceUnit)
Sets a single Granted-Service-Unit AVP in the Usage-Monitoring-Information AVP, of type Grouped.
|
void |
setGrantedServiceUnits(GrantedServiceUnit[] grantedServiceUnits)
Sets the set of Granted-Service-Unit AVPs, with all the values in the given array.
|
void |
setMonitoringKey(byte[] monitoringKey)
Sets the value of the Monitoring-Key AVP, of type OctetString.
|
void |
setUsageMonitoringLevel(UsageMonitoringLevel usageMonitoringLevel)
Sets the value of the Usage-Monitoring-Level AVP, of type Enumerated.
|
void |
setUsageMonitoringReport(UsageMonitoringReport usageMonitoringReport)
Sets the value of the Usage-Monitoring-Report AVP, of type Enumerated.
|
void |
setUsageMonitoringSupport(UsageMonitoringSupport usageMonitoringSupport)
Sets the value of the Usage-Monitoring-Support AVP, of type Enumerated.
|
void |
setUsedServiceUnit(UsedServiceUnit usedServiceUnit)
Sets a single Used-Service-Unit AVP in the Usage-Monitoring-Information AVP, of type Grouped.
|
void |
setUsedServiceUnits(UsedServiceUnit[] usedServiceUnits)
Sets the set of Used-Service-Unit AVPs, with all the values in the given array.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasMonitoringKey()
byte[] getMonitoringKey()
void setMonitoringKey(byte[] monitoringKey)
java.lang.NullPointerException
- if monitoringKey
is null
.void removeMonitoringKey()
GrantedServiceUnit[] getGrantedServiceUnits()
void setGrantedServiceUnit(GrantedServiceUnit grantedServiceUnit)
java.lang.NullPointerException
- if grantedServiceUnit
is null
.void setGrantedServiceUnits(GrantedServiceUnit[] grantedServiceUnits)
java.lang.NullPointerException
- if grantedServiceUnits
is null
.void removeGrantedServiceUnits()
UsedServiceUnit[] getUsedServiceUnits()
void setUsedServiceUnit(UsedServiceUnit usedServiceUnit)
java.lang.NullPointerException
- if usedServiceUnit
is null
.void setUsedServiceUnits(UsedServiceUnit[] usedServiceUnits)
java.lang.NullPointerException
- if usedServiceUnits
is null
.void removeUsedServiceUnits()
boolean hasUsageMonitoringLevel()
UsageMonitoringLevel getUsageMonitoringLevel()
void setUsageMonitoringLevel(UsageMonitoringLevel usageMonitoringLevel)
java.lang.NullPointerException
- if usageMonitoringLevel
is null
.void removeUsageMonitoringLevel()
boolean hasUsageMonitoringReport()
UsageMonitoringReport getUsageMonitoringReport()
void setUsageMonitoringReport(UsageMonitoringReport usageMonitoringReport)
java.lang.NullPointerException
- if usageMonitoringReport
is null
.void removeUsageMonitoringReport()
boolean hasUsageMonitoringSupport()
UsageMonitoringSupport getUsageMonitoringSupport()
void setUsageMonitoringSupport(UsageMonitoringSupport usageMonitoringSupport)
java.lang.NullPointerException
- if usageMonitoringSupport
is null
.void removeUsageMonitoringSupport()
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()