Package org.rapidcontext.app.web

Class StorageWebService

java.lang.Object

org.rapidcontext.core.storage.StorableObject

org.rapidcontext.core.type.WebService

org.rapidcontext.app.web.StorageWebService

All Implemented Interfaces:

HttpUtil

public class StorageWebService
extends WebService

A storage API web service. This service is used for accessing the raw data storage through HTTP and provides a view of the storage hierarchy similar to a file system.

Version:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.rapidcontext.util.HttpUtil

HttpUtil.Header, HttpUtil.Helper, HttpUtil.Method, HttpUtil.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXT_HTML	The HTML file extension.
static final String[]	METHODS	The HTTP methods supported by this web service.

Fields inherited from class org.rapidcontext.core.type.WebService

KEY_DESCRIPTION, KEY_MATCH, matchers, METHODS_GET, METHODS_GET_POST, METHODS_POST, PATH

Fields inherited from class org.rapidcontext.core.storage.StorableObject

dict, KEY_ACTIVATED_TIME, KEY_CLASSNAME, KEY_ID, KEY_TYPE, PREFIX_COMPUTED, PREFIX_HIDDEN

Constructor Summary

Constructors

Constructor	Description
StorageWebService(String id, String type, Dict dict)	Creates a new storage web service from a serialized representation.

Method Summary

Modifier and Type	Method	Description
protected void	doDelete(Request request)	Processes an HTTP DELETE request.
protected void	doGet(Request request)	Processes an HTTP GET request.
protected void	doOptions(Request request)	Processes an HTTP OPTIONS request.
protected void	doPatch(Request request)	Processes an HTTP PATCH request.
protected void	doPost(Request request)	Processes an HTTP POST request.
protected void	doPut(Request request)	Processes an HTTP PUT request.
protected String[]	methodsImpl(Request request)	Returns the HTTP methods implemented for the specified request.

Methods inherited from class org.rapidcontext.core.type.WebService

all, description, doHead, doTrace, errorBadRequest, errorForbidden, errorInternal, errorMethodNotAllowed, errorNotFound, errorUnauthorized, headerAllow, init, matchers, methods, process, session

Methods inherited from class org.rapidcontext.core.storage.StorableObject

activate, activatedTime, destroy, dictKey, id, isActive, isModified, passivate, path, serialize, sterilize, toString, type

Methods inherited from class java.lang.Object

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

Field Details

METHODS

public static final String[] METHODS

The HTTP methods supported by this web service.

EXT_HTML

public static final String EXT_HTML

The HTML file extension.

See Also:

• Constant Field Values

Constructor Details

StorageWebService

public StorageWebService(String id,
 String type,
 Dict dict)

Creates a new storage web service from a serialized representation.

Parameters:

id - the object identifier

type - the object type name

dict - the serialized representation

Method Details

methodsImpl

protected String[] methodsImpl(Request request)

Returns the HTTP methods implemented for the specified request. The OPTIONS or HEAD methods doesn't have to be added to the result (added automatically later).

Specified by:

methodsImpl in class WebService

Parameters:

request - the request to check

Returns:

the array of HTTP method names supported

See Also:

• WebService.methods(Request)

doOptions

protected void doOptions(Request request)

Processes an HTTP OPTIONS request.

Overrides:

doOptions in class WebService

Parameters:

request - the request to process

doGet

protected void doGet(Request request)

Processes an HTTP GET request.

Overrides:

doGet in class WebService

Parameters:

request - the request to process

doPatch

protected void doPatch(Request request)

Processes an HTTP PATCH request.

Overrides:

doPatch in class WebService

Parameters:

request - the request to process

doPost

protected void doPost(Request request)

Processes an HTTP POST request.

Overrides:

doPost in class WebService

Parameters:

request - the request to process

doPut

protected void doPut(Request request)

Processes an HTTP PUT request.

Overrides:

doPut in class WebService

Parameters:

request - the request to process

doDelete

protected void doDelete(Request request)

Processes an HTTP DELETE request.

Overrides:

doDelete in class WebService

Parameters:

request - the request to process