org.jvoicexml
Interface DocumentServer

All Known Implementing Classes:

JVoiceXmlDocumentServer

public interface DocumentServer

A document server processes requests from a client application.

The document server evaluates the scheme of the incoming requests and calls the appropriate SchemeStrategy.

Since:

0.5.5

Copyright © 2006-2007 JVoiceXML group - http://jvoicexml.sourceforge.net/

Version:

$Revision: 213 $

Author:

Dirk Schnelle

Field Summary

static String

CONFIG_KEY Configuration key.

Method Summary

AudioInputStream	getAudioInputStream(URI uri) Retrieves an AudioStream to the audio file with the given URI.
VoiceXmlDocument	getDocument(URI uri) Gets the document with the given URI.
GrammarDocument	getGrammarDocument(URI uri) Returns the external Grammar referenced by URI.

Field Detail

CONFIG_KEY

static final String CONFIG_KEY

Configuration key.

See Also:

Constant Field Values

Method Detail

getDocument

VoiceXmlDocument getDocument(URI uri)
                             throws BadFetchError

Gets the document with the given URI.

Parameters:

uri - URI of the document.

Returns:

VoiceXML document with the given URI.

Throws:

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

getGrammarDocument

GrammarDocument getGrammarDocument(URI uri)
                                   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:

uri - Where to find the grammar.

Returns:

ExternalGrammar the grammar referenced by the URI.

Throws:

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

getAudioInputStream

AudioInputStream getAudioInputStream(URI uri)
                                     throws BadFetchError

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

Parameters:

uri - URI of the audio file.

Returns:

AudioInputStream for the audio file.

Throws:

BadFetchError - Error retrieving the audio file.