Tomcat 10.1.19 · org.apache.catalina.WebResourceSet · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	gc() Implementations may cache some information to improve performance.
public URL	Returns: The base URL for this set of resources getBaseUrl() Obtain the base URL for this set of resources.
public boolean	Returns: `true` if these resources should only be used for class loader resource lookups, otherwise `false` getClassLoaderOnly() Should resources returned by this resource set only be included in any results when the lookup is explicitly looking for class loader resources.
public WebResource	Returns: The object that represents the resource at the given path getResource(String The path for the resource of interest relative to the root of the web application. It must start with '/'. path) Obtain the object that represents the resource at the given path.
public boolean	Returns: `true` if these resources should only be used for static (non-class loader) resource lookups, otherwise `false` getStaticOnly() Should resources returned by this resource set only be included in any results when the lookup is explicitly looking for static (non-class loader) resources.
public boolean	Returns: `true` if this set of resources is configured to be read-only, otherwise `false` isReadOnly() Obtains the current value of the read-only setting for this set of resources.
public String[]	Returns: The list of resources. If path does not refer to a directory then a zero length array will be returned. list(String The path for the resource of interest relative to the root of the web application. It must start with '/'. path) Obtain the list of the names of all of the files and directories located in the specified directory.
public Set<String>	Returns: The Set of resources. If path does not refer to a directory then an empty set will be returned. listWebAppPaths(String The path for the resource of interest relative to the root of the web application. It must start with '/'. path) Obtain the Set of the web applications pathnames of all of the files and directories located in the specified directory.
public boolean	Returns: `true` if the directory was created, otherwise `false` mkdir(String The path for the new resource to create relative to the root of the web application. It must start with '/'. path) Create a new directory at the given path.
public void	setClassLoaderOnly(boolean classLoaderOnly)
public void	setReadOnly(boolean `true` if this set of resources should be configured to be read-only readOnly) Configures whether or not this set of resources is read-only.
public void	setRoot(WebResourceRoot root)
public void	setStaticOnly(boolean staticOnly)
public boolean	Returns: `true` if and only if the new Resource is written write(String The path to be used for the new Resource. It is relative to the root of the web application and must start with '/'. path, InputStream The InputStream that will provide the content for the new Resource. is, boolean If `true` and the resource already exists it will be overwritten. If `false` and the resource already exists the write will fail. overwrite) Create a new resource at the requested path using the provided InputStream.

Inherited from org.apache.catalina.Lifecycle:: addLifecycleListener destroy findLifecycleListeners getState getStateName init removeLifecycleListener start stop

Method Detail

gc	back to summary
public void gc() Implementations may cache some information to improve performance. This method triggers the clean-up of those resources.

getBaseUrl	back to summary
public URL getBaseUrl() Obtain the base URL for this set of resources. One of the uses of this is to grant read permissions to the resources when running under a security manager. Returns:URL The base URL for this set of resources

getBaseUrl

back to summary

public URL getBaseUrl()

Obtain the base URL for this set of resources. One of the uses of this is to grant read permissions to the resources when running under a security manager.

Returns:URL: The base URL for this set of resources

getClassLoaderOnly back to summary

getClassLoaderOnly	back to summary
public boolean getClassLoaderOnly() Should resources returned by this resource set only be included in any results when the lookup is explicitly looking for class loader resources. i.e. should these resources be excluded from look ups that are explicitly looking for static (non-class loader) resources. Returns:boolean `true` if these resources should only be used for class loader resource lookups, otherwise `false`

public boolean getClassLoaderOnly()

Should resources returned by this resource set only be included in any results when the lookup is explicitly looking for class loader resources. i.e. should these resources be excluded from look ups that are explicitly looking for static (non-class loader) resources.

Returns:boolean: true if these resources should only be used for class loader resource lookups, otherwise false

getResource	back to summary
public WebResource getResource(String path) Obtain the object that represents the resource at the given path. Note the resource at that path may not exist. Parameters path:String The path for the resource of interest relative to the root of the web application. It must start with '/'. Returns:WebResource The object that represents the resource at the given path

getResource

back to summary

public WebResource getResource(String path)

Obtain the object that represents the resource at the given path. Note the resource at that path may not exist.

Parameters

path:String: The path for the resource of interest relative to the root of the web application. It must start with '/'.

Returns:WebResource

The object that represents the resource at the given path

getStaticOnly back to summary

getStaticOnly	back to summary
public boolean getStaticOnly() Should resources returned by this resource set only be included in any results when the lookup is explicitly looking for static (non-class loader) resources. i.e. should these resources be excluded from look ups that are explicitly looking for class loader resources. Returns:boolean `true` if these resources should only be used for static (non-class loader) resource lookups, otherwise `false`

public boolean getStaticOnly()

Should resources returned by this resource set only be included in any results when the lookup is explicitly looking for static (non-class loader) resources. i.e. should these resources be excluded from look ups that are explicitly looking for class loader resources.

Returns:boolean: true if these resources should only be used for static (non-class loader) resource lookups, otherwise false

isReadOnly back to summary

isReadOnly	back to summary
public boolean isReadOnly() Obtains the current value of the read-only setting for this set of resources. Returns:boolean `true` if this set of resources is configured to be read-only, otherwise `false`

public boolean isReadOnly()

Obtains the current value of the read-only setting for this set of resources.

Returns:boolean: true if this set of resources is configured to be read-only, otherwise false

list	back to summary
public String[] list(String path) Obtain the list of the names of all of the files and directories located in the specified directory. Parameters path:String The path for the resource of interest relative to the root of the web application. It must start with '/'. Returns:String[] The list of resources. If path does not refer to a directory then a zero length array will be returned.

list

back to summary

public String[] list(String path)

Obtain the list of the names of all of the files and directories located in the specified directory.

Parameters

path:String: The path for the resource of interest relative to the root of the web application. It must start with '/'.

Returns:String[]

The list of resources. If path does not refer to a directory then a zero length array will be returned.

listWebAppPaths	back to summary
public 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. Paths representing directories will end with a "/" character. Parameters path:String The path for the resource of interest relative to the root of the web application. It must start with '/'. Returns:Set<String> The Set of resources. If path does not refer to a directory then an empty set will be returned.

listWebAppPaths

back to summary

public 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. Paths representing directories will end with a "/" character.

Parameters

path:String: The path for the resource of interest relative to the root of the web application. It must start with '/'.

Returns:Set<String>

The Set of resources. If path does not refer to a directory then an empty set will be returned.

mkdir back to summary

mkdir	back to summary
public boolean mkdir(String path) Create a new directory at the given path. Parameters path:String The path for the new resource to create relative to the root of the web application. It must start with '/'. Returns:boolean `true` if the directory was created, otherwise `false`

public boolean mkdir(String path)

Create a new directory at the given path.

Parameters

path:String: The path for the new resource to create relative to the root of the web application. It must start with '/'.

Returns:boolean

true if the directory was created, otherwise false

setClassLoaderOnly	back to summary
public void setClassLoaderOnly(boolean classLoaderOnly)

setReadOnly back to summary

setReadOnly	back to summary
public void setReadOnly(boolean readOnly) Configures whether or not this set of resources is read-only. Parameters readOnly:boolean `true` if this set of resources should be configured to be read-only Exceptions IllegalArgumentException: if an attempt is made to configure a `WebResourceSet` that is hard-coded to be read-only as writable

public void setReadOnly(boolean readOnly)

Configures whether or not this set of resources is read-only.

Parameters

readOnly:boolean: true if this set of resources should be configured to be read-only

Exceptions

IllegalArgumentException:: if an attempt is made to configure a WebResourceSet that is hard-coded to be read-only as writable

setRoot	back to summary
public void setRoot(WebResourceRoot root)

setStaticOnly	back to summary
public void setStaticOnly(boolean staticOnly)

write back to summary

write	back to summary
public boolean write(String path, InputStream is, boolean overwrite) Create a new resource at the requested path using the provided InputStream. Parameters path:String The path to be used for the new Resource. It is relative to the root of the web application and must start with '/'. is:InputStream The InputStream that will provide the content for the new Resource. overwrite:boolean If `true` and the resource already exists it will be overwritten. If `false` and the resource already exists the write will fail. Returns:boolean `true` if and only if the new Resource is written

public boolean write(String path, InputStream is, boolean overwrite)

Create a new resource at the requested path using the provided InputStream.

Parameters

path:String: The path to be used for the new Resource. It is relative to the root of the web application and must start with '/'.
is:InputStream: The InputStream that will provide the content for the new Resource.
overwrite:boolean: If true and the resource already exists it will be overwritten. If false and the resource already exists the write will fail.

Returns:boolean

true if and only if the new Resource is written

public Interface WebResourceSet

Field Summary

Method Summary

Method Detail