ambit2.rest

Class SimpleTaskResource<USERID>

java.lang.Object

org.restlet.resource.UniformResource

org.restlet.resource.ServerResource

ambit2.rest.ProtectedResource

ambit2.rest.freemarker.FreeMarkerResource

ambit2.rest.AbstractResource<Iterator<UUID>,UUID,net.idea.modbcum.i.processors.IProcessor<Iterator<UUID>,org.restlet.representation.Representation>>

ambit2.rest.SimpleTaskResource<USERID>

All Implemented Interfaces:

net.idea.restnet.i.aa.IAuthToken, net.idea.restnet.i.freemarker.IFreeMarkerSupport

public class SimpleTaskResource<USERID>
extends AbstractResource<Iterator<UUID>,UUID,net.idea.modbcum.i.processors.IProcessor<Iterator<UUID>,org.restlet.representation.Representation>>

http://opentox.org/wiki/opentox/Asynchronous_jobs Provide (read)access to running tasks under URL http://host/application/task. Provide (read)access to a single task under URL http://host/application/task/{taskid}. Task identifiers are unique, generated via UUID class.
An URL with a task identifier is returned when an asynchronous job is submitted via AsyncJobResource If accepted, the status code is 201 and the URI of the task resource in the Location header /task/{id}
If a list of tasks has been requested, returns list of URLs of the tasks TODO - introduce Guards for protecting sensitive resources
If a single task is requested and the task is not completed,returns Status code 202 (accepted, processing has not been completed).
If a single task is requested and the task is completed, returns Status code 303 and the new URL in the "Location" header

 HTTP/1.1 303 See Other
 Location: http://example.org/thenewurl
 

Author:
nina

Field Summary

Fields

Modifier and Type	Field and Description
protected int	max
protected int	page
protected long	pageSize
static String	resource
static String	resourceID
static String	resourceKey
protected String	searchStatus

Fields inherited from class ambit2.rest.AbstractResource

b64search_param, caseSensitive, condition, error, max_hits, property, queryObject, response_status, returnProperties, search_param

Fields inherited from class ambit2.rest.freemarker.FreeMarkerResource

fmSupport

Constructor Summary

Constructors

Constructor and Description
SimpleTaskResource()

Method Summary

Modifier and Type	Method and Description
net.idea.modbcum.i.processors.IProcessor<Iterator<UUID>,org.restlet.representation.Representation>	createConvertor(org.restlet.representation.Variant variant)
protected Iterator<UUID>	createQuery(org.restlet.Context context, org.restlet.Request request, org.restlet.Response response)
protected void	doInit()
protected boolean	filterTask(net.idea.restnet.i.task.ITask<net.idea.restnet.i.task.ITaskResult,USERID> task, int taskNumber)
int	getPage()
long	getPageSize()
protected Iterator<UUID>	getTasks()
void	setPage(int page)
void	setPageSize(long pageSize)
protected void	setPaging(org.restlet.data.Form form)

Methods inherited from class ambit2.rest.AbstractResource

customizeVariants, get, getParameter, getParameter, getRepresentation, getVariants, post, processNotFound, URI_to_handle

Methods inherited from class ambit2.rest.freemarker.FreeMarkerResource

configureTemplateMap, getHTMLByTemplate, getSearchReference, getTemplateName, isHtmlbyTemplate, setHtmlbyTemplate, toRepresentation

Methods inherited from class ambit2.rest.ProtectedResource

cleanedResourceRef, doRelease, getAgent, getPassword, getResourceRef, getToken, getTokenFromCookies, getUserName, setCacheHeaders, setFrameOptions, setTokenCookies, useSecureCookie

Methods inherited from class org.restlet.resource.ServerResource

delete, delete, describeVariants, doConditionalHandle, doHandle, doHandle, doNegotiatedHandle, get, getInfo, getInfo, getOnContinue, getOnSent, getPreferredVariant, handle, head, head, isAnnotated, isConditional, isExisting, isInRole, isNegotiated, options, options, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setChallengeRequests, setConditional, setCookieSettings, setDimensions, setExisting, setLocationRef, setLocationRef, setNegotiated, setOnContinue, setOnSent, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.UniformResource

doCatch, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getContext, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMetadataService, getMethod, getOriginalRef, getProtocol, getQuery, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestEntity, getResponse, getResponseAttributes, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, release

Methods inherited from class java.lang.Object

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

Field Detail

resource

public static final String resource

See Also:

Constant Field Values

resourceKey

public static final String resourceKey

See Also:

Constant Field Values

resourceID

public static final String resourceID

searchStatus

protected String searchStatus

max

protected int max

page

protected int page

pageSize

protected long pageSize

Constructor Detail

SimpleTaskResource

public SimpleTaskResource()

Method Detail

getPage

public int getPage()

setPage

public void setPage(int page)

getPageSize

public long getPageSize()

setPageSize

public void setPageSize(long pageSize)

doInit

protected void doInit()
               throws org.restlet.resource.ResourceException

Overrides:

doInit in class AbstractResource<Iterator<UUID>,UUID,net.idea.modbcum.i.processors.IProcessor<Iterator<UUID>,org.restlet.representation.Representation>>

Throws:

org.restlet.resource.ResourceException

filterTask

protected boolean filterTask(net.idea.restnet.i.task.ITask<net.idea.restnet.i.task.ITaskResult,USERID> task,
                             int taskNumber)

getTasks

protected Iterator<UUID> getTasks()

createQuery

protected Iterator<UUID> createQuery(org.restlet.Context context,
                                     org.restlet.Request request,
                                     org.restlet.Response response)
                              throws org.restlet.resource.ResourceException

Specified by:

createQuery in class AbstractResource<Iterator<UUID>,UUID,net.idea.modbcum.i.processors.IProcessor<Iterator<UUID>,org.restlet.representation.Representation>>

Throws:

org.restlet.resource.ResourceException

createConvertor

public net.idea.modbcum.i.processors.IProcessor<Iterator<UUID>,org.restlet.representation.Representation> createConvertor(org.restlet.representation.Variant variant)
                                                                                                                   throws net.idea.modbcum.i.exceptions.AmbitException,
                                                                                                                          org.restlet.resource.ResourceException

Specified by:

createConvertor in class AbstractResource<Iterator<UUID>,UUID,net.idea.modbcum.i.processors.IProcessor<Iterator<UUID>,org.restlet.representation.Representation>>

Throws:

net.idea.modbcum.i.exceptions.AmbitException

org.restlet.resource.ResourceException

setPaging

protected void setPaging(org.restlet.data.Form form)