org.archive.crawler.restlet

Class ScriptResource

java.lang.Object

org.restlet.Handler

org.restlet.resource.Resource

org.archive.crawler.restlet.BaseResource

org.archive.crawler.restlet.JobRelatedResource

org.archive.crawler.restlet.ScriptResource

public class ScriptResource
extends JobRelatedResource

Restlet Resource which runs an arbitrary script, which is supplied with variables pointing to the job and appContext, from which all other live crawl objects are reachable. Any JSR-223 script engine that's properly discoverable on the classpath will be available from a drop-down selector.

Contributor:

gojomo, adam-miller

Field Summary

Fields

Modifier and Type	Field and Description
protected String	chosenEngine
protected static LinkedList<ScriptEngineFactory>	FACTORIES
protected static ScriptEngineManager	MANAGER

Fields inherited from class org.archive.crawler.restlet.JobRelatedResource

beanToNameMap, cj, HIDDEN_PROPS

Constructor Summary

Constructors

Constructor and Description
ScriptResource(org.restlet.Context ctx, org.restlet.data.Request req, org.restlet.data.Response res)

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptRepresentation(org.restlet.resource.Representation entity)
protected Collection<Map<String,String>>	getAvailableScriptEngines()
freemarker.template.Configuration	getTemplateConfiguration()
protected ScriptModel	makeDataModel() Constructs a nested Map data structure with the information represented by this Resource.
org.restlet.resource.Representation	represent(org.restlet.resource.Variant variant)
void	setTemplateConfiguration(freemarker.template.Configuration tmpltCfg)
protected void	writeHtml(Writer writer)

Methods inherited from class org.archive.crawler.restlet.JobRelatedResource

addPresentableNestedNames, defaultUpdateDescriptor, getEngine, getPropertyDescriptors, makePresentableMapFor, makePresentableMapFor, makePresentableMapFor

Methods inherited from class org.archive.crawler.restlet.BaseResource

getPreferredVariant, getStaticRef

Methods inherited from class org.restlet.resource.Resource

allowDelete, allowGet, allowPost, allowPut, delete, getPreferredRepresentation, getRepresentation, getVariants, handleDelete, handleGet, handlePost, handlePut, init, isAvailable, isModifiable, isNegotiateContent, isReadable, post, put, removeRepresentations, represent, setAvailable, setModifiable, setNegotiateContent, setReadable, setVariants, storeRepresentation

Methods inherited from class org.restlet.Handler

allowHead, allowOptions, generateRef, getAllowedMethods, getApplication, getContext, getLogger, getMatrix, getQuery, getRequest, getResponse, handleHead, handleOptions, setContext, setRequest, setResponse, updateAllowedMethods

Methods inherited from class java.lang.Object

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

Field Detail

MANAGER

protected static ScriptEngineManager MANAGER

FACTORIES

protected static LinkedList<ScriptEngineFactory> FACTORIES

chosenEngine

protected String chosenEngine

Constructor Detail

ScriptResource

public ScriptResource(org.restlet.Context ctx,
              org.restlet.data.Request req,
              org.restlet.data.Response res)
               throws org.restlet.resource.ResourceException

Throws:

org.restlet.resource.ResourceException

Method Detail

setTemplateConfiguration

public void setTemplateConfiguration(freemarker.template.Configuration tmpltCfg)

getTemplateConfiguration

public freemarker.template.Configuration getTemplateConfiguration()

acceptRepresentation

public void acceptRepresentation(org.restlet.resource.Representation entity)
                          throws org.restlet.resource.ResourceException

Overrides:

acceptRepresentation in class org.restlet.resource.Resource

Throws:

org.restlet.resource.ResourceException

represent

public org.restlet.resource.Representation represent(org.restlet.resource.Variant variant)
                                              throws org.restlet.resource.ResourceException

Overrides:

represent in class org.restlet.resource.Resource

Throws:

org.restlet.resource.ResourceException

getAvailableScriptEngines

protected Collection<Map<String,String>> getAvailableScriptEngines()

makeDataModel

protected ScriptModel makeDataModel()

Constructs a nested Map data structure with the information represented by this Resource. The result is particularly suitable for use with with XmlMarshaller.

Returns:

the nested Map data structure

writeHtml

protected void writeHtml(Writer writer)