JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000

jain.protocol.ip.mgcp.message.parms
Class LocalOptionValue

java.lang.Object
  |
  +--jain.protocol.ip.mgcp.message.parms.LocalOptionValue
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
Bandwidth, CompressionAlgorithm, EchoCancellation, EncryptionMethod, GainControl, LocalOptionExtension, PacketizationPeriod, ResourceReservation, SilenceSuppression, TypeOfNetwork, TypeOfService

public class LocalOptionValue
extends java.lang.Object
implements java.io.Serializable

Specifies a Local Connection Options Value. Note that this is an abstract class. "Get" accessor methods are defined for each subclass that derives from this class, which, by default, throw an exception. Each subclass defines its own overriding accessor method, so that invoking an accessor method on the wrong subclass would result in an exception being thrown.

See Also:
Serialized Form

Field Summary
static int BANDWIDTH
          Signifies that this LocalOptionValue object represents a bandwidth value or range.
static int COMPRESSION_ALGORITHM
          Signifies that this LocalOptionValue object represents a list of compression algorithm names.
static int ECHO_CANCELLATION
          Signifies that this LocalOptionValue object represents the state of echo cancellation.
static int ENCRYPTION_METHOD
          Signifies that this LocalOptionValue object represents an encryption method/key.
static int GAIN_CONTROL
          Signifies that this LocalOptionValue object represents gain control.
static int LOCAL_OPTION_EXTENSION
          Signifies that this LocalOptionValue object represents a Local Option Extension parameter.
static int PACKETIZATION_PERIOD
          Signifies that this LocalOptionValue object represents a packetization period.
static int RESOURCE_RESERVATION
          Signifies that this LocalOptionValue object represents resource reservation.
static int SILENCE_SUPPRESSION
          Signifies that this LocalOptionValue object represents the state of silence suppression.
static int TYPE_OF_NETWORK
          Signifies that this LocalOptionValue object represents type of network.
static int TYPE_OF_SERVICE
          Signifies that this LocalOptionValue object represents type of service.
 
Constructor Summary
protected LocalOptionValue(int localOptionValueType)
          Constructs a new LocalOptionValue object.

 
Method Summary
 int getBandwidthLowerBound()
          Gets the lower bound of the bandwidth range.
 int getBandwidthUpperBound()
          Gets the upper bound of the bandwidth range.
 java.lang.String[] getCompressionAlgorithmNames()
          Gets the list of compression algorithm names.
 boolean getEchoCancellation()
          Gets the on/off state of echo cancellation.
 int getEncryptionMethod()
          Gets the encryption method.
 int getGainControl()
          Gets the gain control value.
 java.lang.String getLocalOptionExtensionName()
          Gets the name of the local option extension parameter.
 int getLocalOptionValueType()
          Gets the type of the Local Option Value.
 int getPacketizationPeriodLowerBound()
          Gets the lower bound of the packetization period.
 int getPacketizationPeriodUpperBound()
          Gets the upper bound of the packetization period.
 int getResourceReservation()
          Gets the resource reservation (guaranteed, controlled load, best effort).
 boolean getSilenceSuppression()
          Gets the on/off state of silence suppression.
 int getTypeOfNetwork()
          Gets the type of network.
 byte getTypeOfService()
          Gets the type of service.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BANDWIDTH

public static final int BANDWIDTH
Signifies that this LocalOptionValue object represents a bandwidth value or range.

COMPRESSION_ALGORITHM

public static final int COMPRESSION_ALGORITHM
Signifies that this LocalOptionValue object represents a list of compression algorithm names.

ECHO_CANCELLATION

public static final int ECHO_CANCELLATION
Signifies that this LocalOptionValue object represents the state of echo cancellation.

ENCRYPTION_METHOD

public static final int ENCRYPTION_METHOD
Signifies that this LocalOptionValue object represents an encryption method/key.

GAIN_CONTROL

public static final int GAIN_CONTROL
Signifies that this LocalOptionValue object represents gain control.

LOCAL_OPTION_EXTENSION

public static final int LOCAL_OPTION_EXTENSION
Signifies that this LocalOptionValue object represents a Local Option Extension parameter.

PACKETIZATION_PERIOD

public static final int PACKETIZATION_PERIOD
Signifies that this LocalOptionValue object represents a packetization period.

RESOURCE_RESERVATION

public static final int RESOURCE_RESERVATION
Signifies that this LocalOptionValue object represents resource reservation.

SILENCE_SUPPRESSION

public static final int SILENCE_SUPPRESSION
Signifies that this LocalOptionValue object represents the state of silence suppression.

TYPE_OF_NETWORK

public static final int TYPE_OF_NETWORK
Signifies that this LocalOptionValue object represents type of network.

TYPE_OF_SERVICE

public static final int TYPE_OF_SERVICE
Signifies that this LocalOptionValue object represents type of service.
Constructor Detail

LocalOptionValue

protected LocalOptionValue(int localOptionValueType)
Constructs a new LocalOptionValue object.

Method Detail

getBandwidthLowerBound

public int getBandwidthLowerBound()
                           throws JainIPMgcpException
Gets the lower bound of the bandwidth range.
Returns:
The lower bound of the bandwidth range.
Throws:
JainIPMgcpException - Thrown if this object does not represent a bandwidth value or range.

getBandwidthUpperBound

public int getBandwidthUpperBound()
                           throws JainIPMgcpException
Gets the upper bound of the bandwidth range.
Returns:
The upper bound of the bandwidth range.
Throws:
JainIPMgcpException - Thrown if this object does not represent a bandwidth value or range.

getCompressionAlgorithmNames

public java.lang.String[] getCompressionAlgorithmNames()
                                                throws JainIPMgcpException
Gets the list of compression algorithm names.
Returns:
The list of compression algorithm names.
Throws:
JainIPMgcpException - Thrown if this object does not represent a list of compression algorithm names.

getEchoCancellation

public boolean getEchoCancellation()
                            throws JainIPMgcpException
Gets the on/off state of echo cancellation.
Returns:
The on/off state of echo cancellation.
Throws:
JainIPMgcpException - Thrown if this object does not represent the state of echo cancellation.

getEncryptionMethod

public int getEncryptionMethod()
                        throws JainIPMgcpException
Gets the encryption method.
Returns:
The encryption method (as an integer value: CLEAR, BASE64, URI).
Throws:
JainIPMgcpException - Thrown if this object does not represent encryption method.

getGainControl

public int getGainControl()
                   throws JainIPMgcpException
Gets the gain control value.
Returns:
The gain control value.
Throws:
JainIPMgcpException - Thrown if this object does not represent the gain control value.

getLocalOptionExtensionName

public java.lang.String getLocalOptionExtensionName()
                                             throws JainIPMgcpException
Gets the name of the local option extension parameter.
Returns:
The name of the local option extension parameter, as a String.
Throws:
JainIPMgcpException - Thrown if this object does not represent a local option extension parameter.

getLocalOptionValueType

public int getLocalOptionValueType()
Gets the type of the Local Option Value.
Returns:
An integer value that indicates which type of Local Option Value is represented by this object.

getPacketizationPeriodLowerBound

public int getPacketizationPeriodLowerBound()
                                     throws JainIPMgcpException
Gets the lower bound of the packetization period.
Returns:
The lower bound of the packetization period.
Throws:
JainIPMgcpException - Thrown if this object does not represent a packetization period.

getPacketizationPeriodUpperBound

public int getPacketizationPeriodUpperBound()
                                     throws JainIPMgcpException
Gets the upper bound of the packetization period.
Returns:
The upper bound of the packetization period.
Throws:
JainIPMgcpException - Thrown if this object does not represent a packetization period.

getResourceReservation

public int getResourceReservation()
                           throws JainIPMgcpException
Gets the resource reservation (guaranteed, controlled load, best effort).
Returns:
The resource reservation type (as an integer value: GUARANTEED, CONTROLLED_LOAD, BEST_EFFORT).
Throws:
JainIPMgcpException - Thrown if this object does not represent resource reservation.

getSilenceSuppression

public boolean getSilenceSuppression()
                              throws JainIPMgcpException
Gets the on/off state of silence suppression.
Returns:
The on/off state of silence suppression.
Throws:
JainIPMgcpException - Thrown if this object does not represent the state of silence suppression.

getTypeOfNetwork

public int getTypeOfNetwork()
                     throws JainIPMgcpException
Gets the type of network.
Returns:
The type of network (as an integer value: IN, ATM, LOCAL).
Throws:
JainIPMgcpException - Thrown if this object does not represent type of network.

getTypeOfService

public byte getTypeOfService()
                      throws JainIPMgcpException
Gets the type of service.
Returns:
The Type of Service as a byte value.
Throws:
JainIPMgcpException - Thrown if this object does not represent the type of service.

JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000

Copyright © 2000 Sun Microsystems, Inc.