org.jvoicexml.documentserver

Class JVoiceXmlDocumentServer

java.lang.Object

org.jvoicexml.documentserver.JVoiceXmlDocumentServer

All Implemented Interfaces:

DocumentServer

public final class JVoiceXmlDocumentServer
extends java.lang.Object
implements DocumentServer

Basic implementation of a DocumentServer.

This implementation offers an extensible support for multiple schemes. All known handlers for schemes are held in a list of SchemeStrategys.

Field Summary

Fields inherited from interface org.jvoicexml.DocumentServer

TEXT_PLAIN, TEXT_XML

Constructor Summary

Constructors

Constructor and Description
JVoiceXmlDocumentServer() Creates a new object.

Method Summary

Modifier and Type	Method and Description
java.net.URI	addGrammarDocument(java.lang.String sessionId, GrammarDocument document) Adds the given grammar document to the documents store and retrieves the URI to access it.
void	addSchemeStrategy(SchemeStrategy strategy) Adds the given scheme strategy.
javax.sound.sampled.AudioInputStream	getAudioInputStream(java.lang.String sessionId, java.net.URI uri) Retrieves an AudioStream to the audio file with the given URI.
org.jvoicexml.xml.vxml.VoiceXmlDocument	getDocument(java.lang.String sessionId, DocumentDescriptor descriptor) Gets the document with the given URI.
GrammarDocument	getGrammarDocument(java.lang.String sessionId, java.net.URI uri, FetchAttributes attrs) Returns the external Grammar referenced by URI.
java.lang.Object	getObject(java.lang.String sessionId, DocumentDescriptor descriptor, java.lang.String type) Retrieves an object of the given type from the given URI.
java.net.URI	resolveBuiltinUri(java.net.URI uri) Resolves the given URI ofg a builtin grammar to an URI that can be handled by this document server.
void	sessionClosed(java.lang.String sessionId) Notification that the given session is closed.
void	setDocumentStorage(DocumentStorage documentStorage) Sets the document storage
void	setFetchAttributes(FetchAttributes attrs) Sets the default fetch attributes.
void	setSchemeStrategies(java.util.List<SchemeStrategy> schemeStrategies) Adds the given list of strategies for schemes to the supported schemes.
void	start() Starts this document server.
void	stop() Stops this document server.
java.net.URI	storeAudio(javax.sound.sampled.AudioInputStream in) Stores the audio from the given stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

JVoiceXmlDocumentServer

public JVoiceXmlDocumentServer()

Creates a new object.

This method should not be called by any application. Use JVoiceXml.getDocumentServer() to obtain a reference to the document server.

Method Detail

setDocumentStorage

public void setDocumentStorage(DocumentStorage documentStorage)

Sets the document storage

Parameters:

documentStorage - the document storage

Since:

0.7.8

start

public void start()
           throws java.lang.Exception

Starts this document server.

Specified by:

start in interface DocumentServer

Throws:

java.lang.Exception - error starting the document server.

setSchemeStrategies

public void setSchemeStrategies(java.util.List<SchemeStrategy> schemeStrategies)

Adds the given list of strategies for schemes to the supported schemes.

Parameters:

schemeStrategies - List with strategies.

Since:

0.5

setFetchAttributes

public void setFetchAttributes(FetchAttributes attrs)

Sets the default fetch attributes.

Parameters:

attrs - default fetch attributes.

Since:

0.7

getDocument

public org.jvoicexml.xml.vxml.VoiceXmlDocument getDocument(java.lang.String sessionId,
                                                           DocumentDescriptor descriptor)
                                                    throws BadFetchError

Gets the document with the given URI.

Specified by:

getDocument in interface DocumentServer

Parameters:

sessionId - the Id of the current JVoiceXML session

descriptor - descriptor for the document to fetch.

Returns:

VoiceXML document with the given URI.

Throws:

BadFetchError - The URI does not reference a document or an error occurred retrieving the document.

addSchemeStrategy

public void addSchemeStrategy(SchemeStrategy strategy)

Adds the given scheme strategy.

Parameters:

strategy - Scheme strategy to be added.

resolveBuiltinUri

public java.net.URI resolveBuiltinUri(java.net.URI uri)

Resolves the given URI ofg a builtin grammar to an URI that can be handled by this document server.

Specified by:

resolveBuiltinUri in interface DocumentServer

Parameters:

uri - the builtin URI

Returns:

the resolved URI

addGrammarDocument

public java.net.URI addGrammarDocument(java.lang.String sessionId,
                                       GrammarDocument document)
                                throws java.net.URISyntaxException

Adds the given grammar document to the documents store and retrieves the URI to access it.

Specified by:

addGrammarDocument in interface DocumentServer

Parameters:

sessionId - the id of the initiating session

document - the document to add

Returns:

the URI to access the document

Throws:

java.net.URISyntaxException - error generating the URI for the document

getGrammarDocument

public GrammarDocument getGrammarDocument(java.lang.String sessionId,
                                          java.net.URI uri,
                                          FetchAttributes attrs)
                                   throws BadFetchError

Returns the external Grammar referenced by URI.

If more than one grammar is available at the given URI, the grammar with the optional type is preferred. If preferredType is null, the ContentServer does not have to care about the preferredType.

Specified by:

getGrammarDocument in interface DocumentServer

Parameters:

sessionId - the Id of the current JVoiceXML session

uri - Where to find the grammar.

attrs - attributes governing the fetch.

Returns:

the grammar referenced by the URI.

Throws:

BadFetchError - The URI does not reference a document or an error occurred retrieving the document.

getAudioInputStream

public javax.sound.sampled.AudioInputStream getAudioInputStream(java.lang.String sessionId,
                                                                java.net.URI uri)
                                                         throws BadFetchError

Retrieves an AudioStream to the audio file with the given URI.

Specified by:

getAudioInputStream in interface DocumentServer

Parameters:

sessionId - the Id of the current JVoiceXML session

uri - URI of the audio file.

Returns:

AudioInputStream for the audio file.

Throws:

BadFetchError - Error retrieving the audio file.

getObject

public java.lang.Object getObject(java.lang.String sessionId,
                                  DocumentDescriptor descriptor,
                                  java.lang.String type)
                           throws BadFetchError

Retrieves an object of the given type from the given URI. Currently only text/plain and text/xml are supported.

Specified by:

getObject in interface DocumentServer

Parameters:

sessionId - the Id of the current JVoiceXML session

descriptor - descriptor for the document to fetch.

type - the type, e.g. text/plain.

Returns:

retrieved object

Throws:

BadFetchError - Error retrieving the object.

storeAudio

public java.net.URI storeAudio(javax.sound.sampled.AudioInputStream in)
                        throws BadFetchError

Stores the audio from the given stream.

Specified by:

storeAudio in interface DocumentServer

Parameters:

in - stream to read the audio data from

Returns:

URI of the file.

Throws:

BadFetchError - Error writing.

sessionClosed

public void sessionClosed(java.lang.String sessionId)

Notification that the given session is closed. Now the document server may free any resources related to the given session.

Specified by:

sessionClosed in interface DocumentServer

Parameters:

sessionId - the Id of the current JVoiceXML session.

stop

public void stop()

Description copied from interface: DocumentServer

Stops this document server.

Specified by:

stop in interface DocumentServer