Package jmri.web.server

Class WebServerPreferences

java.lang.Object

jmri.beans.UnboundBean

jmri.beans.Bean

jmri.beans.PreferencesBean

jmri.web.server.WebServerPreferences

All Implemented Interfaces:

BeanInterface, PropertyChangeFirer, PropertyChangeProvider, InstanceManagerAutoDefault

public class WebServerPreferences
extends PreferencesBean
implements InstanceManagerAutoDefault

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_REMOTE_CONFIG
static final String	CLICK_DELAY
static final String	DISABLE_FRAME_SERVER
static final String	DISALLOWED_FRAMES
static final String	FRAME
static final String	PORT
static final String	RAILROAD_NAME
static final String	READONLY_POWER
static final String	REDIRECT_FRAMES
static final String	REFRESH_DELAY
static final String	SIMPLE
static final String	USE_AJAX
static final String	USE_ZERO_CONF
static final String	WEB_SERVER_PREFERENCES

Fields inherited from class jmri.beans.PreferencesBean

DIRTY, RESTART_REQUIRED

Fields inherited from class jmri.beans.Bean

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
WebServerPreferences()

Method Summary

Modifier and Type	Method	Description
boolean	allowRemoteConfig()
int	getClickDelay()
String	getDefaultRailroadName()	Get the default railroad name.
String[]	getDisallowedFrames()
int	getPort()
String	getRailroadName()	Get the name of the railroad.
int	getRefreshDelay()
boolean	isDefaultRailroadName()	Test if the railroad name has been set by user.
boolean	isDisableFrames()
boolean	isReadonlyPower()	Can the power state be set from web clients?
boolean	isRedirectFramesToPanels()	Are requests for frames redirected to panels when frames are disabled?
boolean	isSimple()
boolean	isUseAjax()
boolean	isUseZeroConf()
void	save()
void	setAllowRemoteConfig(boolean value)
void	setClickDelay(int value)
void	setDisableFrames(boolean disableFrames)	Set whether or not frames are returned when requests for frames are made from web pages.
void	setDisallowedFrames(String[] disallowedFrames)
void	setPort(int value)
void	setRailroadName(String railroadName)	Set the railroad name.
void	setReadonlyPower(boolean readonlyPower)	Set if the power state can be set from web clients.
void	setRedirectFramesToPanels(boolean redirectFramesToPanels)	Set whether or not requests for frames should be redirected to panels when frames are disabled.
void	setRefreshDelay(int value)
void	setSimple(boolean value)
void	setUseAjax(boolean useAjax)
void	setUseZeroConf(boolean value)

Methods inherited from class jmri.beans.PreferencesBean

firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getProfile, isDirty, isRestartRequired, setIsDirty, setRestartRequired

Methods inherited from class jmri.beans.Bean

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, isNotifyOnEDT, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class jmri.beans.UnboundBean

getIndexedProperty, getProperty, getPropertyNames, hasIndexedProperty, hasProperty, setIndexedProperty, setProperty

Methods inherited from class java.lang.Object

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

Field Details

DISALLOWED_FRAMES

public static final String DISALLOWED_FRAMES

See Also:

• Constant Field Values

WEB_SERVER_PREFERENCES

public static final String WEB_SERVER_PREFERENCES

See Also:

• Constant Field Values

FRAME

public static final String FRAME

See Also:

• Constant Field Values

PORT

public static final String PORT

See Also:

• Constant Field Values

CLICK_DELAY

public static final String CLICK_DELAY

See Also:

• Constant Field Values

REFRESH_DELAY

public static final String REFRESH_DELAY

See Also:

• Constant Field Values

USE_AJAX

public static final String USE_AJAX

See Also:

• Constant Field Values

SIMPLE

public static final String SIMPLE

See Also:

• Constant Field Values

RAILROAD_NAME

public static final String RAILROAD_NAME

See Also:

• Constant Field Values

ALLOW_REMOTE_CONFIG

public static final String ALLOW_REMOTE_CONFIG

See Also:

• Constant Field Values

READONLY_POWER

public static final String READONLY_POWER

See Also:

• Constant Field Values

DISABLE_FRAME_SERVER

public static final String DISABLE_FRAME_SERVER

See Also:

• Constant Field Values

REDIRECT_FRAMES

public static final String REDIRECT_FRAMES

See Also:

• Constant Field Values

USE_ZERO_CONF

public static final String USE_ZERO_CONF

See Also:

• Constant Field Values

Constructor Details

WebServerPreferences

public WebServerPreferences()

Method Details

save

public void save()

getClickDelay

public int getClickDelay()

setClickDelay

public void setClickDelay(int value)

getRefreshDelay

public int getRefreshDelay()

setRefreshDelay

public void setRefreshDelay(int value)

getDisallowedFrames

public String[] getDisallowedFrames()

isUseAjax

public boolean isUseAjax()

setUseAjax

public void setUseAjax(boolean useAjax)

isSimple

public boolean isSimple()

setSimple

public void setSimple(boolean value)

isUseZeroConf

public boolean isUseZeroConf()

setUseZeroConf

public void setUseZeroConf(boolean value)

allowRemoteConfig

public boolean allowRemoteConfig()

setAllowRemoteConfig

public void setAllowRemoteConfig(boolean value)

isReadonlyPower

public boolean isReadonlyPower()

Can the power state be set from web clients?

Returns:

true if web clients are barred from setting power state; false if allowed

setReadonlyPower

public void setReadonlyPower(boolean readonlyPower)

Set if the power state can be set from web clients.

Parameters:

readonlyPower - true to bar setting power from web clients; false to allow

setDisallowedFrames

public void setDisallowedFrames(String[] disallowedFrames)

getPort

public int getPort()

setPort

public void setPort(int value)

getRailroadName

public String getRailroadName()

Get the name of the railroad.

Returns:

the railroad name

setRailroadName

public void setRailroadName(String railroadName)

Set the railroad name.

Parameters:

railroadName - the railroadName to set

isDefaultRailroadName

public boolean isDefaultRailroadName()

Test if the railroad name has been set by user.

Returns:

true if user has not set the railroad name.

getDefaultRailroadName

public String getDefaultRailroadName()

Get the default railroad name. This method exists solely to support unit testing.

Returns:

The default railroad name

isDisableFrames

public boolean isDisableFrames()

Returns:

true if displaying frames in web pages is disabled, false otherwise

setDisableFrames

public void setDisableFrames(boolean disableFrames)

Set whether or not frames are returned when requests for frames are made from web pages.

Parameters:

disableFrames - true to prevent frames from being displayed in web pages

isRedirectFramesToPanels

public boolean isRedirectFramesToPanels()

Are requests for frames redirected to panels when frames are disabled?

Returns:

true if frames should be redirected to panels, false otherwise

setRedirectFramesToPanels

public void setRedirectFramesToPanels(boolean redirectFramesToPanels)

Set whether or not requests for frames should be redirected to panels when frames are disabled.

Parameters:

redirectFramesToPanels - true if frames should be redirected to panels, false otherwise