org.jvoicexml.interpreter

Class JVoiceXmlSession

java.lang.Object

java.lang.Thread

org.jvoicexml.interpreter.JVoiceXmlSession

All Implemented Interfaces:

java.lang.Runnable, EventSubscriber, Session

public class JVoiceXmlSession
extends java.lang.Thread
implements Session, EventSubscriber

Implementation of a Session.

Each session is started in a new thread with the session id as the name.

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
JVoiceXmlSession(ImplementationPlatform ip, JVoiceXmlCore jvxml, ConnectionInformation connectionInformation, Profile prof) Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	addSessionListener(DetailedSessionListener listener) Adds the given session listener to the list of registered session listeners.
void	addSessionListener(SessionListener listener) Adds the session listener.
Application	call(java.net.URI uri) Handles a call request.
Application	getApplication() Retrieves the application that is currently being processed.
DataModel	getDataModel() Retrieves the data model.
DocumentServer	getDocumentServer() Retrieves a reference to the document server.
DtmfInput	getDtmfInput() Retrieves the DTMF input device.
GrammarProcessor	getGrammarProcessor() Retrieves a reference to the grammar processor.
ImplementationPlatform	getImplementationPlatform() Retrieves a reference to the used implementation platform.
ErrorEvent	getLastError() Retrieves an error, if any, that happened during call processing.
Profile	getProfile() Retrieves the profile.
ScopeObserver	getScopeObserver() Retrieves the scope observer for this session.
java.lang.String	getSessionId() Retrieves the universal unique identifier for this session.
VoiceXmlInterpreterContext	getVoiceXmlInterpreterContext() Retrieve the VoiceXmlInterpreterContext related to this session.
void	hangup() Closes this session.
boolean	hasEnded() Checks if this session has ended.
void	onEvent(JVoiceXMLEvent event) Notification about the given event.
void	removeSessionListener(DetailedSessionListener listener) Removes the given session listener from the list of registered session listeners.
void	removeSessionListener(SessionListener listener) Removes the session listener.
void	run() Session working method.
void	waitSessionEnd() Delays until the session ends.

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

JVoiceXmlSession

public JVoiceXmlSession(ImplementationPlatform ip,
                        JVoiceXmlCore jvxml,
                        ConnectionInformation connectionInformation,
                        Profile prof)

Constructs a new object.

Parameters:

ip - the implementation platform.

jvxml - the main object to retrieve further resources.

connectionInformation - the connection information to use

prof - the profile

Method Detail

addSessionListener

public void addSessionListener(SessionListener listener)

Adds the session listener.

Specified by:

addSessionListener in interface Session

Parameters:

listener - the session listener to add.

removeSessionListener

public void removeSessionListener(SessionListener listener)

Removes the session listener.

Specified by:

removeSessionListener in interface Session

Parameters:

listener - the session listener to remove.

addSessionListener

public void addSessionListener(DetailedSessionListener listener)

Adds the given session listener to the list of registered session listeners.

Parameters:

listener - the listener to add

removeSessionListener

public void removeSessionListener(DetailedSessionListener listener)

Removes the given session listener from the list of registered session listeners.

Parameters:

listener - the listener to remove

getSessionId

public java.lang.String getSessionId()

Retrieves the universal unique identifier for this session.

Specified by:

getSessionId in interface Session

Returns:

Universal unique identifier for this session.

getProfile

public Profile getProfile()

Retrieves the profile.

Returns:

the profile

Since:

0.7.7

call

public Application call(java.net.URI uri)
                 throws ErrorEvent

Handles a call request.

Starts processing of the given application and returns immediately.

Since this method returns immediately, it offers no means to monitor the call processing and catch exceptions. Therefore clients are requested to use the Session.waitSessionEnd() method to monitor the session. Another way can be via the Telephony interface and calling Session.getLastError(). However, the latter option relies on the concrete implementation.

Ensure that you call Session.hangup() after this call to ensure that resources like ASR and TTS are released.

Starts this session in a new thread.

Specified by:

call in interface Session

Parameters:

uri - URI of the first document to load.

Returns:

called application

Throws:

ErrorEvent - Error initiating the call.

hangup

public void hangup()

Closes this session. After a session is closed, it can not be reopened e.g., to call another application.

Specified by:

hangup in interface Session

getDtmfInput

public DtmfInput getDtmfInput()
                       throws NoresourceError,
                              ConnectionDisconnectHangupEvent

Retrieves the DTMF input device.

Specified by:

getDtmfInput in interface Session

Returns:

DTMF input device.

Throws:

NoresourceError - Input device is not available.

ConnectionDisconnectHangupEvent - the user hung up

getApplication

public Application getApplication()

Retrieves the application that is currently being processed.

Specified by:

getApplication in interface Session

Returns:

the current application

waitSessionEnd

public void waitSessionEnd()
                    throws ErrorEvent

Delays until the session ends.

Specified by:

waitSessionEnd in interface Session

Throws:

ErrorEvent - Error waiting for the end of the call.

hasEnded

public boolean hasEnded()

Checks if this session has ended.

Specified by:

hasEnded in interface Session

Returns:

true if the session has ended.

run

public void run()

Session working method.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

getImplementationPlatform

public ImplementationPlatform getImplementationPlatform()

Retrieves a reference to the used implementation platform.

Returns:

The used implementation platform.

getDocumentServer

public DocumentServer getDocumentServer()

Retrieves a reference to the document server.

Returns:

The document server.

getGrammarProcessor

public GrammarProcessor getGrammarProcessor()

Retrieves a reference to the grammar processor.

Returns:

The grammar processor.

Since:

0.3

getVoiceXmlInterpreterContext

public VoiceXmlInterpreterContext getVoiceXmlInterpreterContext()

Retrieve the VoiceXmlInterpreterContext related to this session.

Returns:

The related context.

getScopeObserver

public ScopeObserver getScopeObserver()

Retrieves the scope observer for this session.

Returns:

The scope observer.

getDataModel

public DataModel getDataModel()

Retrieves the data model.

Returns:

the data model

Since:

0.7.7

getLastError

public ErrorEvent getLastError()

Retrieves an error, if any, that happened during call processing.

Specified by:

getLastError in interface Session

Returns:

an error that happened during call processing, null if there was no error.

onEvent

public void onEvent(JVoiceXMLEvent event)

Notification about the given event. Notifies all detailed session listeners about relevant thing happening on the EventBus.

Specified by:

onEvent in interface EventSubscriber

Parameters:

event - the event