org.waarp.openr66.configuration

Class RuleFileBasedConfiguration

java.lang.Object

org.waarp.openr66.configuration.RuleFileBasedConfiguration

public final class RuleFileBasedConfiguration
extends Object

Rule File Based Configuration

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXT_RULE Extension of rule files
static String	EXT_RULES Extension of multiple rules in one file
static XmlDecl[]	hostsDecls
static String	MULTIPLEROOT
static String	ROOT
static XmlDecl[]	tasksDecl
static String	XARCHIVEPATH
static String	XHOSTID
static String	XHOSTIDS
static String	XIDRULE
static String	XMODE
static String	XRECVPATH
static String	XRERRORTASKS
static String	XRPOSTTASKS
static String	XRPRETASKS
static String	XSENDPATH
static String	XSERRORTASKS
static String	XSPOSTTASKS
static String	XSPRETASKS
static String	XTASK
static String	XTASKS
static String	XWORKPATH

Method Summary

Modifier and Type	Method and Description
static DbRule	getFromFile(File file) Load and update a Rule from a file
static String[]	getHostIds(XmlValue value)
static List<DbRule>	getMultipleFromFile(File file) Load and update multiple Rules from one file
static String[][]	getTasksRule(XmlValue value) Utility function
static void	importRules(File configDirectory) Import all Rule files into the HashTable of Rules
static String	writeOneXml(String directory, String hostname) Write to directory 1 file prefixed by hostname all Rules from database
static void	writeXml(String directory, String hostname) Write to directory files prefixed by hostname all Rules from database

Methods inherited from class java.lang.Object

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

Field Detail

MULTIPLEROOT

public static final String MULTIPLEROOT

See Also:

Constant Field Values

ROOT

public static final String ROOT

See Also:

Constant Field Values

XIDRULE

public static final String XIDRULE

See Also:

Constant Field Values

XHOSTIDS

public static final String XHOSTIDS

See Also:

Constant Field Values

XHOSTID

public static final String XHOSTID

See Also:

Constant Field Values

XMODE

public static final String XMODE

See Also:

Constant Field Values

XRECVPATH

public static final String XRECVPATH

See Also:

Constant Field Values

XSENDPATH

public static final String XSENDPATH

See Also:

Constant Field Values

XARCHIVEPATH

public static final String XARCHIVEPATH

See Also:

Constant Field Values

XWORKPATH

public static final String XWORKPATH

See Also:

Constant Field Values

XRPRETASKS

public static final String XRPRETASKS

See Also:

Constant Field Values

XRPOSTTASKS

public static final String XRPOSTTASKS

See Also:

Constant Field Values

XRERRORTASKS

public static final String XRERRORTASKS

See Also:

Constant Field Values

XSPRETASKS

public static final String XSPRETASKS

See Also:

Constant Field Values

XSPOSTTASKS

public static final String XSPOSTTASKS

See Also:

Constant Field Values

XSERRORTASKS

public static final String XSERRORTASKS

See Also:

Constant Field Values

XTASKS

public static final String XTASKS

See Also:

Constant Field Values

XTASK

public static final String XTASK

See Also:

Constant Field Values

tasksDecl

public static final XmlDecl[] tasksDecl

hostsDecls

public static final XmlDecl[] hostsDecls

EXT_RULE

public static final String EXT_RULE

Extension of rule files

See Also:

Constant Field Values

EXT_RULES

public static final String EXT_RULES

Extension of multiple rules in one file

See Also:

Constant Field Values

Method Detail

importRules

public static void importRules(File configDirectory)
                        throws OpenR66ProtocolSystemException,
                               WaarpDatabaseException

Import all Rule files into the HashTable of Rules

Parameters:

configDirectory -

Throws:

OpenR66ProtocolSystemException

WaarpDatabaseException

getTasksRule

public static String[][] getTasksRule(XmlValue value)

Utility function

Parameters:

value -

Returns:

the array of tasks or empty array if in error.

getHostIds

public static String[] getHostIds(XmlValue value)

Parameters:

value - the XmlValue hosting hostids/hostid

Returns:

the array of HostIds allowed for the current rule

getFromFile

public static DbRule getFromFile(File file)
                          throws OpenR66ProtocolSystemException,
                                 WaarpDatabaseNoConnectionException,
                                 WaarpDatabaseSqlException,
                                 WaarpDatabaseNoDataException,
                                 WaarpDatabaseException

Load and update a Rule from a file

Parameters:

file -

Returns:

the newly created R66Rule from XML File

Throws:

OpenR66ProtocolSystemException

WaarpDatabaseException

WaarpDatabaseNoDataException

WaarpDatabaseSqlException

WaarpDatabaseNoConnectionException

OpenR66ProtocolNoDataException

getMultipleFromFile

public static List<DbRule> getMultipleFromFile(File file)
                                        throws OpenR66ProtocolSystemException,
                                               WaarpDatabaseNoConnectionException,
                                               WaarpDatabaseSqlException,
                                               WaarpDatabaseNoDataException,
                                               WaarpDatabaseException

Load and update multiple Rules from one file

Parameters:

file -

Returns:

a list of newly created R66Rule from XML File

Throws:

OpenR66ProtocolSystemException

WaarpDatabaseException

WaarpDatabaseNoDataException

WaarpDatabaseSqlException

WaarpDatabaseNoConnectionException

OpenR66ProtocolNoDataException

writeXml

public static final void writeXml(String directory,
                                  String hostname)
                           throws WaarpDatabaseNoConnectionException,
                                  WaarpDatabaseSqlException,
                                  OpenR66ProtocolSystemException

Write to directory files prefixed by hostname all Rules from database

Parameters:

directory -

hostname -

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

OpenR66ProtocolSystemException

writeOneXml

public static String writeOneXml(String directory,
                                 String hostname)
                          throws WaarpDatabaseNoConnectionException,
                                 WaarpDatabaseSqlException,
                                 OpenR66ProtocolSystemException

Write to directory 1 file prefixed by hostname all Rules from database

Parameters:

directory -

hostname -

Returns:

the filename

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

OpenR66ProtocolSystemException