org.esigate

Class Driver

java.lang.Object

org.esigate.Driver

public final class Driver
extends Object

Main class used to retrieve data from a provider application using HTTP requests. Data can be retrieved as binary streams or as String for text data. To improve performance, the Driver uses a cache that can be configured depending on the needs.

Author:

Francois-Xavier Bonnet, Nicolas Richeton, Sylvain Sicard

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Driver.DriverBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Driver()

Method Summary

Modifier and Type	Method and Description
static Driver.DriverBuilder	builder()
DriverConfiguration	getConfiguration() Get current driver configuration.
ContentTypeHelper	getContentTypeHelper()
EventManager	getEventManager() Get current event manager for this driver instance.
RequestExecutor	getRequestExecutor()
UrlRewriter	getUrlRewriter()
org.apache.http.client.methods.CloseableHttpResponse	proxy(String relUrl, IncomingRequest incomingRequest, Renderer... renderers) Retrieves a resource from the provider application and transforms it using the Renderer passed as a parameter.
org.apache.http.client.methods.CloseableHttpResponse	render(String pageUrl, IncomingRequest incomingRequest, Renderer... renderers) Perform rendering on a single url content, and append result to "writer".
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Driver

protected Driver()

Method Detail

builder

public static Driver.DriverBuilder builder()

getEventManager

public EventManager getEventManager()

Get current event manager for this driver instance.

Returns:

event manager.

render

public org.apache.http.client.methods.CloseableHttpResponse render(String pageUrl,
                                                                   IncomingRequest incomingRequest,
                                                                   Renderer... renderers)
                                                            throws IOException,
                                                                   HttpErrorPage

Perform rendering on a single url content, and append result to "writer". Automatically follows redirects

Parameters:

pageUrl - Address of the page containing the template

incomingRequest - originating request object

renderers - the renderers to use in order to transform the output

Returns:

The resulting response

Throws:

IOException - If an IOException occurs while writing to the writer

HttpErrorPage - If an Exception occurs while retrieving the template

proxy

public org.apache.http.client.methods.CloseableHttpResponse proxy(String relUrl,
                                                                  IncomingRequest incomingRequest,
                                                                  Renderer... renderers)
                                                           throws IOException,
                                                                  HttpErrorPage

Retrieves a resource from the provider application and transforms it using the Renderer passed as a parameter.

Parameters:

relUrl - the relative URL to the resource

incomingRequest - the request

renderers - the renderers to use to transform the output

Returns:

The resulting response.

Throws:

IOException - If an IOException occurs while writing to the response

HttpErrorPage - If the page contains incorrect tags

getConfiguration

public DriverConfiguration getConfiguration()

Get current driver configuration.

This method is not intended to get a WRITE access to the configuration.

This may be supported in future versions (testing is needed). For the time being, changing configuration settings after getting access through this method is UNSUPPORTED and SHOULD NOT be used.

Returns:

current configuration

getRequestExecutor

public RequestExecutor getRequestExecutor()

toString

public String toString()

Overrides:

toString in class Object

getContentTypeHelper

public ContentTypeHelper getContentTypeHelper()

getUrlRewriter

public UrlRewriter getUrlRewriter()