Interface Resource

All Known Implementing Classes:

ConfigurationResource, FileResource, HealthResource, IdentifierResource, IdentifierResource, IdentifierResource, ImageResource, ImageResource, ImageResource, InformationResource, InformationResource, InformationResource, InformationResource, LandingResource, StatusResource, TaskResource, TasksResource, TileResource, TrailingSlashResource

public interface Resource

HTTP resource.

Implementations should extend AbstractResource and note the documentation of all of its methods that they override.

Instances are used only once and are not shared across threads.

Method Summary

Modifier and Type	Method	Description
void	destroy()	Invoked at the end of the instance's lifecycle.
void	doDELETE()	Handles DELETE requests.
void	doGET()	Handles GET requests.
void	doHEAD()	Handles HEAD requests.
void	doInit()	Invoked before the main request handler (doGET(), etc.).
void	doOPTIONS()	Handles OPTIONS requests.
void	doPATCH()	Handles PATCH requests.
void	doPOST()	Handles POST requests.
void	doPUT()	Handles PUT requests.
Request	getRequest()
Response	getResponse()
Set<Route>	getRoutes()
void	setRequest(Request request)	Invoked before doInit().
void	setResponse(Response response)	Invoked before doInit().

Method Details

getRoutes

Set<Route> getRoutes()

Returns:

All routes supported by the implementation.

getRequest

Request getRequest()

Returns:

The instance provided to setRequest(Request).

getResponse

Response getResponse()

Returns:

The instance provided to setResponse(Response).

setRequest

void setRequest(Request request)

Invoked before doInit().

Parameters:

request - The client's request for the resource.

setResponse

void setResponse(Response response)

Invoked before doInit().

Parameters:

response - The response that will be returned to the client.

doInit

void doInit()
     throws Exception

Invoked before the main request handler (doGET(), etc.).

Throws:

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

doDELETE

void doDELETE()
       throws Exception

Handles DELETE requests.

Throws:

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

See Also:

• AbstractResource.doDELETE()

doGET

void doGET()
    throws Exception

Handles GET requests.

Throws:

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

See Also:

• AbstractResource.doGET()

doHEAD

void doHEAD()
     throws Exception

Handles HEAD requests.

Throws:

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

See Also:

• AbstractResource.doHEAD()

doOPTIONS

void doOPTIONS()

Handles OPTIONS requests.

See Also:

• AbstractResource.doOPTIONS()

doPATCH

void doPATCH()
      throws Exception

Handles PATCH requests.

Throws:

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

See Also:

• AbstractResource.doPATCH()

doPOST

void doPOST()
     throws Exception

Handles POST requests.

Throws:

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

See Also:

• AbstractResource.doPOST()

doPUT

void doPUT()
    throws Exception

Handles PUT requests.

Throws:

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

See Also:

• AbstractResource.doPUT()

destroy

void destroy()

Invoked at the end of the instance's lifecycle.