com.espertech.esperio.http.config

Class ConfigurationHTTPAdapter

java.lang.Object

com.espertech.esperio.http.config.ConfigurationHTTPAdapter

public class ConfigurationHTTPAdapter
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ConfigurationHTTPAdapter()

Method Summary

Modifier and Type	Method and Description
ConfigurationHTTPAdapter	configure() Use the configuration specified in an application resource named esper.cfg.xml.
ConfigurationHTTPAdapter	configure(java.io.File configFile) Use the ConfigurationHTTPAdapter specified in the given application file.
ConfigurationHTTPAdapter	configure(java.lang.String resource) Use the ConfigurationHTTPAdapter specified in the given application resource.
ConfigurationHTTPAdapter	configure(java.net.URL url) Use the ConfigurationHTTPAdapter specified by the given URL.
ConfigurationHTTPAdapter	configureFromString(java.lang.String xml) Use the ConfigurationHTTPAdapter specified by the given XML String.
protected static java.io.InputStream	getConfigurationInputStream(java.lang.String resource) Get the ConfigurationHTTPAdapter file as an InputStream.
java.util.List<GetHandler>	getGetHandlers()
java.util.List<Request>	getRequests()
protected static java.io.InputStream	getResourceAsStream(java.lang.String resource) Returns an input stream from an application resource in the classpath.
java.util.Map<java.lang.String,Service>	getServices()
void	setGetHandlers(java.util.List<GetHandler> getHandlers)
void	setRequests(java.util.List<Request> requests)
void	setServices(java.util.Map<java.lang.String,Service> services)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationHTTPAdapter

public ConfigurationHTTPAdapter()

Method Detail

getServices

public java.util.Map<java.lang.String,Service> getServices()

setServices

public void setServices(java.util.Map<java.lang.String,Service> services)

getGetHandlers

public java.util.List<GetHandler> getGetHandlers()

setGetHandlers

public void setGetHandlers(java.util.List<GetHandler> getHandlers)

getRequests

public java.util.List<Request> getRequests()

setRequests

public void setRequests(java.util.List<Request> requests)

configure

public ConfigurationHTTPAdapter configure()
                                   throws java.lang.RuntimeException

Use the configuration specified in an application resource named esper.cfg.xml.

Returns:

Configuration initialized from the resource

Throws:

java.lang.RuntimeException - thrown to indicate error reading configuration

configure

public ConfigurationHTTPAdapter configure(java.lang.String resource)
                                   throws java.lang.RuntimeException

Use the ConfigurationHTTPAdapter specified in the given application resource. The format of the resource is defined in esper-configuration-(version).xsd.

The resource is found via getConfigurationInputStream(resource). That method can be overridden to implement an arbitrary lookup strategy.

See getResourceAsStream for information on how the resource name is resolved.

Parameters:

resource - if the file name of the resource

Returns:

ConfigurationHTTPAdapter initialized from the resource

Throws:

java.lang.RuntimeException - thrown to indicate error reading configuration

getConfigurationInputStream

protected static java.io.InputStream getConfigurationInputStream(java.lang.String resource)
                                                          throws java.lang.RuntimeException

Get the ConfigurationHTTPAdapter file as an InputStream. Might be overridden by subclasses to allow the ConfigurationHTTPAdapter to be located by some arbitrary mechanism.

See getResourceAsStream for information on how the resource name is resolved.

Parameters:

resource - is the resource name

Returns:

input stream for resource

Throws:

java.lang.RuntimeException - thrown to indicate error reading configuration

configureFromString

public ConfigurationHTTPAdapter configureFromString(java.lang.String xml)
                                             throws java.lang.RuntimeException

Use the ConfigurationHTTPAdapter specified by the given XML String. The format of the document obtained from the URL is defined in esper-configuration-(version).xsd.

Parameters:

xml - XML string

Returns:

A ConfigurationHTTPAdapter configured via the file

Throws:

java.lang.RuntimeException - is thrown when the URL could not be access

configure

public ConfigurationHTTPAdapter configure(java.net.URL url)
                                   throws java.lang.RuntimeException

Use the ConfigurationHTTPAdapter specified by the given URL. The format of the document obtained from the URL is defined in esper-configuration-(version).xsd.

Parameters:

url - URL from which you wish to load the configuration

Returns:

A ConfigurationHTTPAdapter configured via the file

Throws:

java.lang.RuntimeException - is thrown when the URL could not be access

getResourceAsStream

protected static java.io.InputStream getResourceAsStream(java.lang.String resource)

Returns an input stream from an application resource in the classpath.

The method first removes the '/' character from the resource name if the first character is '/'.

The lookup order is as follows:

If a thread context class loader exists, use Thread.currentThread().getResourceAsStream to obtain an InputStream.

If no input stream was returned, use the Configuration.class.getResourceAsStream. to obtain an InputStream.

If no input stream was returned, use the Configuration.class.getClassLoader().getResourceAsStream. to obtain an InputStream.

If no input stream was returned, throw an Exception.

Parameters:

resource - to get input stream for

Returns:

input stream for resource

configure

public ConfigurationHTTPAdapter configure(java.io.File configFile)
                                   throws java.lang.RuntimeException

Use the ConfigurationHTTPAdapter specified in the given application file. The format of the file is defined in esper-configuration-(version).xsd.

Parameters:

configFile - File from which you wish to load the configuration

Returns:

A ConfigurationHTTPAdapter configured via the file

Throws:

java.lang.RuntimeException - when the file could not be found