com.basistech.rlp
Class EnvironmentParameters

java.lang.Object
  extended by com.basistech.rlp.EnvironmentParameters

public class EnvironmentParameters
extends Object

Initialization parameters for the RLP environment.

See Also:
RLPEnvironment.RLPEnvironment(EnvironmentParameters)

Constructor Summary
EnvironmentParameters()
          Creates an EnvironmentParameters object with all parameters set to null.
 
Method Summary
 File getEnvironmentDefinition()
          Gets the Environment Definition File.
 RLPEnvironment.LogCallback getLogCallback()
          Retrieves the currect log callback object.
 String getLogLevel()
          Gets the log level.
 void setEnvironmentDefinition(File fileOfXML)
          Sets the Environment Definition File.
 void setLogCallback(RLPEnvironment.LogCallback cb)
          Sets the log callback object that will be passed messages from RLP.
 void setLogLevel(String rlpLogLevel)
          Sets the log level.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EnvironmentParameters

public EnvironmentParameters()
Creates an EnvironmentParameters object with all parameters set to null.

Method Detail

setLogCallback

public void setLogCallback(RLPEnvironment.LogCallback cb)
Sets the log callback object that will be passed messages from RLP. All log channels will be muted by this call. To enable actual logging, setLogLevel must also be called.

Parameters:
cb - The callback object
See Also:
RLPEnvironment.LogCallback

getLogCallback

public RLPEnvironment.LogCallback getLogCallback()
Retrieves the currect log callback object.

Returns:
The log callback object.
See Also:
RLPEnvironment.LogCallback

setLogLevel

public void setLogLevel(String rlpLogLevel)
Sets the log level.

Parameters:
rlpLogLevel - log level: "none", "warning", "error", "info", "all", or a comma-delimited list, such as "warning,error".

getLogLevel

public String getLogLevel()
Gets the log level.

Returns:
The current log level, or null if it hasn't been set.

setEnvironmentDefinition

public void setEnvironmentDefinition(File fileOfXML)
Sets the Environment Definition File.

This is commonly called in the following manner:
envparms.setEnvironmentDefinition(new File("/some/where/rlp-global.xml");

Parameters:
fileOfXML - the RLP Environment Definition File in XML format

getEnvironmentDefinition

public File getEnvironmentDefinition()
Gets the Environment Definition File.

Returns:
The current environment definintion file, or null if it hasn't been set.


Copyright © 2004-2008 Basis Technology Corporation. All Rights Reserved.