org.jvoicexml

Class JVoiceXmlMain

java.lang.Object

java.lang.Thread

org.jvoicexml.JVoiceXmlMain

All Implemented Interfaces:

java.lang.Runnable, JVoiceXml, JVoiceXmlCore

public final class JVoiceXmlMain
extends java.lang.Thread
implements JVoiceXmlCore

Main class of the JVoiceXML VoiceXML interpreter.

This class manages all central resources and serves as a Session factory. It is implemented as a singleton and cannot be instantiated from outside. On startup, it acquires all needed resources and serves in turn as a source to retrieve references to the DocumentServer and the ImplementationPlatform.

During its life, the interpreter passes several states as shown in the following figure. JVoiceXML can only process calls while it is in the running state.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
JVoiceXmlMain() Construct a new object.
JVoiceXmlMain(Configuration config) Construct a new object with the given configuration object.

Method Summary

Modifier and Type	Method and Description
void	addListener(JVoiceXmlMainListener listener) Adds the given listener.
Session	createSession(ConnectionInformation info) Creates a new session.
Configuration	getConfiguration() Retrieves the configuration object if any.
DocumentServer	getDocumentServer() Retrieves a reference to the document server.
GrammarProcessor	getGrammarProcessor() Retrieves a reference to the grammar processor.
java.lang.String	getVersion() Retrieves the version information of JVoiceXml.
void	removeListener(JVoiceXmlMainListener listener) removes the given listener.
void	run() Starts the VoiceXML interpreter.
void	setCallManager(java.util.Collection<CallManager> managers) Set the call managers to use.
void	setGrammarProcessor(GrammarProcessor processor) Sets the grammar processor.
void	setImplementationPlatformFactory(ImplementationPlatformFactory factory) Sets the implementation platform factory.
void	shutdown() Shuts down the interpreter and frees all resources.
void	waitShutdownComplete() Waits until the VoiceXML interpreter has been shutdown.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

JVoiceXmlMain

public JVoiceXmlMain()

Construct a new object.

JVoiceXmlMain

public JVoiceXmlMain(Configuration config)

Construct a new object with the given configuration object.

Parameters:

config - the initial configuration

Method Detail

getVersion

public java.lang.String getVersion()

Retrieves the version information of JVoiceXml. The version information is created by <VERSION_MAJOR>.<VERSION_MINOR>.<VERSION_BUGFIX_LEVEL>.<EA|GA> .

Specified by:

getVersion in interface JVoiceXml

Returns:

Version number.

addListener

public void addListener(JVoiceXmlMainListener listener)

Adds the given listener.

Parameters:

listener - the listener to add.

removeListener

public void removeListener(JVoiceXmlMainListener listener)

removes the given listener.

Parameters:

listener - the listener to remove.

createSession

public Session createSession(ConnectionInformation info)
                      throws ErrorEvent

Creates a new session.

The Session is the entry point to start the interpreter. A session is obtained by a ConnectionInformation.

Specified by:

createSession in interface JVoiceXml

Parameters:

info - information about the current connection, maybe null. If it is null the default implementation platform is used.

Returns:

The new session.

Throws:

ErrorEvent - Error creating the session.

getConfiguration

public Configuration getConfiguration()

Retrieves the configuration object if any.

Specified by:

getConfiguration in interface JVoiceXmlCore

Returns:

the configuration object, null if there is no configuration available.

getDocumentServer

public DocumentServer getDocumentServer()

Retrieves a reference to the document server.

Specified by:

getDocumentServer in interface JVoiceXmlCore

Returns:

The document server.

getGrammarProcessor

public GrammarProcessor getGrammarProcessor()

Retrieves a reference to the grammar processor.

Specified by:

getGrammarProcessor in interface JVoiceXmlCore

Returns:

The grammar processor.

Since:

0.3

setImplementationPlatformFactory

public void setImplementationPlatformFactory(ImplementationPlatformFactory factory)

Sets the implementation platform factory.

The factory may need further configuration. See Configurable.init(Configuration).

Parameters:

factory - the implementation platform factory

Since:

0.7.4

setGrammarProcessor

public void setGrammarProcessor(GrammarProcessor processor)

Sets the grammar processor.

The factory may need further configuration. See Configurable.init(Configuration).

Parameters:

processor - the grammar processor.

Since:

0.7.4

setCallManager

public void setCallManager(java.util.Collection<CallManager> managers)
                    throws java.io.IOException,
                           NoresourceError

Set the call managers to use.

Parameters:

managers - the call managers.

Throws:

java.io.IOException - error starting a call manager.

NoresourceError - error starting a call manager.

Since:

0.7.4

run

public void run()

Starts the VoiceXML interpreter.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

Since:

0.4

shutdown

public void shutdown()

Shuts down the interpreter and frees all resources.

Specified by:

shutdown in interface JVoiceXml

waitShutdownComplete

public void waitShutdownComplete()

Waits until the VoiceXML interpreter has been shutdown.

Since:

0.4