Class StaticFilesConfig

  • All Implemented Interfaces:

    
    public final class StaticFilesConfig
    
                        

    Configuration for static files and webjars.

    Static resource handling is done after endpoint matching, meaning your own GET endpoints have higher priority.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final Unit enableWebjars() Enable webjars access.
      final Unit add(String directory, Location location) Adds the given directory as a static file containers.
      final Unit add(String directory) Adds the given directory as a static file containers.
      final Unit add(Consumer<StaticFileConfig> userConfig) Adds a static file through custom configuration.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • StaticFilesConfig

        StaticFilesConfig(JavalinConfig cfg)
        Parameters:
        cfg - the parent Javalin Configuration
    • Method Detail

      • enableWebjars

         final Unit enableWebjars()

        Enable webjars access. They will be available at /webjars/name/version/file.ext.

      • add

        @JvmOverloads() final Unit add(String directory, Location location)

        Adds the given directory as a static file containers.

        Parameters:
        directory - the directory where your files are located
        location - the location of the static directory (default: CLASSPATH)
      • add

        @JvmOverloads() final Unit add(String directory)

        Adds the given directory as a static file containers.

        Parameters:
        directory - the directory where your files are located
      • add

         final Unit add(Consumer<StaticFileConfig> userConfig)

        Adds a static file through custom configuration.

        Parameters:
        userConfig - a lambda to configure advanced static files