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

jain.protocol.ip.mgcp
Interface JainMgcpStack


public interface JainMgcpStack

This interface defines the methods that are required to represent a proprietary JAIN MGCP protocol stack, the implementation of which will be vendor-specific. Methods are defined for creating and deleting instances of a JainMgcpProvider.

A method is defined for getting the port number on which the stack will listen for incoming MGCP messages. Setting the port number is outside the scope of this API, falling instead in the scope of Operations, Administration, and Maintenance (OAM).


Method Summary
 JainMgcpProvider createProvider()
          Creates a new Peer (vendor-specific) JainMgcpProvider and returns a reference to it.

 void deleteProvider(JainMgcpProvider jainMgcpProvider)
          Deletes the specified JainMgcpProvider.

 int getPort()
          Gets the port number on which the stack will listen for incoming MGCP messages.

 java.lang.String getProtocolVersion()
          Gets the currently-set version of the MGCP protocol in use by an object that implements the JainMgcpStack interface.

 void setProtocolVersion(java.lang.String protocolVersion)
          Sets the version of the MGCP protocol to be used by an object that implements the JainMgcpStack interface.

 

Method Detail

createProvider

public JainMgcpProvider createProvider()
                                throws CreateProviderException
Creates a new Peer (vendor-specific) JainMgcpProvider and returns a reference to it.

Returns:
A reference to the JainMgcpProviderImpl Object that exposes the JainMgcpProvider interface.
Throws:
CreateProviderException - Indicates that a problem occurred during the instantiation of the JainMgcpProviderImpl class.

deleteProvider

public void deleteProvider(JainMgcpProvider jainMgcpProvider)
                    throws DeleteProviderException
Deletes the specified JainMgcpProvider.

Throws:
DeleteProviderException - Indicates that a problem occurred during the deletion of the Provider Object.

getPort

public int getPort()
Gets the port number on which the stack will listen for incoming MGCP messages.

Returns:
The port number

getProtocolVersion

public java.lang.String getProtocolVersion()
Gets the currently-set version of the MGCP protocol in use by an object that implements the JainMgcpStack interface.

Returns:
The currently-set version of the MGCP protocol in use by an object that implements the JainMgcpStack interface.

setProtocolVersion

public void setProtocolVersion(java.lang.String protocolVersion)
Sets the version of the MGCP protocol to be used by an object that implements the JainMgcpStack interface.

Parameters:
protocolVersion - The version of the MGCP protocol to be used by an object that implements the JainMgcpStack interface.

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

Copyright © 2000 Sun Microsystems, Inc.