fuseguard.components.configurators.BaseConfigurator

fuseguard.components.configurators
Component BaseConfigurator

configurators.BaseConfigurator

The Base Component that All Configurator Components Should Extend.

Method Summary

public BaseConfigurator init()
          Returns an instance of the Configuration Object

public void addFilter([any firewall], [any filter])
          Adds an extension point where you can customize the filter by extending the configurator

public void addLogger([any firewall], [any logger])
          Adds an extension point where you can customize the logger by extending the configurator

public void configure(any firewallInstance, [any configName="Default"])
          Called when the firewall is initialized to configure itself

public array getConfigNames()
          Returns an array of valid Configuration Names.

public struct getConfigurationData([any configName="Default"])
          Returns the configuration data

public array getFilterNames()
          Returns an array of valid filter class names

public array getLoggerNames()
          Returns an array of valid filter class names

public boolean isPersistable()
          Returns true if the configuration can be persisted.

public void saveConfigurationData([struct data], [any configName="Default"])
          Persists the configuration data.

Method Detail

addFilter

public void addFilter([any firewall], [any filter])

Adds an extension point where you can customize the filter by extending the configurator

Parameters:: [any firewall]; [any filter]

addLogger

public void addLogger([any firewall], [any logger])

Adds an extension point where you can customize the logger by extending the configurator

Parameters:: [any firewall]; [any logger]

configure

public void configure(any firewallInstance, [any configName="Default"])

Called when the firewall is initialized to configure itself

Parameters:: any firewallInstance - The firewall instance to be configured; [any configName="Default"] - The name of the configuration set to use.

getConfigNames

public array getConfigNames()

Returns an array of valid Configuration Names.

getConfigurationData

public struct getConfigurationData([any configName="Default"])

Returns the configuration data

Parameters:: [any configName="Default"] - The name of the configuration set to use.

getFilterNames

public array getFilterNames()

Returns an array of valid filter class names

getLoggerNames

public array getLoggerNames()

Returns an array of valid filter class names

init

public BaseConfigurator init()

Returns an instance of the Configuration Object

isPersistable

public boolean isPersistable()

Returns true if the configuration can be persisted.

saveConfigurationData

public void saveConfigurationData([struct data], [any configName="Default"])

Persists the configuration data.

Parameters:: [struct data] - The configuration data.; [any configName="Default"] - The name of the configuration set to use.

Method Summary
`public BaseConfigurator`	`init()` Returns an instance of the Configuration Object
`public void`	`addFilter([any firewall], [any filter])` Adds an extension point where you can customize the filter by extending the configurator
`public void`	`addLogger([any firewall], [any logger])` Adds an extension point where you can customize the logger by extending the configurator
`public void`	`configure(any firewallInstance, [any configName="Default"])` Called when the firewall is initialized to configure itself
`public array`	`getConfigNames()` Returns an array of valid Configuration Names.
`public struct`	`getConfigurationData([any configName="Default"])` Returns the configuration data
`public array`	`getFilterNames()` Returns an array of valid filter class names
`public array`	`getLoggerNames()` Returns an array of valid filter class names
`public boolean`	`isPersistable()` Returns true if the configuration can be persisted.
`public void`	`saveConfigurationData([struct data], [any configName="Default"])` Persists the configuration data.

fuseguard.components.configurators Component BaseConfigurator