org.esigate

Class DriverFactory

java.lang.Object

org.esigate.DriverFactory

public final class DriverFactory
extends Object

Factory class used to configure and retrieve Driver INSTANCIES.

Author:

Stanislav Bernatskyi, Francois-Xavier Bonnet, Nicolas Richeton

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_CONF_LOCATION System property used to specify of esigate configuration, outside of the classpath.

Method Summary

Modifier and Type	Method and Description
static void	configure() Loads all instances according to default configuration file.
static void	configure(Properties props) Loads all instances according to the properties parameter.
static void	configure(String name, Properties props) Registers new Driver under provided name with specified properties.
static void	ensureConfigured() Ensure configuration has been loaded at least once.
static URL	getConfigUrl() Returns the URL of the configuration file.
static Driver	getInstance() Retrieves the default instance of this class that is configured according to the properties file (driver.properties).
static Driver	getInstance(String instanceName) Retrieves the default instance of this class that is configured according to the properties file (driver.properties).
static Collection<Driver>	getInstances() Returns the collection of all Driver instances.
static org.apache.http.client.methods.CloseableHttpResponse	proxy(IncomingRequest incomingRequest) Selects the Driver instance for this request based on the mappings declared in the configuration and executes it against the selected Driver instance.
static void	put(String instanceName, Driver instance) Add/replace instance in current instance map.

Methods inherited from class java.lang.Object

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

Field Detail

PROP_CONF_LOCATION

public static final String PROP_CONF_LOCATION

System property used to specify of esigate configuration, outside of the classpath.

See Also:

Constant Field Values

Method Detail

getInstances

public static Collection<Driver> getInstances()

Returns the collection of all Driver instances.

Returns:

All configured driver

configure

public static void configure()

Loads all instances according to default configuration file.

configure

public static void configure(Properties props)

Loads all instances according to the properties parameter.

Parameters:

props - properties to use for configuration

configure

public static void configure(String name,
                             Properties props)

Registers new Driver under provided name with specified properties.

Parameters:

name - the name of the instance

props - the Properties for the instance

getInstance

public static Driver getInstance(String instanceName)

Retrieves the default instance of this class that is configured according to the properties file (driver.properties).

Parameters:

instanceName - The name of the instance (corresponding to the prefix in the driver.properties file)

Returns:

the named instance

getInstance

public static Driver getInstance()

Retrieves the default instance of this class that is configured according to the properties file (driver.properties).

Returns:

the default instance

put

public static void put(String instanceName,
                       Driver instance)

Add/replace instance in current instance map. Work on a copy of the current map and replace it atomically.

Parameters:

instanceName - The name of the provider

instance - The instance

ensureConfigured

public static void ensureConfigured()

Ensure configuration has been loaded at least once. Helps to prevent delay on first call because of initialization.

getConfigUrl

public static URL getConfigUrl()

Returns the URL of the configuration file.

Returns:

The URL of the configuration file.

proxy

public static org.apache.http.client.methods.CloseableHttpResponse proxy(IncomingRequest incomingRequest)
                                                                  throws IOException,
                                                                         HttpErrorPage

Selects the Driver instance for this request based on the mappings declared in the configuration and executes it against the selected Driver instance.

Parameters:

incomingRequest - the incoming request

Returns:

a MatchedRequest containing the Driver instance and the relative URI

Throws:

HttpErrorPage - if no instance was found for this request or if an error occurs

IOException - if an error occurs