org.jvoicexml

Interface DocumentServer

All Known Implementing Classes:

JVoiceXmlDocumentServer

public interface DocumentServer

A document server processes requests from a client application.

Usually these requests serve to obtain resources like VoiceXML documents, grammar documents and audio files from a repository.

Since:

0.5.5

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TEXT_PLAIN Constant for the object type text/plain to retrieve.
static java.lang.String	TEXT_XML Constant for the object type text/xml to retrieve.

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.
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 attributes) 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	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.

Field Detail

TEXT_PLAIN

static final java.lang.String TEXT_PLAIN

Constant for the object type text/plain to retrieve.

See Also:

Constant Field Values

TEXT_XML

static final java.lang.String TEXT_XML

Constant for the object type text/xml to retrieve.

See Also:

Constant Field Values

Method Detail

start

void start()
    throws java.lang.Exception

Starts this document server.

Throws:

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

Since:

0.7.7

getDocument

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

Gets the document with the given URI.

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.

resolveBuiltinUri

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.

Parameters:

uri - the builtin URI

Returns:

the resolved URI

Since:

0.7.8

addGrammarDocument

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.

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

Since:

0.7.7

getGrammarDocument

GrammarDocument getGrammarDocument(java.lang.String sessionId,
                                   java.net.URI uri,
                                   FetchAttributes attributes)
                            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.

Parameters:

sessionId - the Id of the current JVoiceXML session

uri - Where to find the grammar.

attributes - 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

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.

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

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.

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.

Since:

0.6

storeAudio

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

Stores the audio from the given stream.

Parameters:

in - stream to read the audio data from

Returns:

URI of the file.

Throws:

BadFetchError - Error writing.

sessionClosed

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.

Parameters:

sessionId - the Id of the current JVoiceXML session.

Since:

0.7

stop

void stop()

Stops this document server.

Since:

0.7.7