org.apache.juneau.microservice.resources

Class DirectoryResource

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.juneau.rest.RestServlet

org.apache.juneau.rest.BasicRestServlet

org.apache.juneau.microservice.resources.DirectoryResource

All Implemented Interfaces:

Serializable, Servlet, ServletConfig, BasicRestConfig

@Rest(title="File System Explorer",
      messages="nls/DirectoryResource",
      allowedMethodParams="*")
 @HtmlDocConfig(navlinks={"up: request:/..","options: servlet:/?method=OPTIONS"})
 @HtmlConfig(uriAnchorText="PROPERTY_NAME")
public class DirectoryResource
extends BasicRestServlet

REST resource that allows access to a file system directory.

The root directory is specified in one of two ways:

• Specifying the location via a DirectoryResource.rootDir property.
• Overriding the getRootDir() method.

Read/write access control is handled through the following properties:

• DirectoryResource.allowViews - If true, allows view and download access to files.
• DirectoryResource.allowUploads - If true, allows files to be created or overwritten.
• DirectoryResource.allowDeletes - If true, allows files to be deleted.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DirectoryResource.Action
class	DirectoryResource.FileResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRECTORY_RESOURCE_allowDeletes Configuration property: Allow deletes on files.
static String	DIRECTORY_RESOURCE_allowUploads Configuration property: Allow uploads on files.
static String	DIRECTORY_RESOURCE_allowViews Configuration property: Allow view and downloads on files.
static String	DIRECTORY_RESOURCE_rootDir Configuration property: Root directory.

Constructor Summary

Constructors

Constructor and Description
DirectoryResource()

Method Summary

Modifier and Type	Method and Description
org.apache.juneau.microservice.resources.DirectoryResource.RedirectToRoot	deleteFile(String path)
org.apache.juneau.microservice.resources.DirectoryResource.FileContents	downloadFile(RestResponse res, String path)
DirectoryResource.FileResource	getFile(RestRequest req, String path)
protected File	getRootDir() Returns the root directory.
void	init(RestContextBuilder b)
org.apache.juneau.microservice.resources.DirectoryResource.RedirectToRoot	updateFile(InputStream is, String path)
org.apache.juneau.microservice.resources.DirectoryResource.FileContents	viewFile(RestResponse res, String path)

Methods inherited from class org.apache.juneau.rest.BasicRestServlet

getOptions

Methods inherited from class org.apache.juneau.rest.RestServlet

destroy, getContext, getPath, getProperties, getRequest, getResponse, getServletConfig, init, log, log, log, log, logObjects, service, setContext, setRestResourceResolver

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletContext, getServletInfo, getServletName, init

Methods inherited from class java.lang.Object

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

Field Detail

DIRECTORY_RESOURCE_rootDir

public static final String DIRECTORY_RESOURCE_rootDir

Configuration property: Root directory.

See Also:

Constant Field Values

DIRECTORY_RESOURCE_allowViews

public static final String DIRECTORY_RESOURCE_allowViews

Configuration property: Allow view and downloads on files.

See Also:

Constant Field Values

DIRECTORY_RESOURCE_allowDeletes

public static final String DIRECTORY_RESOURCE_allowDeletes

Configuration property: Allow deletes on files.

See Also:

Constant Field Values

DIRECTORY_RESOURCE_allowUploads

public static final String DIRECTORY_RESOURCE_allowUploads

Configuration property: Allow uploads on files.

See Also:

Constant Field Values

Constructor Detail

DirectoryResource

public DirectoryResource()

Method Detail

init

@RestHook(value=INIT)
public void init(RestContextBuilder b)
                                throws Exception

Throws:

Exception

getFile

@RestMethod(name="GET",
            path="/*",
            summary="View information on file or directory",
            description="Returns information about the specified file or directory.")
 @HtmlDocConfig(nav="<h5>Folder:  $RA{fullPath}</h5>")
public DirectoryResource.FileResource getFile(RestRequest req,
                                                                                                                                                                                                                                                                                                       @Path(value="/*")
                                                                                                                                                                                                                                                                                                       String path)
                                                                                                                                                                                                                                                                                                throws NotFound,
                                                                                                                                                                                                                                                                                                       Exception

Throws:

NotFound

Exception

viewFile

@RestMethod(name="VIEW",
            path="/*",
            summary="View contents of file",
            description="View the contents of a file.\nContent-Type is set to \'text/plain\'.")
public org.apache.juneau.microservice.resources.DirectoryResource.FileContents viewFile(RestResponse res,
                                                                                                                                                                                                                                                                                     @Path(value="/*")
                                                                                                                                                                                                                                                                                     String path)
                                                                                                                                                                                                                                                                              throws NotFound,
                                                                                                                                                                                                                                                                                     MethodNotAllowed

Throws:

NotFound

MethodNotAllowed

downloadFile

@RestMethod(name="DOWNLOAD",
            path="/*",
            summary="Download file",
            description="Download the contents of a file.\nContent-Type is set to \'application/octet-stream\'.")
public org.apache.juneau.microservice.resources.DirectoryResource.FileContents downloadFile(RestResponse res,
                                                                                                                                                                                                                                                                                                       @Path(value="/*")
                                                                                                                                                                                                                                                                                                       String path)
                                                                                                                                                                                                                                                                                                throws NotFound,
                                                                                                                                                                                                                                                                                                       MethodNotAllowed

Throws:

NotFound

MethodNotAllowed

deleteFile

@RestMethod(name="DELETE",
            path="/*",
            summary="Delete file",
            description="Delete a file on the file system.")
public org.apache.juneau.microservice.resources.DirectoryResource.RedirectToRoot deleteFile(@Path(value="/*")
                                                                                                                                                                                                                                              String path)
                                                                                                                                                                                                                                       throws MethodNotAllowed

Throws:

MethodNotAllowed

updateFile

@RestMethod(name="PUT",
            path="/*",
            summary="Add or replace file",
            description="Add or overwrite a file on the file system.")
public org.apache.juneau.microservice.resources.DirectoryResource.RedirectToRoot updateFile(@Body(schema=@Schema(type="string",format="binary"))
                                                                                                                                                                                                                                                             InputStream is,
                                                                                                                                                                                                                                                             @Path(value="/*")
                                                                                                                                                                                                                                                             String path)
                                                                                                                                                                                                                                                      throws InternalServerError

Throws:

InternalServerError

getRootDir

protected File getRootDir()

Returns the root directory.

Returns:

The root directory.