WebServerConfiguration (JMRI API)

All Known Implementing Classes:: AbstractWebServerConfiguration, DefaultWebServerConfiguration

public interface WebServerConfiguration

Provide additional configurations not encapsulated by a servlet for the WebServer.

Method Summary

Modifier and Type

Method

Description

Map<String,String>

getFilePaths()

Get paths that are to be returned by the web server as individual files or directory listings.

List<String>

getForbiddenPaths()

Get paths that are not to be returned.

Map<String,String>

getRedirectedPaths()

Get paths that are to redirected by the web server.

Method Details
- getFilePaths
  
  @CheckReturnValue @Nonnull Map<String,String> getFilePaths()
  
  Get paths that are to be returned by the web server as individual files or directory listings. Note that all files or directories listed must be in the FileUtil.PREFERENCES, FileUtil.PROFILE, FileUtil.SETTINGS, or FileUtil.PROGRAM JMRI portable path.
  
  Returns:
  
  a map containing the web path as the key, and the path on disk as the value; return an empty map if none
- getRedirectedPaths
  
  @CheckReturnValue @Nonnull Map<String,String> getRedirectedPaths()
  
  Get paths that are to redirected by the web server.
  
  Returns:
  
  a map containing the request path as the key and the path to redirect to as the value; return an empty map if none
- getForbiddenPaths
  
  @CheckReturnValue @Nonnull List<String> getForbiddenPaths()
  
  Get paths that are not to be returned. Requests for paths listed here will be denied a HttpServletResponse.SC_FORBIDDEN response.
  
  Returns:
  
  a list containing the request path to be denied access to; return an empty list if none