net.java.slee.resource.diameter.gq.events.avp
Interface MediaComponentDescription

All Superinterfaces:

java.lang.Cloneable, net.java.slee.resource.diameter.base.events.avp.DiameterAvp, net.java.slee.resource.diameter.base.events.avp.GroupedAvp

All Known Implementing Classes:

MediaComponentDescriptionImpl

public interface MediaComponentDescription
extends net.java.slee.resource.diameter.base.events.avp.GroupedAvp

Defines an interface representing the service information for a single media component with an AF session grouped AVP type.

From the Diameter Gq' Reference Point Protocol Details (ETSI TS 183.017 V2.3.1) specification:

 7.3.26 Media-Component-Description AVP
 The Binding-input-list AVP (AVP Code 517) is of type Grouped AVP and contains service information
 for a single media component within an AF session 
 
 It has the following ABNF grammar: 
  Media-Component-Description ::= AVP Header: 517 13019
        [ Media-Component-Number ]
      * [ Media-Sub-Component ]
        [ AF-Application-Identifier ]
        [ Media-Type ]
        [ Max-Request-Bandwidth-UL ]      
        [ Max-Request-Bandwidth-DL ]
        [ Flow-Status ]
        [ RS-Bandwidth ]
        [ RR-Bandwidth ]
        [ Reservation-Class ]
        [ Reservation-Priority ]
        [ Transport-Class ]
      * [ Codec-Data ]
      * [ Media-Authorization-Context-Id ]
 

Author:

Yulian Oifa

Field Summary

Fields inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp

FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT

Method Summary

byte[]	getAFApplicationIdentifier() Returns the value of the AF-Application-Identifier AVP, of type OctetString.
byte[][]	getCodecData() Returns the value of the Codec-Data AVP, of type OctetString.
FlowStatus	getFlowStatus() Returns the value of the Flow-Status AVP, of type Grouped.
long	getMaxRequestedBandwidthDL() Returns the value of the Max-Requested-Bandwidth-DL AVP, of type Unsigned32.
long	getMaxRequestedBandwidthUL() Returns the value of the Max-Requested-Bandwidth-UL AVP, of type Unsigned32.
java.lang.String[]	getMediaAuthorizationContextId() Returns the value of the Media-Authorization-Context-Id AVP, of type UTF8String.
long	getMediaComponentNumber() Returns the value of the Media-Component-Number AVP, of type Unsigned32.
MediaSubComponent[]	getMediaSubComponents() Returns the value of the Media-Sub-Component AVP, of type Grouped.
MediaType	getMediaType() Returns the value of the Media-Type AVP, of type Grouped.
long	getReservationClass() Returns the value of the Reservation-Class AVP, of type Unsigned32.
ReservationPriority	getReservationPriority() Returns the value of the Reservation-Priority AVP, of type Grouped.
long	getRRBandwidth() Returns the value of the RR-Bandwidth AVP, of type Unsigned32.
long	getRSBandwidth() Returns the value of the RS-Bandwidth AVP, of type Unsigned32.
long	getTransportClass() Returns the value of the Transport-Class AVP, of type Unsigned32.
boolean	hasAFApplicationIdentifier() Returns true if the AF-Application-Identifier AVP is present in the message.
boolean	hasFlowStatus() Returns true if the Flow-Status AVP is present in the message.
boolean	hasMaxRequestedBandwidthDL() Returns true if the Max-Requested-Bandwidth-DL AVP is present in the message.
boolean	hasMaxRequestedBandwidthUL() Returns true if the Max-Requested-Bandwidth-UL AVP is present in the message.
boolean	hasMediaComponentNumber() Returns true if the Media-Component-Number AVP is present in the message.
boolean	hasMediaType() Returns true if the Media-Type AVP is present in the message.
boolean	hasReservationClass() Returns true if the Reservation-Class AVP is present in the message.
boolean	hasReservationPriority() Returns true if the Reservation-Priority AVP is present in the message.
boolean	hasRRBandwidth() Returns true if the RR-Bandwidth AVP is present in the message.
boolean	hasRSBandwidth() Returns true if the RS-Bandwidth AVP is present in the message.
boolean	hasTransportClass() Returns true if the Transport-Class AVP is present in the message.
void	setAFApplicationIdentifier(byte[] AFApplicationIdentifier) Sets the value of the AF-Application-Identifier AVP, of type OctetString.
void	setCodecData(byte[] codecData) Sets the value of the Codec-Data AVP, of type OctetString.
void	setCodecData(byte[][] codecsData) Sets the value of the Codec-Data AVP, of type OctetString.
void	setFlowStatus(FlowStatus flowStatus) Sets the value of the Flow-Status AVP, of type Unsigned32.
void	setMaxRequestedBandwidthDL(long maxRequestedBandwidthDL) Sets the value of the Max-Requested-Bandwidth-DL AVP, of type Unsigned32.
void	setMaxRequestedBandwidthUL(long maxRequestedBandwidthUL) Sets the value of the Max-Requested-Bandwidth-UL AVP, of type Unsigned32.
void	setMediaAuthorizationContextId(java.lang.String mediaAuthorizationContextId) Sets the value of the Media-Authorization-Context-Id, of type UTF8String.
void	setMediaAuthorizationContextId(java.lang.String[] mediaAuthorizationContextIds) Sets the value of the Media-Authorization-Context-Id AVP, of type UTF8String.
void	setMediaComponentNumber(long mediaComponentNumber) Sets the value of the Media-Component-Number AVP, of type Unsigned32.
void	setMediaSubComponent(MediaSubComponent mediaSubComponent) Sets the value of the Media-Sub-Component AVP, of type Grouped.
void	setMediaSubComponents(MediaSubComponent[] mediaSubComponent) Sets the value of the Media-Sub-Component AVP, of type Grouped.
void	setMediaType(MediaType mediaType) Sets the value of the Media-Type AVP, of type Unsigned32.
void	setReservationClass(long reservationClass) Sets the value of the Reservation-Class AVP, of type Unsigned32.
void	setReservationPriority(ReservationPriority reservationPriority) Sets the value of the Reservation-Priority AVP, of type Unsigned32.
void	setRRBandwidth(long RRBandwidth) Sets the value of the RR-Bandwidth AVP, of type Unsigned32.
void	setRSBandwidth(long RSBandwidth) Sets the value of the RS-Bandwidth AVP, of type Unsigned32.
void	setTransportClass(long transportClass) Sets the value of the Transport-Class AVP, of type Unsigned32.

Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.GroupedAvp

getExtensionAvps, setExtensionAvps

Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp

byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorId, intValue, longValue, octetStringValue, stringValue

Method Detail

getMediaComponentNumber

long getMediaComponentNumber()

Returns the value of the Media-Component-Number AVP, of type Unsigned32. A return value of null implies that the AVP has not been set.

getMediaSubComponents

MediaSubComponent[] getMediaSubComponents()

Returns the value of the Media-Sub-Component AVP, of type Grouped. A return value of null implies that the AVP has not been set.

getAFApplicationIdentifier

byte[] getAFApplicationIdentifier()

Returns the value of the AF-Application-Identifier AVP, of type OctetString. A return value of null implies that the AVP has not been set.

getMediaType

MediaType getMediaType()

Returns the value of the Media-Type AVP, of type Grouped. A return value of null implies that the AVP has not been set.

getMaxRequestedBandwidthUL

long getMaxRequestedBandwidthUL()

Returns the value of the Max-Requested-Bandwidth-UL AVP, of type Unsigned32. A return value of null implies that the AVP has not been set.

getMaxRequestedBandwidthDL

long getMaxRequestedBandwidthDL()

Returns the value of the Max-Requested-Bandwidth-DL AVP, of type Unsigned32. A return value of null implies that the AVP has not been set.

getFlowStatus

FlowStatus getFlowStatus()

Returns the value of the Flow-Status AVP, of type Grouped. A return value of null implies that the AVP has not been set.

getRRBandwidth

long getRRBandwidth()

Returns the value of the RR-Bandwidth AVP, of type Unsigned32. A return value of null implies that the AVP has not been set.

getRSBandwidth

long getRSBandwidth()

Returns the value of the RS-Bandwidth AVP, of type Unsigned32. A return value of null implies that the AVP has not been set.

getReservationClass

long getReservationClass()

Returns the value of the Reservation-Class AVP, of type Unsigned32. A return value of null implies that the AVP has not been set.

getReservationPriority

ReservationPriority getReservationPriority()

Returns the value of the Reservation-Priority AVP, of type Grouped. A return value of null implies that the AVP has not been set.

getTransportClass

long getTransportClass()

Returns the value of the Transport-Class AVP, of type Unsigned32. A return value of null implies that the AVP has not been set.

getCodecData

byte[][] getCodecData()

Returns the value of the Codec-Data AVP, of type OctetString. A return value of null implies that the AVP has not been set.

getMediaAuthorizationContextId

java.lang.String[] getMediaAuthorizationContextId()

Returns the value of the Media-Authorization-Context-Id AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

hasMediaComponentNumber

boolean hasMediaComponentNumber()

Returns true if the Media-Component-Number AVP is present in the message.

hasAFApplicationIdentifier

boolean hasAFApplicationIdentifier()

Returns true if the AF-Application-Identifier AVP is present in the message.

hasMediaType

boolean hasMediaType()

Returns true if the Media-Type AVP is present in the message.

hasMaxRequestedBandwidthUL

boolean hasMaxRequestedBandwidthUL()

Returns true if the Max-Requested-Bandwidth-UL AVP is present in the message.

hasMaxRequestedBandwidthDL

boolean hasMaxRequestedBandwidthDL()

Returns true if the Max-Requested-Bandwidth-DL AVP is present in the message.

hasFlowStatus

boolean hasFlowStatus()

Returns true if the Flow-Status AVP is present in the message.

hasRRBandwidth

boolean hasRRBandwidth()

Returns true if the RR-Bandwidth AVP is present in the message.

hasRSBandwidth

boolean hasRSBandwidth()

Returns true if the RS-Bandwidth AVP is present in the message.

hasReservationClass

boolean hasReservationClass()

Returns true if the Reservation-Class AVP is present in the message.

hasReservationPriority

boolean hasReservationPriority()

Returns true if the Reservation-Priority AVP is present in the message.

hasTransportClass

boolean hasTransportClass()

Returns true if the Transport-Class AVP is present in the message.

setMediaComponentNumber

void setMediaComponentNumber(long mediaComponentNumber)

Sets the value of the Media-Component-Number AVP, of type Unsigned32.

setMediaSubComponents

void setMediaSubComponents(MediaSubComponent[] mediaSubComponent)

Sets the value of the Media-Sub-Component AVP, of type Grouped.

setMediaSubComponent

void setMediaSubComponent(MediaSubComponent mediaSubComponent)

Sets the value of the Media-Sub-Component AVP, of type Grouped.

setAFApplicationIdentifier

void setAFApplicationIdentifier(byte[] AFApplicationIdentifier)

Sets the value of the AF-Application-Identifier AVP, of type OctetString.

setMediaType

void setMediaType(MediaType mediaType)

Sets the value of the Media-Type AVP, of type Unsigned32.

setMaxRequestedBandwidthUL

void setMaxRequestedBandwidthUL(long maxRequestedBandwidthUL)

Sets the value of the Max-Requested-Bandwidth-UL AVP, of type Unsigned32.

setMaxRequestedBandwidthDL

void setMaxRequestedBandwidthDL(long maxRequestedBandwidthDL)

Sets the value of the Max-Requested-Bandwidth-DL AVP, of type Unsigned32.

setFlowStatus

void setFlowStatus(FlowStatus flowStatus)

Sets the value of the Flow-Status AVP, of type Unsigned32.

setRSBandwidth

void setRSBandwidth(long RSBandwidth)

Sets the value of the RS-Bandwidth AVP, of type Unsigned32.

setRRBandwidth

void setRRBandwidth(long RRBandwidth)

Sets the value of the RR-Bandwidth AVP, of type Unsigned32.

setReservationClass

void setReservationClass(long reservationClass)

Sets the value of the Reservation-Class AVP, of type Unsigned32.

setReservationPriority

void setReservationPriority(ReservationPriority reservationPriority)

Sets the value of the Reservation-Priority AVP, of type Unsigned32.

setTransportClass

void setTransportClass(long transportClass)

Sets the value of the Transport-Class AVP, of type Unsigned32.

setCodecData

void setCodecData(byte[][] codecsData)

Sets the value of the Codec-Data AVP, of type OctetString.

setCodecData

void setCodecData(byte[] codecData)

Sets the value of the Codec-Data AVP, of type OctetString.

setMediaAuthorizationContextId

void setMediaAuthorizationContextId(java.lang.String[] mediaAuthorizationContextIds)

Sets the value of the Media-Authorization-Context-Id AVP, of type UTF8String.

setMediaAuthorizationContextId

void setMediaAuthorizationContextId(java.lang.String mediaAuthorizationContextId)

Sets the value of the Media-Authorization-Context-Id, of type UTF8String.