org.jvoicexml.documentserver.jetty

Class DocumentStorage

java.lang.Object

org.jvoicexml.documentserver.jetty.DocumentStorage

public class DocumentStorage
extends java.lang.Object

A storage for documents for ASR and TTS that are generated while executing a session. The main task of this component is to manage a set of URIs associated with these documents.

Since:

0.7.7

Constructor Summary

Constructors

Constructor and Description
DocumentStorage() 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 from external.
void	clear(java.lang.String sessionId) Clears all documents associated with the given session.
GrammarDocument	getDocument(java.net.URI uri) Retrieves the content of the document.
java.net.URI	resolveBuiltinUri(java.net.URI uri) Resolves the given URI of a builtin grammar to an URI that can be handled by this document server.
void	setGrammarCreators(java.util.Collection<GrammarCreator> col) Adds the specified grammar creators to the list of known grammar creators.
void	setStoragePort(int port) Sets the storage port.
void	start() Starts the document storage.
void	stop() Stops the storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentStorage

public DocumentStorage()

Creates a new object.

Method Detail

setStoragePort

public void setStoragePort(int port)

Sets the storage port.

Parameters:

port - port number for the integrated web server

Since:

0.7.8

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.8

start

public void start()
           throws java.lang.Exception

Starts the document storage. Afterwards it will be ready to serve documents.

Throws:

java.lang.Exception - error starting the web server

Since:

0.7.8

resolveBuiltinUri

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

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

Parameters:

uri - the builtin URI

Returns:

the resolved URI

Since:

0.7.8

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 from external.

Parameters:

sessionId - the id of the initiating session

document - the document to add

Returns:

the URI to access the document

Throws:

java.net.URISyntaxException - if the URI could not be created

getDocument

public GrammarDocument getDocument(java.net.URI uri)
                            throws java.net.URISyntaxException

Retrieves the content of the document.

Parameters:

uri - URI of the document to retrieve, null if there is no such document

Returns:

the document

Throws:

java.net.URISyntaxException - if the URI does not feature a valid path

clear

public void clear(java.lang.String sessionId)
           throws java.net.URISyntaxException

Clears all documents associated with the given session.

Parameters:

sessionId - the id of the session

Throws:

java.net.URISyntaxException - if the URI does not feature a valid path

stop

public void stop()
          throws java.lang.Exception

Stops the storage.

Throws:

java.lang.Exception - error closing the storage

Since:

0.7.7