Package net.officefloor.web.resource.spi

Interface ResourceSystemContext

All Known Implementing Classes:
HttpResourceStoreImpl
public interface ResourceSystemContext
Context for the ResourceSystem.
Author:
Daniel Sagenschneider

  • Method Details

    • getLocation

      String getLocation()

      Obtains the location for the ResourceSystem.

      The location is a free text value that is interpreted specific to the ResourceSystem implementation. For example:

      • path to a directory of a file system
      • class path prefix
      • etc
      Returns:
      Location for the ResourceSystem.

    • getDirectoryDefaultResourceNames

      String[] getDirectoryDefaultResourceNames()
      Obtains the directory default resource names.
      Returns:
      Directory default resource names.

    • getHttpResourceStore

      HttpResourceStore getHttpResourceStore()
      Obtains the HttpResourceStore.
      Returns:
      HttpResourceStore.

    • createFile

      Path createFile(String name) throws IOException

      Creates a new file.

      All files required should be created via this method. This is to ensure the files are managed.

      Parameters:
      name - Name to aid in identifying the file for debugging.
      Returns:
      Path to the new file.
      Throws:
      IOException - If fails to create the new file.

    • createDirectory

      Path createDirectory(String name) throws IOException

      Creates a new directory.

      All directories should be created via this method. THis is to ensure the directories are managed.

      Parameters:
      name - Name to aid in identifying the directory for debugging.
      Returns:
      Path to the new directory.
      Throws:
      IOException - If fails to create the new directory.

    • setCharset

      void setCharset(Charset charset)

      Specifies the Charset for files within the ResourceSystem.

      This is optional to invoke. If not configured (or configured with null) then the Charset.defaultCharset() will be used as the Charset for the files.

      Parameters:
      charset - Charset of the files within the ResourceSystem.

    • notifyResourceChanged

      void notifyResourceChanged(String resourcePath)

      Allows the ResourceSystem to notify that a resource has changed.

      The HttpResourceStore will then discard the HttpResource for the path. Should the path be null then all HttpResource instances are discarded.

      Parameters:
      resourcePath - Path for the resource. If null then all resources will be discarded.