Class TasksResource

java.lang.Object

is.galia.resource.AbstractResource

is.galia.resource.api.TasksResource

All Implemented Interfaces:

Resource

public class TasksResource
extends AbstractResource
implements Resource

Resource to enable an RPC-style asynchronous API for performing potentially long-running tasks.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	URI_PATH

Fields inherited from class is.galia.resource.AbstractResource

PUBLIC_IDENTIFIER_HEADER

Constructor Summary

Constructors

Constructor	Description
TasksResource()

Method Summary

Modifier and Type	Method	Description
void	doInit()	Initialization method, called after all necessary setters have been called but before any request handler method (like AbstractResource.doGET() etc.)
void	doPOST()	Accepts a JSON object in the request entity with, at a minimum, a verb key with a value of one of the JsonSubTypes.Type annotations on APITask.
protected org.slf4j.Logger	getLogger()
Set<Route>	getRoutes()	Part of the Resource contract.

Methods inherited from class is.galia.resource.AbstractResource

authenticateUsingBasic, decodePathComponent, destroy, doDELETE, doGET, doHEAD, doOPTIONS, doPATCH, doPUT, getCanonicalClientIPAddress, getCommonTemplateVars, getDelegate, getLocalBasePath, getPreferredMediaTypes, getPublicReference, getPublicRootReference, getRepresentationDisposition, getRequest, getRequestContext, getResponse, negotiateContentType, setRequest, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface is.galia.resource.Resource

destroy, doDELETE, doGET, doHEAD, doInit, doOPTIONS, doPATCH, doPUT, getRequest, getResponse, setRequest, setResponse

Field Details

URI_PATH

public static final String URI_PATH

See Also:

• Constant Field Values

Constructor Details

TasksResource

public TasksResource()

Method Details

getLogger

protected org.slf4j.Logger getLogger()

Specified by:

getLogger in class AbstractResource

getRoutes

public Set<Route> getRoutes()

Description copied from class: AbstractResource

Part of the Resource contract.

Specified by:

getRoutes in interface Resource

Specified by:

getRoutes in class AbstractResource

Returns:

All routes to which the instance responds.

doPOST

public void doPOST()
            throws Exception

Accepts a JSON object in the request entity with, at a minimum, a verb key with a value of one of the JsonSubTypes.Type annotations on APITask.

Specified by:

doPOST in interface Resource

Overrides:

doPOST in class AbstractResource

Throws:

Exception - upon any error. This may be a ResourceException to enable a custom status.

See Also:

• AbstractResource.doPOST()

doInit

public void doInit()
            throws Exception

Description copied from class: AbstractResource

Initialization method, called after all necessary setters have been called but before any request handler method (like AbstractResource.doGET() etc.)

If an implementation class has anything to do with image identifiers, it should add the request identifier to the request context.

Overrides must call super.

Overrides:

doInit in class AbstractResource

Throws:

Exception - upon any error. This may be a ResourceException to enable a custom status.