Method Detail

• getResource

  WebResource getResource(java.lang.String path)

  Obtain the object that represents the resource at the given path. Note that the resource at that path may not exist. If the path does not exist, the WebResource returned will be associated with the main WebResourceSet.

  Parameters:

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

  Returns:

  The object that represents the resource at the given path

• getResources

  WebResource[] getResources(java.lang.String path)

  Obtain the objects that represent the resource at the given path. Note that the resource at that path may not exist. If the path does not exist, the WebResource returned will be associated with the main WebResourceSet. This will include all matches even if the resource would not normally be accessible (e.g. because it was overridden by another resource)

  Parameters:

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

  Returns:

  The objects that represents the resource at the given path

• getClassLoaderResource

  WebResource getClassLoaderResource(java.lang.String path)

  Obtain the object that represents the class loader resource at the given path. WEB-INF/classes is always searched prior to searching JAR files in WEB-INF/lib. The search order for JAR files will be consistent across subsequent calls to this method until the web application is reloaded. No guarantee is made as to what the search order for JAR files may be.

  Parameters:

  path - The path of the class loader resource of interest relative to the the root of class loader resources for this web application.

  Returns:

  The object that represents the class loader resource at the given path

• getClassLoaderResources

  WebResource[] getClassLoaderResources(java.lang.String path)

  Obtain the objects that represent the class loader resource at the given path. Note that the resource at that path may not exist. If the path does not exist, the WebResource returned will be associated with the main WebResourceSet. This will include all matches even if the resource would not normally be accessible (e.g. because it was overridden by another resource)

  Parameters:

  path - The path for the class loader resource of interest relative to the root of the class loader resources for the web application. It must start with '/'.

  Returns:

  The objects that represents the class loader resources at the given path

• list

  java.lang.String[] list(java.lang.String path)

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

  Parameters:

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

  Returns:

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

• listWebAppPaths

  java.util.Set<java.lang.String> listWebAppPaths(java.lang.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 - The path for the resource of interest relative to the root of the web application. It must start with '/'.

  Returns:

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

• listResources

  WebResource[] listResources(java.lang.String path)

  Obtain the list of all of the WebResources in the specified directory.

  Parameters:

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

  Returns:

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

• mkdir

  boolean mkdir(java.lang.String path)

  Create a new directory at the given path.

  Parameters:

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

  Returns:

  true if the directory was created, otherwise false

• write

  boolean write(java.lang.String path,
              java.io.InputStream is,
              boolean overwrite)

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

  Parameters:

  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.

  Returns:

  true if and only if the new Resource is written

• createWebResourceSet

  void createWebResourceSet(WebResourceRoot.ResourceSetType type,
                          java.lang.String webAppMount,
                          java.net.URL url,
                          java.lang.String internalPath)

  Creates a new WebResourceSet for this WebResourceRoot based on the provided parameters.

  Parameters:

  type - The type of WebResourceSet to create

  webAppMount - The path within the web application that the resources should be published at. It must start with '/'.

  url - The URL of the resource (must locate a JAR, file or directory)

  internalPath - The path within the resource where the content is to be found. It must start with '/'.

• createWebResourceSet

  void createWebResourceSet(WebResourceRoot.ResourceSetType type,
                          java.lang.String webAppMount,
                          java.lang.String base,
                          java.lang.String archivePath,
                          java.lang.String internalPath)

  Creates a new WebResourceSet for this WebResourceRoot based on the provided parameters.

  Parameters:

  type - The type of WebResourceSet to create

  webAppMount - The path within the web application that the resources should be published at. It must start with '/'.

  base - The location of the resources

  archivePath - The path within the resource to the archive where the content is to be found. If there is no archive then this should be null.

  internalPath - The path within the archive (or the resource if the archivePath is null where the content is to be found. It must start with '/'.

• addPreResources

  void addPreResources(WebResourceSet webResourceSet)

  Adds the provided WebResourceSet to this web application as a 'Pre' resource.

• getPreResources

  WebResourceSet[] getPreResources()

  Get the list of WebResourceSet configured to this web application as a 'Pre' resource.

• addJarResources

  void addJarResources(WebResourceSet webResourceSet)

  Adds the provided WebResourceSet to this web application as a 'Jar' resource.

• getJarResources

  WebResourceSet[] getJarResources()

  Get the list of WebResourceSet configured to this web application as a 'Jar' resource.

• addPostResources

  void addPostResources(WebResourceSet webResourceSet)

  Adds the provided WebResourceSet to this web application as a 'Post' resource.

• getPostResources

  WebResourceSet[] getPostResources()

  Get the list of WebResourceSet configured to this web application as a 'Post' resource.

• getContext

  Context getContext()

  Obtain the web application this WebResourceRoot is associated with.

• setContext

  void setContext(Context context)

  Set the web application this WebResourceRoot is associated with.

• setAllowLinking

  void setAllowLinking(boolean allowLinking)

  Configure if this resources allow the use of symbolic links.

  Parameters:

  allowLinking - true if symbolic links are allowed.

• getAllowLinking

  boolean getAllowLinking()

  Determine if this resources allow the use of symbolic links.

  Returns:

  true if symbolic links are allowed

• setCachingAllowed

  void setCachingAllowed(boolean cachingAllowed)

  Set whether or not caching is permitted for this web application.

  Parameters:

  cachingAllowed - true to enable caching, else false

• isCachingAllowed

  boolean isCachingAllowed()

  Get whether or not caching is permitted for this web application.

• setCacheTtl

  void setCacheTtl(long ttl)

  Set the Time-To-Live (TTL) for cache entries.

  Parameters:

  ttl - TTL in milliseconds

• getCacheTtl

  long getCacheTtl()

  Get the Time-To-Live (TTL) for cache entries.

  Returns:

  TTL in milliseconds

• setCacheMaxSize

  void setCacheMaxSize(long cacheMaxSize)

  Set the maximum permitted size for the cache.

  Parameters:

  cacheMaxSize - Maximum cache size in kilobytes

• getCacheMaxSize

  long getCacheMaxSize()

  Get the maximum permitted size for the cache.

  Returns:

  Maximum cache size in kilobytes

• setCacheObjectMaxSize

  void setCacheObjectMaxSize(int cacheObjectMaxSize)

  Set the maximum permitted size for a single object in the cache. Note that the maximum size in bytes may not exceed Integer.MAX_VALUE.

  Parameters:

  cacheObjectMaxSize - Maximum size for a single cached object in kilobytes

• getCacheObjectMaxSize

  int getCacheObjectMaxSize()

  Get the maximum permitted size for a single object in the cache. Note that the maximum size in bytes may not exceed Integer.MAX_VALUE.

  Returns:

  Maximum size for a single cached object in kilobytes

• setTrackLockedFiles

  void setTrackLockedFiles(boolean trackLockedFiles)

  Controls whether the track locked files feature is enabled. If enabled, all calls to methods that return objects that lock a file and need to be closed to release that lock (e.g. WebResource.getInputStream() will perform a number of additional tasks.

  • The stack trace at the point where the method was called will be recorded and associated with the returned object.
  • The returned object will be wrapped so that the point where close() (or equivalent) is called to release the resources can be detected. Tracking of the object will cease once the resources have been released.
  • All remaining locked resources on web application shutdown will be logged and then closed.

  Parameters:

  trackLockedFiles - true to enable it, false to disable it

• getTrackLockedFiles

  boolean getTrackLockedFiles()

  Has the track locked files feature been enabled?

  Returns:

  true if it has been enabled, otherwise false

• backgroundProcess

  void backgroundProcess()

  This method will be invoked by the context on a periodic basis and allows the implementation a method that executes periodic tasks, such as purging expired cache entries.

• registerTrackedResource

  void registerTrackedResource(TrackedWebResource trackedResource)

• deregisterTrackedResource

  void deregisterTrackedResource(TrackedWebResource trackedResource)

• getBaseUrls

  java.util.List<java.net.URL> getBaseUrls()

  Obtain the set of WebResourceSet.getBaseUrl() for all WebResourceSets used by this root.

• gc

  void gc()

  Implementations may cache some information to improve performance. This method triggers the clean-up of those resources.