Package org.jainslee.resources.diameter.gx.types.va10

Interface DefaultEpsBearerQos

All Superinterfaces:

Cloneable, DiameterAvp, GroupedAvp

public interface DefaultEpsBearerQos
extends GroupedAvp

Defines an interface representing the Default-EPS-Bearer-QoS grouped AVP type. From the Diameter Gx Reference Point Protocol Details (3GPP TS 29.212 V10.1.0) specification:

 5.3.48 Default-EPS-Bearer-QoS
 
     The Default-EPS-Bearer-QoS AVP (AVP code 1049) is of type Grouped, and it defines the QoS information for the
     EPS default bearer. When this AVP is sent from the PCEF to the PCRF, it indicates the subscribed QoS for the default
     EPS bearer. When this AVP is sent from the PCRF to the PCEF, it indicates the authorized QoS for the default EPS
     bearer.
 
     The QoS class identifier identifies a set of IP-CAN specific QoS parameters that define QoS, excluding the applicable
     bitrates and ARP. When included in the Default-EPS-Bearer-QoS AVP, it shall include only non-GBR values.
     The Allocation-Retention-Priority AVP is an indicator of the priority of allocation and retention for the default bearer.
 
     AVP Format:
 
     Default-EPS-Bearer-QoS::= < AVP Header: 1049 >
                                 [ QoS-Class-Identifier ]
                                 [ Allocation-Retention-Priority]
                               * [ AVP ]
 
 

Field Summary

Fields inherited from interface org.jainslee.resources.diameter.base.DiameterAvp

FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT

Method Summary

Modifier and Type	Method	Description
AllocationRetentionPriority	getAllocationRetentionPriority()	Returns the value of the Allocation-Retention-Priority AVP, of type Grouped.
DiameterAvp[]	getExtensionAvps()	Returns the set of extension AVPs.
QosClassIdentifier	getQosClassIdentifier()	Returns the value of the QoS-Class-Identifier AVP, of type Enumerated.
boolean	hasAllocationRetentionPriority()	Returns true if the Allocation-Retention-Priority AVP is present in the Default-EPS-Bearer-QoS AVP.
boolean	hasQosClassIdentifier()	Returns true if the QoS-Class-Identifier AVP is present in the Default-EPS-Bearer-QoS AVP.
void	removeAllocationRetentionPriority()	Removes the Allocation-Retention-Priority AVP from the Default-EPS-Bearer-QoS AVP.
void	removeExtensionAvps()	Removes all extension AVPs from the Default-EPS-Bearer-QoS AVP.
void	removeQosClassIdentifier()	Removes the QoS-Class-Identifier AVP from the Default-EPS-Bearer-QoS AVP.
void	setAllocationRetentionPriority(AllocationRetentionPriority allocationRetentionPriority)	Sets the value of the Allocation-Retention-Priority AVP, of type Grouped.
void	setExtensionAvps(DiameterAvp[] avps)	Sets the set of extension AVPs with all the values in the given array.
void	setQosClassIdentifier(QosClassIdentifier qosClassIdentifier)	Sets the value of the QoS-Class-Identifier AVP, of type Enumerated.

Methods inherited from interface org.jainslee.resources.diameter.base.DiameterAvp

byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue

Method Detail

hasQosClassIdentifier

boolean hasQosClassIdentifier()

Returns true if the QoS-Class-Identifier AVP is present in the Default-EPS-Bearer-QoS AVP.

getQosClassIdentifier

QosClassIdentifier getQosClassIdentifier()

Returns the value of the QoS-Class-Identifier AVP, of type Enumerated.

Returns:

the value of the QoS-Class-Identifier AVP, or null if it has not been set.

setQosClassIdentifier

void setQosClassIdentifier(QosClassIdentifier qosClassIdentifier)

Sets the value of the QoS-Class-Identifier AVP, of type Enumerated.

Throws:

NullPointerException - if qosClassIdentifier is null.

removeQosClassIdentifier

void removeQosClassIdentifier()

Removes the QoS-Class-Identifier AVP from the Default-EPS-Bearer-QoS AVP. If the QoS-Class-Identifier AVP is not present, this method returns silently.

hasAllocationRetentionPriority

boolean hasAllocationRetentionPriority()

Returns true if the Allocation-Retention-Priority AVP is present in the Default-EPS-Bearer-QoS AVP.

getAllocationRetentionPriority

AllocationRetentionPriority getAllocationRetentionPriority()

Returns the value of the Allocation-Retention-Priority AVP, of type Grouped.

Returns:

the value of the Allocation-Retention-Priority AVP, or null if it has not been set.

setAllocationRetentionPriority

void setAllocationRetentionPriority(AllocationRetentionPriority allocationRetentionPriority)

Sets the value of the Allocation-Retention-Priority AVP, of type Grouped.

Throws:

NullPointerException - if allocationRetentionPriority is null.

removeAllocationRetentionPriority

void removeAllocationRetentionPriority()

Removes the Allocation-Retention-Priority AVP from the Default-EPS-Bearer-QoS AVP. If the Allocation-Retention-Priority AVP is not present, this method returns silently.

getExtensionAvps

DiameterAvp[] getExtensionAvps()

Returns the set of extension AVPs. The returned array contains the extension AVPs in the order they appear in the Default-EPS-Bearer-QoS AVP. A return value of null implies that no extensions AVPs have been set.

setExtensionAvps

void setExtensionAvps(DiameterAvp[] avps)
               throws AvpNotAllowedException

Sets the set of extension AVPs with all the values in the given array. The AVPs will be added to Default-EPS-Bearer-QoS AVP in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getExtensionAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:

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)

NullPointerException - if avps is null.

removeExtensionAvps

void removeExtensionAvps()

Removes all extension AVPs from the Default-EPS-Bearer-QoS AVP. If no extension AVPs are present, this method returns silently.