Package org.rapidcontext.app.web

Class FileWebService

java.lang.Object

org.rapidcontext.core.storage.StorableObject

org.rapidcontext.core.type.WebService

org.rapidcontext.app.web.FileWebService

All Implemented Interfaces:

HttpUtil

Direct Known Subclasses:

AppWebService

public class FileWebService
extends WebService

A file web service. This service is used for retrieving binary (or text) files from the storage, usually the standard web site files (HTML, CSS, JavaScript, etc). This web service only support HTTP GET requests.

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	KEY_PATH	The dictionary key for the base storage path for files.

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
FileWebService(String id, String type, Dict dict)	Creates a new file web service from a serialized representation.

Method Summary

Modifier and Type	Method	Description
protected void	doGet(Request request)	Processes an HTTP GET request.
protected Stream<Path>	lookupPaths(Path filePath, boolean exact)	Returns an ordered stream of file lookup paths.
protected String[]	methodsImpl(Request request)	Returns the HTTP methods implemented for the specified request.
Path	path()	Returns the base storage path for file lookups.
protected void	processFile(Request request, Path filePath, boolean exact)	Processes a storage file retrieval request (if possible).

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

all, description, doDelete, doHead, doOptions, doPatch, doPost, doPut, 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, id, isActive, isModified, passivate, serialize, sterilize, toString, type

Methods inherited from class java.lang.Object

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

Field Details

KEY_PATH

public static final String KEY_PATH

The dictionary key for the base storage path for files.

See Also:

• Constant Field Values

Constructor Details

FileWebService

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

Creates a new file web service from a serialized representation.

Parameters:

id - the object identifier

type - the object type name

dict - the serialized representation

Method Details

path

public Path path()

Returns the base storage path for file lookups.

Overrides:

path in class StorableObject

Returns:

the base storage path

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)

doGet

protected void doGet(Request request)

Processes an HTTP GET request.

Overrides:

doGet in class WebService

Parameters:

request - the request to process

processFile

protected void processFile(Request request,
 Path filePath,
 boolean exact)

Processes a storage file retrieval request (if possible).

Parameters:

request - the request to process

filePath - the storage path to the binary file

exact - the exact path match flag

lookupPaths

protected Stream<Path> lookupPaths(Path filePath,
 boolean exact)

Returns an ordered stream of file lookup paths. For non-exact matches this includes all parent "404.html" and "index.html" paths.

Parameters:

filePath - the requested file path

exact - the exact path match flag

Returns:

the stream of lookup paths