public class DirResourceSet extends AbstractFileResourceSet
WebResourceSet
based on a directory.EMPTY_STRING_ARRAY
sm
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
Constructor and Description |
---|
DirResourceSet()
A no argument constructor is required for this to work with the digester.
|
DirResourceSet(WebResourceRoot root,
String webAppMount,
String base,
String internalPath)
Creates a new
WebResourceSet based on a
directory. |
Modifier and Type | Method and Description |
---|---|
protected void |
checkType(File file) |
WebResource |
getResource(String path)
Obtain the object that represents the resource at the given path.
|
String[] |
list(String path)
Obtain the list of the names of all of the files and directories located
in the specified directory.
|
Set<String> |
listWebAppPaths(String path)
Obtain the Set of the web applications pathnames of all of the files and
directories located in the specified directory.
|
boolean |
mkdir(String path)
Create a new directory at the given path.
|
boolean |
write(String path,
InputStream is,
boolean overwrite)
Create a new resource at the requested path using the provided
InputStream.
|
file, getBaseUrl, getFileBase, initInternal, isReadOnly, setReadOnly
checkPath, destroyInternal, getBase, getClassLoaderOnly, getInternalPath, getRoot, getWebAppMount, setBase, setClassLoaderOnly, setInternalPath, setRoot, setWebAppMount, startInternal, stopInternal
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
public DirResourceSet()
public DirResourceSet(WebResourceRoot root, String webAppMount, String base, String internalPath)
WebResourceSet
based on a
directory.root
- The WebResourceRoot
this new
WebResourceSet
will
be added to.webAppMount
- The path within the web application at which this
WebResourceSet
will
be mounted. For example, to add a directory of
JARs to a web application, the directory would
be mounted at "/WEB-INF/lib/"base
- The absolute path to the directory on the file
system from which the resources will be served.internalPath
- The path within this new WebResourceSet
where
resources will be served from.public WebResource getResource(String path)
WebResourceSet
path
- The path for the resource of interest relative to the root
of the web application. It must start with '/'.public String[] list(String path)
WebResourceSet
path
- The path for the resource of interest relative to the root
of the web application. It must start with '/'.public Set<String> listWebAppPaths(String path)
WebResourceSet
path
- The path for the resource of interest relative to the root
of the web application. It must start with '/'.public boolean mkdir(String path)
WebResourceSet
path
- The path for the new resource to create relative to the root
of the web application. It must start with '/'.true
if the directory was created, otherwise
false
public boolean write(String path, InputStream is, boolean overwrite)
WebResourceSet
path
- The path to be used for the new Resource. It is relative
to the root of the web application and must start with
'/'.is
- The InputStream that will provide the content for the
new Resource.overwrite
- If true
and the resource already exists it
will be overwritten. If false
and the
resource already exists the write will fail.true
if and only if the new Resource is writtenprotected void checkType(File file)
checkType
in class AbstractFileResourceSet
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.