org.jvoicexml.documentserver.schemestrategy.builtin

Class BuiltinSchemeStrategy

java.lang.Object

org.jvoicexml.documentserver.schemestrategy.builtin.BuiltinSchemeStrategy

All Implemented Interfaces:

SchemeStrategy

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

Schemestrategy for builtin grammars.

This class provides basic support for built grammars as specified at http://www.w3.org/TR/voicexml20#dmlABuiltins.

The URI can be platform dependent. This implementation expects the URIs to be of the following form

builtin:<mode>/<type>[?parameters]

where mode is a lower-case presentation of ModeType and type and parameters as specified in http://www.w3.org/TR/voicexml20#dmlABuiltins.

Custom grammar types can be added by addGrammarCreator(GrammarCreator) or setGrammarCreators(Collection).

Since:

0.7.1

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
BuiltinSchemeStrategy() Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	addGrammarCreator(GrammarCreator creator) Adds the specified grammar creator to the list of known grammar creators.
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.
void	setGrammarCreators(java.util.Collection<GrammarCreator> col) Adds the specified grammar creators to the list of known grammar creators.

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

BuiltinSchemeStrategy

public BuiltinSchemeStrategy()

Constructs a new object.

Method Detail

setGrammarCreators

public void setGrammarCreators(java.util.Collection<GrammarCreator> col)

Adds the specified grammar creators to the list of known grammar creators.

Parameters:

col - the creators to add

Since:

0.7.5

addGrammarCreator

public void addGrammarCreator(GrammarCreator creator)

Adds the specified grammar creator to the list of known grammar creators.

Parameters:

creator - the creator to add

Since:

0.7.5

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

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

UnsupportedElementError - the requested element is not supported

java.io.IOException - error creating the input stream

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.

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.