net.sf.wfnm
Class Config

java.lang.Object
  net.sf.wfnm.Config

public class Config

extends Object

The WebFlow Navigation Manager configuration.
The unique JVM instance of this class configure the WFMN:

• enable/disable the framework
• enable/disable the automatic cleaning subsystem
• enable/disable session size statistics
• enable/disable the "no cache" option
• sets the webflows default ownership
• the url rewriter implementation used by the NoMultipleSubmitFilter filter
• set url calculator implementation used by the NotifyFactory
• set the concrete implementation of the navigation manager class
• set the concrete implementation of the navigation context class
• the page change listener
• the webflow change listener

Version:

1.0.6

Author:

Maurizio Albari

Constructor Summary

Config()
Creates a new Config object.

Config(boolean enabled, boolean cleanerEnabled, boolean statsEnabled, boolean noCacheEnabled, int defaultOwnership, Class urlRewriter, Class manager, Class context, Class pageChangedListener, Class webflowChangedListener, Class urlCalculator)
Creates a new Config object.

Config(boolean enabled, boolean cleanerEnabled, boolean statsEnabled, int defaultOwnership, Class urlRewriter, Class urlCalculator)
Creates a new Config object.

Config(Class loaderClass)
Creates a new Config object.

Config(Class loaderClass, String fileName)
Creates a new Config object.

Config(InputStream is)
Creates a new Config object.

Method Summary

Class	getContext() Returns the context implementation.
int	getDefaultOwnership() Gets the default ownership.
ConfigException	getException() Gets the exception, if occurred.
static Config	getInstance() Gets the unique instance of the configuration.
Class	getManager() Returns the class that implements the NavigationManager interface.
Class	getPageChangedListener() Returns the page changed listener class.
Class	getUrlCalculator() Returns the URL calculator class.
Class	getUrlRewriter() Returns the URL rewriter.
Class	getWebflowChangedListener() Returns the webflow changed listener class.
boolean	isCleanerEnabled() Indicates whether the cleaner is enabled.
boolean	isEnabled() Indicates whether the Webflow Navigation Manager is enabled.
boolean	isNoCacheEnabled() Returns true if the no cache option is enabled.
boolean	isStatsEnabled() Returns true if statistics are enabled.
static void	setInstance(Config theInstance) Sets the unique instance of the configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

Config

public Config(boolean enabled,
              boolean cleanerEnabled,
              boolean statsEnabled,
              int defaultOwnership,
              Class urlRewriter,
              Class urlCalculator)

Creates a new Config object.

Parameters:

enabled - true if the cleaner is enabled

cleanerEnabled - true if the webflow navigation manager is enabled

statsEnabled - true if the statistics are enabled

defaultOwnership - the default webflows ownership

urlRewriter - the url rewriter class

urlCalculator - the url calculator class

Config

public Config(boolean enabled,
              boolean cleanerEnabled,
              boolean statsEnabled,
              boolean noCacheEnabled,
              int defaultOwnership,
              Class urlRewriter,
              Class manager,
              Class context,
              Class pageChangedListener,
              Class webflowChangedListener,
              Class urlCalculator)

Creates a new Config object.

Parameters:

enabled - true if the cleaner is enabled

cleanerEnabled - true if the webflow navigation manager is enabled

statsEnabled - true if the statistics are enabled

noCacheEnabled - true if the no cache option is enabled

defaultOwnership - the default webflows ownership

urlRewriter - the url rewriter class

manager - the manager implementation to use

context - the context implementation to use

pageChangedListener - the page changed listener to use

webflowChangedListener - the webflow changed listener to use

urlCalculator - the url calculator class

Config

public Config()

Creates a new Config object.

Config

public Config(Class loaderClass,
              String fileName)

Creates a new Config object.

Parameters:

loaderClass - the loader class

fileName - the file name to load

Config

public Config(Class loaderClass)

Creates a new Config object.

Parameters:

loaderClass - the loader class

Config

public Config(InputStream is)

Creates a new Config object.

Parameters:

is - the input stream

Method Detail

setInstance

public static void setInstance(Config theInstance)

Sets the unique instance of the configuration.

Parameters:

theInstance - the instance of the configuration

getInstance

public static Config getInstance()

Gets the unique instance of the configuration.

Returns:

the unique instance of the configuration

isCleanerEnabled

public boolean isCleanerEnabled()

Indicates whether the cleaner is enabled.

Returns:

true if the cleaner is enabled

getContext

public Class getContext()

Returns the context implementation.

Returns:

the context implementation

getDefaultOwnership

public int getDefaultOwnership()

Gets the default ownership.

Returns:

the default ownership

isEnabled

public boolean isEnabled()

Indicates whether the Webflow Navigation Manager is enabled.

Returns:

true if the Webflow Navigation Manager is enabled

getException

public ConfigException getException()

Gets the exception, if occurred.

Returns:

the exception, if occurred

getManager

public Class getManager()

Returns the class that implements the NavigationManager interface.

Returns:

the class that implements the NavigationManager interface

See Also:

NavigationManager

isNoCacheEnabled

public boolean isNoCacheEnabled()

Returns true if the no cache option is enabled.

Returns:

true if the no cache option is enabled

getPageChangedListener

public Class getPageChangedListener()

Returns the page changed listener class.

Returns:

the page changed listener class

isStatsEnabled

public boolean isStatsEnabled()

Returns true if statistics are enabled.

Returns:

true if statistics are enabled

getUrlCalculator

public Class getUrlCalculator()

Returns the URL calculator class.

Returns:

the URL calculator class

getUrlRewriter

public Class getUrlRewriter()

Returns the URL rewriter.

Returns:

the URL rewriter

getWebflowChangedListener

public Class getWebflowChangedListener()

Returns the webflow changed listener class.

Returns:

the webflow changed listener class