Package org.apache.juneau.rest.server.staticfile

Class StaticFiles.Builder

java.lang.Object
org.apache.juneau.rest.server.staticfile.StaticFiles.Builder
Enclosing interface:
StaticFiles
public static class StaticFiles.Builder extends Object
Builder class.

  • Constructor Details

    • Builder

      protected Builder(BeanStore beanStore)
      Constructor.
      Parameters:
      beanStore - The bean store to use for creating beans.

  • Method Details

    • beanStore

      public BeanStore beanStore()
      Returns the bean store used by this builder.
      Returns:
      The bean store used by this builder.

    • addMimeTypes

      public StaticFiles.Builder addMimeTypes(String mimeTypes)
      Prepend the MIME type values to the MIME types registry.
      Parameters:
      mimeTypes - A .mime.types formatted string of entries. See MimeTypeDetector.Builder#addTypes(String...).
      Returns:
      This object.

    • caching

      public StaticFiles.Builder caching(long cachingLimit)
      Enables in-memory caching of files for quicker retrieval.
      Parameters:
      cachingLimit - The maximum file size in bytes.
      Returns:
      This object.

    • cp

      public StaticFiles.Builder cp(Class<?> c, String path, boolean recursive)
      Adds a class subpackage to the lookup paths.
      Parameters:
      c - The class whose package will be added to the lookup paths. Must not be null.
      path - The absolute or relative subpath.
      recursive - If true, also recursively adds all the paths of the parent classes as well.
      Returns:
      This object.

    • dir

      public StaticFiles.Builder dir(String path)
      Adds a file system directory to the lookup paths.
      Parameters:
      path - The path relative to the working directory. Must not be null
      Returns:
      This object.

    • exclude

      public StaticFiles.Builder exclude(String... patterns)
      Specifies the regular expression file name pattern to use to exclude files from being retrieved from the file source.
      Parameters:
      patterns - The regular expression exclude patterns.
      If none are specified, no files will be excluded.
      Returns:
      This object.

    • headers

      public StaticFiles.Builder headers(HttpHeader... headers)
      Appends headers to add to HTTP responses.

      Can be called multiple times to add multiple headers.

      Parameters:
      headers - The headers to add.
      Returns:
      This object.

    • include

      public StaticFiles.Builder include(String... patterns)
      Specifies the regular expression file name patterns to use to include files being retrieved from the file source.
      Parameters:
      patterns - The regular expression include patterns.
      The default is ".*".
      Returns:
      This object.

    • mimeTypes

      public StaticFiles.Builder mimeTypes(MimeTypeDetector value)
      Replaces the MIME types registry used for determining content types.
      Parameters:
      value - The new MIME types registry.
      Returns:
      This object.

    • path

      public StaticFiles.Builder path(Path value)
      Adds a file system directory to the lookup paths.
      Parameters:
      value - The directory path.
      Returns:
      This object.

    • build

      public StaticFiles build()
      Builds the static files.
      Returns:
      A new BasicStaticFiles.