org.jvoicexml.documentserver

Interface SchemeStrategy

All Known Implementing Classes:

BuiltinSchemeStrategy, FileSchemeStrategy, HttpSchemeStrategy, MappedDocumentStrategy

public interface SchemeStrategy

Strategy to get a VoiceXML document from a repository for a given URI scheme.

A SchemeStrategy is responsible for only one scheme, e.g. http. They have to register at the DocumentServer via the method DocumentServer.addSchemeStrategy(SchemeStrategy).

A SchemeStrategy may store session relevant data to identify a concrete established session with a server.

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.

Method Detail

getScheme

java.lang.String getScheme()

Get the scheme that is handled by this strategy.

Returns:

Scheme that is handled by this strategy.

getInputStream

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,
                                   UnsupportedElementError,
                                   java.io.IOException

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

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

UnsupportedElementError - the requested element is not supported

java.io.IOException - error creating the input stream

Since:

0.3

sessionClosed

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.

Parameters:

sessionId - the Id of the current JVoiceXML session.

Since:

0.7