com.espertech.esperio.socket.config
Class ConfigurationSocketAdapter

java.lang.Object
  com.espertech.esperio.socket.config.ConfigurationSocketAdapter

public class ConfigurationSocketAdapter
extends java.lang.Object

Constructor Summary

ConfigurationSocketAdapter()

Method Summary

ConfigurationSocketAdapter	configure() Use the configuration specified in an application resource named esper.cfg.xml.
ConfigurationSocketAdapter	configure(java.io.File configFile) Use the ConfigurationSocketAdapter specified in the given application file.
ConfigurationSocketAdapter	configure(java.lang.String resource) Use the ConfigurationSocketAdapter specified in the given application resource.
ConfigurationSocketAdapter	configure(java.net.URL url) Use the ConfigurationSocketAdapter specified by the given URL.
ConfigurationSocketAdapter	configureFromString(java.lang.String xml) Use the ConfigurationSocketAdapter specified by the given XML String.
protected static java.io.InputStream	getConfigurationInputStream(java.lang.String resource) Get the ConfigurationSocketAdapter file as an InputStream.
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,SocketConfig>	getSockets()
void	setSockets(java.util.Map<java.lang.String,SocketConfig> sockets)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationSocketAdapter

public ConfigurationSocketAdapter()

Method Detail

getSockets

public java.util.Map<java.lang.String,SocketConfig> getSockets()

setSockets

public void setSockets(java.util.Map<java.lang.String,SocketConfig> sockets)

configure

public ConfigurationSocketAdapter 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 ConfigurationSocketAdapter configure(java.lang.String resource)
                                     throws java.lang.RuntimeException

Use the ConfigurationSocketAdapter specified in the given application resource. The format of the resource is defined in esper-configuration-2.0.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:

ConfigurationSocketAdapter 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 ConfigurationSocketAdapter file as an InputStream. Might be overridden by subclasses to allow the ConfigurationSocketAdapter 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 ConfigurationSocketAdapter configureFromString(java.lang.String xml)
                                               throws java.lang.RuntimeException

Use the ConfigurationSocketAdapter specified by the given XML String. The format of the document obtained from the URL is defined in esper-configuration-2.0.xsd.

Parameters:

xml - XML string

Returns:

A ConfigurationSocketAdapter configured via the file

Throws:

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

configure

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

Use the ConfigurationSocketAdapter specified by the given URL. The format of the document obtained from the URL is defined in esper-configuration-2.0.xsd.

Parameters:

url - URL from which you wish to load the configuration

Returns:

A ConfigurationSocketAdapter 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 ConfigurationSocketAdapter configure(java.io.File configFile)
                                     throws java.lang.RuntimeException

Use the ConfigurationSocketAdapter specified in the given application file. The format of the file is defined in esper-configuration-2.0.xsd.

Parameters:

configFile - File from which you wish to load the configuration

Returns:

A ConfigurationSocketAdapter configured via the file

Throws:

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