public interface OcOlr extends GroupedAvp
7.3. OC-OLR AVP The OC-OLR AVP (AVP Code 623) is of type Grouped and contains the information necessary to convey an overload report on an overload condition at the reporting node. The application the OC-OLR AVP applies to is identified by the Application-ID found in the Diameter message header. The host or realm the OC-OLR AVP concerns is determined from the Origin-Host AVP and/or Origin-Realm AVP found in the encapsulating Diameter command. The OC-OLR AVP is intended to be sent only by a reporting node. OC-OLR ::= < AVP Header: 623 > < OC-Sequence-Number > < OC-Report-Type > [ OC-Reduction-Percentage ] [ OC-Validity-Duration ] * [ AVP ] From RFC 7683
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
long |
getOcReductionPercentage()
Returns the value of the OC-Reduction-Percentage AVP, of type Unsigned32.
|
OcReportType |
getOcReportType()
Returns the value of the OC-Report-Type AVP, of type Enumerated.
|
long |
getOcSequenceNumber()
Returns the value of the OC-Sequence-Number AVP, of type Unsigned64.
|
long |
getOcValidityDuration()
Returns the value of the OC-Validity-Duration AVP, of type Unsigned32.
|
boolean |
hasOcReductionPercentage()
Returns true if the OC-Reduction-Percentage AVP is present in the OC-OLR AVP.
|
boolean |
hasOcReportType()
Returns true if the OC-Report-Type AVP is present in the OC-OLR AVP.
|
boolean |
hasOcSequenceNumber()
Returns true if the OC-Sequence-Number AVP is present in the OC-OLR AVP.
|
boolean |
hasOcValidityDuration()
Returns true if the OC-Validity-Duration AVP is present in the OC-OLR AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the OC-OLR AVP.
|
void |
removeOcReductionPercentage()
Removes the OC-Reduction-Percentage AVP from the OC-OLR AVP.
|
void |
removeOcReportType()
Removes the OC-Report-Type AVP from the OC-OLR AVP.
|
void |
removeOcSequenceNumber()
Removes the OC-Sequence-Number AVP from the OC-OLR AVP.
|
void |
removeOcValidityDuration()
Removes the OC-Validity-Duration AVP from the OC-OLR AVP.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setOcReductionPercentage(long ocReductionPercentage)
Sets the value of the OC-Reduction-Percentage AVP, of type Unsigned32.
|
void |
setOcReportType(OcReportType ocReportType)
Sets the value of the OC-Report-Type AVP, of type Enumerated.
|
void |
setOcSequenceNumber(long ocSequenceNumber)
Sets the value of the OC-Sequence-Number AVP, of type Unsigned64.
|
void |
setOcValidityDuration(long ocValidityDuration)
Sets the value of the OC-Validity-Duration AVP, of type Unsigned32.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasOcSequenceNumber()
long getOcSequenceNumber()
hasOcSequenceNumber()
to check the existence of this AVP.java.lang.IllegalStateException
- if the OC-Sequence-Number AVP has not been set.void setOcSequenceNumber(long ocSequenceNumber)
void removeOcSequenceNumber()
boolean hasOcReportType()
OcReportType getOcReportType()
void setOcReportType(OcReportType ocReportType)
java.lang.NullPointerException
- if ocReportType
is null
.void removeOcReportType()
boolean hasOcReductionPercentage()
long getOcReductionPercentage()
hasOcReductionPercentage()
to check the existence of this AVP.java.lang.IllegalStateException
- if the OC-Reduction-Percentage AVP has not been set.void setOcReductionPercentage(long ocReductionPercentage)
void removeOcReductionPercentage()
boolean hasOcValidityDuration()
long getOcValidityDuration()
hasOcValidityDuration()
to check the existence of this AVP.java.lang.IllegalStateException
- if the OC-Validity-Duration AVP has not been set.void setOcValidityDuration(long ocValidityDuration)
void removeOcValidityDuration()
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()