org.jvoicexml.documentserver.schemestrategy

Class FileSchemeStrategy

java.lang.Object

org.jvoicexml.documentserver.schemestrategy.FileSchemeStrategy

All Implemented Interfaces:

SchemeStrategy

public final class FileSchemeStrategy
extends java.lang.Object
implements SchemeStrategy

SchemeStrategy to read VoiceXML document from the file system. The files are retrieved by their URI which has to be hierarchical.

Since:

0.3

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCHEME_NAME Scheme for which this scheme strategy is responsible.

Constructor Summary

Constructors

Constructor and Description
FileSchemeStrategy() Construct a new object.

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getInputStream(java.lang.String sessionId, java.net.URI uri, org.jvoicexml.xml.vxml.RequestMethod method, long timeout, java.util.Collection<KeyValuePair> parameters) Opens the external URI and returns an InputStream to the referenced object.
java.lang.String	getScheme() Get the scheme that is handled by this strategy.
void	sessionClosed(java.lang.String sessionId) Notification that the given session is closed.

Methods inherited from class java.lang.Object

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

Field Detail

SCHEME_NAME

public static final java.lang.String SCHEME_NAME

Scheme for which this scheme strategy is responsible.

See Also:

Constant Field Values

Constructor Detail

FileSchemeStrategy

public FileSchemeStrategy()

Construct a new object.

Method Detail

getScheme

public java.lang.String getScheme()

Get the scheme that is handled by this strategy.

Specified by:

getScheme in interface SchemeStrategy

Returns:

Scheme that is handled by this strategy.

getInputStream

public java.io.InputStream getInputStream(java.lang.String sessionId,
                                          java.net.URI uri,
                                          org.jvoicexml.xml.vxml.RequestMethod method,
                                          long timeout,
                                          java.util.Collection<KeyValuePair> parameters)
                                   throws BadFetchError

Opens the external URI and returns an InputStream to the referenced object.

Specified by:

getInputStream in interface SchemeStrategy

Parameters:

sessionId - the Id of the current JVoiceXML session.

uri - the URI of the object to open.

method - type of the request method

timeout - fetch timeout in msec to wait for the content to be returned before throwing an error.badfetch event.

parameters - request parameters

Returns:

InputStream to the referenced object.

Throws:

BadFetchError - error opening the document or unsupported method type

sessionClosed

public void sessionClosed(java.lang.String sessionId)

Notification that the given session is closed. Now the strategy may free any resources related to the given session, e.g. a session with a web server.

Specified by:

sessionClosed in interface SchemeStrategy

Parameters:

sessionId - the Id of the current JVoiceXML session.