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 or WebDAV and provides a view of the storage hierarchy similar to a file system. Note that WebDAV makes use of extended HTTP methods.

Version:

1.0

Author:

Per Cederberg

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 and Description
static java.lang.String	EXT_HTML The HTML file extension.
static java.lang.String	EXT_JSON The JSON file extension.
static java.lang.String	EXT_PROPERTIES The properties file extension.
static java.lang.String	EXT_XML The XML file extension.
static java.lang.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_CLASSNAME, KEY_ID, KEY_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	doDelete(Request request) Processes an HTTP DELETE request.
protected void	doGet(Request request) Processes an HTTP GET request.
protected void	doLock(Request request) Processes a WebDAV LOCK request.
protected void	doMkCol(Request request) Processes a WebDAV MKCOL request.
protected void	doMove(Request request) Processes a WebDAV MOVE 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	doPropFind(Request request) Processes a WebDAV PROPFIND request.
protected void	doPut(Request request) Processes an HTTP PUT request.
protected void	doUnlock(Request request) Processes a WebDAV UNLOCK request.
protected java.lang.String[]	methodsImpl(Request request) Returns the HTTP methods implemented for the specified request.
void	process(Request request) Processes a request for this handler.

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

description, doHead, doTrace, errorBadRequest, errorForbidden, errorInternal, errorMethodNotAllowed, errorNotFound, errorUnauthorized, findAllMatchers, headerAllow, methods, session

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

activate, destroy, id, init, isActive, isModified, passivate, path, serialize, toString, type

Methods inherited from class java.lang.Object

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

Field Detail

METHODS

public static final java.lang.String[] METHODS

The HTTP methods supported by this web service.

EXT_HTML

public static final java.lang.String EXT_HTML

The HTML file extension.

See Also:

Constant Field Values

EXT_JSON

public static final java.lang.String EXT_JSON

The JSON file extension.

See Also:

Constant Field Values

EXT_PROPERTIES

public static final java.lang.String EXT_PROPERTIES

The properties file extension.

See Also:

Constant Field Values

EXT_XML

public static final java.lang.String EXT_XML

The XML file extension.

See Also:

Constant Field Values

Constructor Detail

StorageWebService

public StorageWebService(java.lang.String id,
                         java.lang.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 Detail

methodsImpl

protected java.lang.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)

process

public void process(Request request)

Processes a request for this handler. This method assumes local request paths (removal of the mapped URL base).

Overrides:

process in class WebService

Parameters:

request - the request to process

See Also:

WebMatcher.process(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

doPropFind

protected void doPropFind(Request request)

Processes a WebDAV PROPFIND request.

Parameters:

request - the request to process

doMkCol

protected void doMkCol(Request request)

Processes a WebDAV MKCOL request.

Parameters:

request - the request to process

doMove

protected void doMove(Request request)

Processes a WebDAV MOVE request.

Parameters:

request - the request to process

doLock

protected void doLock(Request request)

Processes a WebDAV LOCK request.

Parameters:

request - the request to process

doUnlock

protected void doUnlock(Request request)

Processes a WebDAV UNLOCK request.

Parameters:

request - the request to process