org.eclipse.smila.connectivity.framework.httphandler
Class CrawlerHandler

java.lang.Object
  org.eclipse.smila.http.server.util.ARequestHandler
      org.eclipse.smila.http.server.json.JsonRequestHandler
          org.eclipse.smila.connectivity.framework.httphandler.BaseConnectivityHandler
              org.eclipse.smila.connectivity.framework.httphandler.CrawlerHandler

All Implemented Interfaces:

HttpHandler, RequestHandler

public class CrawlerHandler
extends BaseConnectivityHandler

Implements the handling of HTTP requests to request a single crawler with data source.
URL pattern: smila/crawlers/-dataSourceId-
Methods allowed: GET, POST

Field Summary

static java.lang.String	KEY_DATA_SOURCE_ID the key for the data source id.
static java.lang.String	KEY_IMPORT_RUN_ID the key for the import run id.
static java.lang.String	KEY_JOB_NAME the key for the job name.

Fields inherited from class org.eclipse.smila.http.server.json.JsonRequestHandler

FACTORY, HTTP_UTILS

Constructor Summary

CrawlerHandler()

Method Summary

protected boolean	isValidMethod(java.lang.String method, java.lang.String requestUri) Checks if the handler allows the HTTP method.
java.lang.Object	process(java.lang.String method, java.lang.String requestUri, Record inputRecord) process input record and return result object.
void	setCrawlerController(CrawlerController crawlerController) OSGi method to set the CrawlerController.
void	unsetCrawlerController(CrawlerController crawlerController) OSGi method to unset the CrawlerController.

Methods inherited from class org.eclipse.smila.connectivity.framework.httphandler.BaseConnectivityHandler

getErrorStatus

Methods inherited from class org.eclipse.smila.http.server.json.JsonRequestHandler

getRequestHost, getSuccessStatus, getSuccessStatus, handle, writeErrorResult, writeResultObject, writeSuccessResult

Methods inherited from class org.eclipse.smila.http.server.util.ARequestHandler

activate, getDynamicUriParts, getRootContextPath, getStaticUriParts, getUriPattern, matches, urlDecode

Methods inherited from class java.lang.Object

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

Field Detail

KEY_JOB_NAME

public static final java.lang.String KEY_JOB_NAME

the key for the job name.

See Also:

Constant Field Values

KEY_IMPORT_RUN_ID

public static final java.lang.String KEY_IMPORT_RUN_ID

the key for the import run id.

See Also:

Constant Field Values

KEY_DATA_SOURCE_ID

public static final java.lang.String KEY_DATA_SOURCE_ID

the key for the data source id.

See Also:

Constant Field Values

Constructor Detail

CrawlerHandler

public CrawlerHandler()

Method Detail

process

public java.lang.Object process(java.lang.String method,
                                java.lang.String requestUri,
                                Record inputRecord)
                         throws java.lang.Exception

process input record and return result object.

Specified by:

process in class JsonRequestHandler

Parameters:

method - HTTP method

requestUri - request URI.

inputRecord - input record parsed either from request body, if it has content, or from request URI parameters.

Returns:

result object, may be null. If this is not a Record, you have to provide a JsonRequestHandler.writeResultObject(OutputStream, Object) method, too.

Throws:

java.lang.Exception - any failure during processing.

isValidMethod

protected boolean isValidMethod(java.lang.String method,
                                java.lang.String requestUri)

Checks if the handler allows the HTTP method.

Overrides:

isValidMethod in class JsonRequestHandler

Parameters:

method - HTTP method

requestUri - request URI

Returns:

true if the method can be used for the URI, else false.

setCrawlerController

public void setCrawlerController(CrawlerController crawlerController)

OSGi method to set the CrawlerController. Called by DS.

Parameters:

crawlerController -

unsetCrawlerController

public void unsetCrawlerController(CrawlerController crawlerController)

OSGi method to unset the CrawlerController. Called by DS.

Parameters:

crawlerController -