org.jvoicexml.callmanager

Class BaseCallManager

java.lang.Object

org.jvoicexml.callmanager.BaseCallManager

All Implemented Interfaces:

CallManager, TerminalListener

public abstract class BaseCallManager
extends java.lang.Object
implements CallManager, TerminalListener

Base implementation of a CallManager.

Since:

0.7

Constructor Summary

Constructors

Constructor and Description
BaseCallManager() Constructs a new object.

Method Summary

Modifier and Type	Method and Description
boolean	addTerminal(java.lang.String terminal, ConfiguredApplication application) Adds the terminal with the given URI to the list of known terminals.
Session	createSession(Terminal term, CallParameters parameters) Creates a session for the given terminal and initiates a call at JVoiceXml.
protected abstract java.util.Collection<Terminal>	createTerminals() Creates all terminals without starting them.
ConfiguredApplication	getApplication(java.lang.String terminal) Retrieves the application for the given terminal.
java.util.Collection<ConfiguredApplication>	getApplications() Retrieves all configured applications.
JVoiceXml	getJVoiceXml() Retrieves the reference to the interpreter.
protected void	handleStop() Possible post processing when the call manager is shut down after all terminals have been stopped.
protected void	hangupSessions() Calls the hangup for each connected session and stops the terminals.
boolean	isConnected(Terminal terminal) Checks if the given terminal is connected.
void	setApplications(java.util.Collection<ConfiguredApplication> apps) Adds the given list of applications.
void	setConnectionInformationFactory(TerminalConnectionInformationFactory factory) Sets the connection information factory.
void	setJVoiceXml(JVoiceXml jvoicexml) Sets a reference to JVoiceXml.
void	start() Starts the call manager asynchronously.
void	stop() Stops the call manager and all terminals.
void	terminalConnected(Terminal terminal, CallParameters parameters) A connection has been established with the given terminal.
void	terminalDisconnected(Terminal terminal) A connection has been disconnected with the given terminal.
void	terminalError(Terminal terminal, java.lang.String message, java.lang.Throwable cause) An error has occurred while interacting with the terminal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseCallManager

public BaseCallManager()

Constructs a new object.

Method Detail

setJVoiceXml

public final void setJVoiceXml(JVoiceXml jvoicexml)

Sets a reference to JVoiceXml.

Specified by:

setJVoiceXml in interface CallManager

Parameters:

jvoicexml - reference to JVoiceXml.

getJVoiceXml

public final JVoiceXml getJVoiceXml()

Retrieves the reference to the interpreter.

Returns:

the interpreter

setConnectionInformationFactory

public final void setConnectionInformationFactory(TerminalConnectionInformationFactory factory)

Sets the connection information factory.

Parameters:

factory - the connection information container factory.

Since:

0.7

setApplications

public final void setApplications(java.util.Collection<ConfiguredApplication> apps)

Adds the given list of applications.

Parameters:

apps - list of application

addTerminal

public final boolean addTerminal(java.lang.String terminal,
                                 ConfiguredApplication application)

Adds the terminal with the given URI to the list of known terminals.

Parameters:

terminal - identifier for the terminal

application - URI of the application to add.

Returns:

true if the terminal was added.

getApplication

public final ConfiguredApplication getApplication(java.lang.String terminal)

Retrieves the application for the given terminal.

Parameters:

terminal - name of the terminal

Returns:

application

getApplications

public final java.util.Collection<ConfiguredApplication> getApplications()

Retrieves all configured applications.

Returns:

all configured applications.

Since:

0.7.3

start

public final void start()
                 throws NoresourceError,
                        java.io.IOException

Starts the call manager asynchronously.

This means that all terminals are initialized and started. Upon a successful run, all terminal are waiting for incoming connections.

This implementation first creates all terminals by calling createTerminals(). These terminals are then requested to wait for incoming connections by calling Terminal.waitForConnections().

Specified by:

start in interface CallManager

Throws:

NoresourceError - Error starting the call manager.

java.io.IOException - unable to start a terminal

createTerminals

protected abstract java.util.Collection<Terminal> createTerminals()
                                                           throws NoresourceError

Creates all terminals without starting them.

Returns:

all terminals.

Throws:

NoresourceError - error creating a terminal.

Since:

0.7.3

createSession

public final Session createSession(Terminal term,
                                   CallParameters parameters)
                            throws ErrorEvent

Creates a session for the given terminal and initiates a call at JVoiceXml.

Parameters:

term - the connecting terminal

parameters - additional parameters

Returns:

created session.

Throws:

ErrorEvent - Error creating the session.

terminalConnected

public final void terminalConnected(Terminal terminal,
                                    CallParameters parameters)

A connection has been established with the given terminal.

Specified by:

terminalConnected in interface TerminalListener

Parameters:

terminal - the connected terminal.

parameters - additional call parameters

terminalDisconnected

public final void terminalDisconnected(Terminal terminal)

A connection has been disconnected with the given terminal.

Specified by:

terminalDisconnected in interface TerminalListener

Parameters:

terminal - the disconnected terminal.

terminalError

public final void terminalError(Terminal terminal,
                                java.lang.String message,
                                java.lang.Throwable cause)

An error has occurred while interacting with the terminal.

Specified by:

terminalError in interface TerminalListener

Parameters:

terminal - the terminal

message - a detailed message about the error

cause - the error cause.

isConnected

public final boolean isConnected(Terminal terminal)

Checks if the given terminal is connected.

Parameters:

terminal - the terminal

Returns:

true if the given terminal is connected

hangupSessions

protected final void hangupSessions()

Calls the hangup for each connected session and stops the terminals.

stop

public final void stop()

Stops the call manager and all terminals. This method first hangs up all open session by calling terminalDisconnected(Terminal). Next, all terminals are requested to stop waiting for incoming connections by calling Terminal.stopWaiting(). Afterwards it is possible to do some further cleanup by overriding handleStop().

Specified by:

stop in interface CallManager

handleStop

protected void handleStop()

Possible post processing when the call manager is shut down after all terminals have been stopped.

Since:

0.7.3