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, javax.servlet.Servlet, javax.servlet.ServletConfig, BasicRestConfig

@RestResource(title="File System Explorer",description="Contents of $RA{path}",messages="nls/DirectoryResource",htmldoc=@HtmlDoc(navlinks={"up: request:/..","options: servlet:/?method=OPTIONS"}),allowedMethodParams="*",properties={@Property(name="HtmlSerializer.uriAnchorText.s",value="PROPERTY_NAME"),@Property(name="DirectoryResource.rootDir",value="")})
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.allowPuts - If true, allows files to be created or overwritten.
• DirectoryResource.allowDeletes - If true, allows files to be deleted.

Access can also be controlled by overriding the checkAccess(RestRequest) method.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DirectoryResource.FileResource File POJO

Constructor Summary

Constructors

Constructor and Description
DirectoryResource()

Method Summary

Modifier and Type	Method and Description
protected void	checkAccess(RestRequest req) Verify that the specified request is allowed.
Object	doDelete(RestRequest req) [DELETE /*] - Delete a file on the file system.
Reader	doDownload(RestRequest req, RestResponse res) [DOWNLOAD /*] - Download the contents of a file.
Object	doGet(RestRequest req) [GET /*] - On directories, returns a directory listing.
Object	doPut(RestRequest req) [PUT /*] - Add or overwrite a file on the file system.
Reader	doView(RestRequest req, RestResponse res) [VIEW /*] - View the contents of a file.
protected File	getRootDir() Returns the root directory defined by the 'rootDir' init parameter.
void	init()

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

getOptions

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

destroy, getContext, getProperties, getServletConfig, init, log, log, log, log, logObjects, service

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryResource

public DirectoryResource()

Method Detail

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

getRootDir

protected File getRootDir()

Returns the root directory defined by the 'rootDir' init parameter.

Subclasses can override this method to provide their own root directory.

Returns:

The root directory.

doGet

@RestMethod(name="GET",
            path="/*",
            description="On directories, returns a directory listing.\nOn files, returns information about the file.",
            converters=Queryable.class)
public Object doGet(RestRequest req)
                                                                                                                                                                                                                           throws Exception

[GET /*] - On directories, returns a directory listing. On files, returns information about the file.

Parameters:

req - The HTTP request.

Returns:

Either a FileResource or list of FileResources depending on whether it's a file or directory.

Throws:

Exception - If file could not be read or access was not granted.

doDelete

@RestMethod(name="DELETE",
            path="/*",
            description="Delete a file on the file system.")
public Object doDelete(RestRequest req)
                                                                                                                               throws Exception

[DELETE /*] - Delete a file on the file system.

Parameters:

req - The HTTP request.

Returns:

The message "File deleted" if successful.

Throws:

Exception - If file could not be read or access was not granted.

doPut

@RestMethod(name="PUT",
            path="/*",
            description="Add or overwrite a file on the file system.")
public Object doPut(RestRequest req)
                                                                                                                                   throws Exception

[PUT /*] - Add or overwrite a file on the file system.

Parameters:

req - The HTTP request.

Returns:

The message "File added" if successful.

Throws:

Exception - If file could not be read or access was not granted.

doView

@RestMethod(name="VIEW",
            path="/*",
            description="View the contents of a file.\nApplies to files only.")
public Reader doView(RestRequest req,
                                                                                                                                                     RestResponse res)
                                                                                                                                              throws Exception

[VIEW /*] - View the contents of a file.

Applies to files only.

Parameters:

req - The HTTP request.

res - The HTTP response.

Returns:

A Reader containing the contents of the file.

Throws:

Exception - If file could not be read or access was not granted.

doDownload

@RestMethod(name="DOWNLOAD",
            path="/*",
            description="Download the contents of a file.\nApplies to files only.")
public Reader doDownload(RestRequest req,
                                                                                                                                                                 RestResponse res)
                                                                                                                                                          throws Exception

[DOWNLOAD /*] - Download the contents of a file.

Applies to files only.

Parameters:

req - The HTTP request.

res - The HTTP response.

Returns:

A Reader containing the contents of the file.

Throws:

Exception - If file could not be read or access was not granted.

checkAccess

protected void checkAccess(RestRequest req)

Verify that the specified request is allowed.

Subclasses can override this method to provide customized behavior. Method should throw a RestException if the request should be disallowed.

Parameters:

req - The HTTP request.