hp.opencall.media.signalling
Interface CnxProviderIF

All Known Subinterfaces:

ISUPCnxProviderIF

All Known Implementing Classes:

ExternalCnxProvider, ISUPExternalCnxProvider

public interface CnxProviderIF

This interface need to be implemented by the signalling connection provider. Its methods are used by the platform on behalf of the application (oclet) to create both outgoing and incoming calls.

In case of incoming calls, the connection provider must notify the CallDispatcher thanks to a CallSpec. It is then the responsibility of the OCMP Framework to get the connection through the CnxProviderIF.

Several other methods are supplied for the connection provider management.

Method Summary

void	acceptCalls() Called by the OCMP framework to ask the connection provider to accept future calls.
void	exit() The OCMP framework calls this method in order to exit the connection provider.
ConnectionIF	getConnection(hp.opencall.media.ccapi.CallSpec aCallSpec) Get a Signalling ConnectionIF object given a call spec.
void	gracefulShutdown(long waitTime, long lpc) Called by the OCMP framework to ask the connection provider to do a graceful Shutdown
void	immediateShutdown(long lpc) Called by the OCMP framework to ask the connection provider to do an immediate Shutdown
void	refuseCalls() Called by the OCMP framework to ask the connection provider to refuse any future call.
void	supportCallSpec(java.lang.Class aCallSpe) To inform that given call spec is supported by the OCMP framework .

Method Detail

getConnection

public ConnectionIF getConnection(hp.opencall.media.ccapi.CallSpec aCallSpec)
                           throws hp.opencall.media.common.AccessControlException

Get a Signalling ConnectionIF object given a call spec.

In case of inbound calls, the CallSpec has been previously supplied to the OCMP framework thanks to the CallDispatcher. The call Session has been created and needs the ConnectionIF object to manage the call signalling.

In case of outgoing calls, the OCMP framework needs a ConnectionIF object related to a new CallSpec. The call control will then be done from the returned ConnectionIF.

Parameters:

aCallSpec - specifies the call setup parameters

Throws:

hp.opencall.media.common.AccessControlException - in case of internal connection provider problem

supportCallSpec

public void supportCallSpec(java.lang.Class aCallSpe)
                     throws hp.opencall.media.common.AccessControlException

To inform that given call spec is supported by the OCMP framework .

Throws:

hp.opencall.media.common.AccessControlException

acceptCalls

public void acceptCalls()

Called by the OCMP framework to ask the connection provider to accept future calls.

refuseCalls

public void refuseCalls()

Called by the OCMP framework to ask the connection provider to refuse any future call.

immediateShutdown

public void immediateShutdown(long lpc)

Called by the OCMP framework to ask the connection provider to do an immediate Shutdown

gracefulShutdown

public void gracefulShutdown(long waitTime,
                             long lpc)

Called by the OCMP framework to ask the connection provider to do a graceful Shutdown

exit

public void exit()

The OCMP framework calls this method in order to exit the connection provider. Any existing call must be released. This method occurs during the OCMP shutdown.