Package jmri.server.web

Class AbstractWebServerConfiguration

java.lang.Object

jmri.server.web.AbstractWebServerConfiguration

All Implemented Interfaces:

WebServerConfiguration

Direct Known Subclasses:

DefaultWebServerConfiguration, WebAppConfiguration

public abstract class AbstractWebServerConfiguration
extends java.lang.Object
implements WebServerConfiguration

Abstract implementation of WebServerConfiguration

Constructor Summary

Constructors

Constructor	Description
AbstractWebServerConfiguration()

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractWebServerConfiguration

public AbstractWebServerConfiguration()

Method Detail

getFilePaths

public java.util.Map<java.lang.String,java.lang.String> getFilePaths()

Description copied from interface: WebServerConfiguration

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.

Specified by:

getFilePaths in interface WebServerConfiguration

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

public java.util.Map<java.lang.String,java.lang.String> getRedirectedPaths()

Description copied from interface: WebServerConfiguration

Get paths that are to redirected by the web server.

Specified by:

getRedirectedPaths in interface WebServerConfiguration

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

public java.util.List<java.lang.String> getForbiddenPaths()

Description copied from interface: WebServerConfiguration

Get paths that are not to be returned. Requests for paths listed here will be denied a HttpServletResponse.SC_FORBIDDEN response.

Specified by:

getForbiddenPaths in interface WebServerConfiguration

Returns:

a list containing the request path to be denied access to; return an empty list if none