Package jmri.server.web.spi
Interface WebServerConfiguration
-
- All Known Implementing Classes:
AbstractWebServerConfiguration
,DefaultWebServerConfiguration
,WebAppConfiguration
public interface WebServerConfiguration
Provide additional configurations not encapsulated by a servlet for theWebServer
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.String>
getFilePaths()
Get paths that are to be returned by the web server as individual files or directory listings.java.util.List<java.lang.String>
getForbiddenPaths()
Get paths that are not to be returned.java.util.Map<java.lang.String,java.lang.String>
getRedirectedPaths()
Get paths that are to redirected by the web server.
-
-
-
Method Detail
-
getFilePaths
@CheckReturnValue @Nonnull java.util.Map<java.lang.String,java.lang.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 theFileUtil.PREFERENCES
,FileUtil.PROFILE
,FileUtil.SETTINGS
, orFileUtil.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 java.util.Map<java.lang.String,java.lang.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 java.util.List<java.lang.String> getForbiddenPaths()
Get paths that are not to be returned. Requests for paths listed here will be denied aHttpServletResponse.SC_FORBIDDEN
response.- Returns:
- a list containing the request path to be denied access to; return an empty list if none
-
-