org.jvoicexml.documentserver.schemestrategy

Class HttpSchemeStrategy

java.lang.Object

org.jvoicexml.documentserver.schemestrategy.HttpSchemeStrategy

All Implemented Interfaces:

SchemeStrategy

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

SchemeStrategy to read VoiceXML document via the HTTP protocol.

This implementation uses the proxy settings that are delivered via the environment variables http.proxyHost and http.proxyPort.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HTTP_SCHEME_NAME Scheme for which this scheme strategy is responsible.
protected static SessionStorage<org.apache.http.impl.client.HttpClientBuilder>	SESSION_STORAGE the storage of session identifiers.

Constructor Summary

Constructors

Constructor and Description
HttpSchemeStrategy() Construct a new object.

Method Summary

Modifier and Type	Method and Description
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	setFetchTimeout(int timeout) Sets the default fetch timeout.
void	setScheme(java.lang.String value) Sets the scheme for this strategy.

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_SCHEME_NAME

public static final java.lang.String HTTP_SCHEME_NAME

Scheme for which this scheme strategy is responsible.

See Also:

Constant Field Values

SESSION_STORAGE

protected static SessionStorage<org.apache.http.impl.client.HttpClientBuilder> SESSION_STORAGE

the storage of session identifiers.

Constructor Detail

HttpSchemeStrategy

public HttpSchemeStrategy()

Construct a new object.

Method Detail

setScheme

public void setScheme(java.lang.String value)

Sets the scheme for this strategy.

Parameters:

value - the new scheme

Since:

0.7.4

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.

setFetchTimeout

public void setFetchTimeout(int timeout)

Sets the default fetch timeout.

Parameters:

timeout - the default fetch timeout.

Since:

0.7

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

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

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.