Package org.apache.juneau.microservice.resources

Class DirectoryResource

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.apache.juneau.rest.servlet.RestServlet

org.apache.juneau.rest.servlet.BasicRestServlet

org.apache.juneau.microservice.resources.DirectoryResource

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable, BasicUniversalConfig, DefaultConfig, DefaultHtmlConfig, BasicRestOperations

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:

• juneau-microservice-core Basics

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
DirectoryResource(Config c)

Method Summary

Modifier and Type	Method	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.
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.servlet.BasicRestServlet

error, getFavIcon, getHtdoc, getStats, getSwagger

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

destroy, doLog, getContext, getPath, getRequest, getResponse, init, log, log, service, setContext

Methods inherited from class jakarta.servlet.http.HttpServlet

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

Methods inherited from class jakarta.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Details

DIRECTORY_RESOURCE_rootDir

public static final String DIRECTORY_RESOURCE_rootDir

Root directory.

See Also:

• Constant Field Values

DIRECTORY_RESOURCE_allowViews

public static final String DIRECTORY_RESOURCE_allowViews

Allow view and downloads on files.

See Also:

• Constant Field Values

DIRECTORY_RESOURCE_allowDeletes

public static final String DIRECTORY_RESOURCE_allowDeletes

Allow deletes on files.

See Also:

• Constant Field Values

DIRECTORY_RESOURCE_allowUploads

public static final String DIRECTORY_RESOURCE_allowUploads

Allow uploads on files.

See Also:

• Constant Field Values

Constructor Details

DirectoryResource

public DirectoryResource(Config c)
                  throws Exception

Throws:

Exception

Method Details

deleteFile

public org.apache.juneau.microservice.resources.DirectoryResource.RedirectToRoot deleteFile(@Path("/*")
 String path)
                                                                                     throws MethodNotAllowed

Throws:

MethodNotAllowed

downloadFile

public org.apache.juneau.microservice.resources.DirectoryResource.FileContents downloadFile(RestResponse res,
 @Path("/*")
 String path)
                                                                                     throws NotFound,
MethodNotAllowed

Throws:

NotFound

MethodNotAllowed

getFile

public DirectoryResource.FileResource getFile(RestRequest req,
 @Path("/*")
 String path)
                                       throws NotFound,
Exception

Throws:

NotFound

Exception

updateFile

public org.apache.juneau.microservice.resources.DirectoryResource.RedirectToRoot updateFile(@Content @Schema(type="string",format="binary")
 InputStream is,
 @Path("/*")
 String path)
                                                                                     throws InternalServerError

Throws:

InternalServerError

viewFile

public org.apache.juneau.microservice.resources.DirectoryResource.FileContents viewFile(RestResponse res,
 @Path("/*")
 String path)
                                                                                 throws NotFound,
MethodNotAllowed

Throws:

NotFound

MethodNotAllowed

getRootDir

protected File getRootDir()

Returns the root directory.

Returns:

The root directory.