org.apache.lenya.cms.rc
Class RCEnvironment

java.lang.Object
  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.lenya.cms.rc.RCEnvironment
All Implemented Interfaces:
org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.logger.LogEnabled

public class RCEnvironment
extends org.apache.avalon.framework.logger.AbstractLogEnabled
implements org.apache.avalon.framework.configuration.Configurable

Helper class that holds the revision controller configuration


Field Summary
static java.lang.String BACKUP_DIRECTORY
          BACKUP_DIRECTORY The backup directory
static java.lang.String CONFIGURATION_FILE
          CONFIGURATION_FILE The configuration file
static java.lang.String RCML_DIRECTORY
          RCML_DIRECTORY The RCML directory
 
Constructor Summary
RCEnvironment(java.lang.String contextPath, org.apache.avalon.framework.logger.Logger logger)
          Creates a new RCEnvironment object from the context path
 
Method Summary
 void configure(org.apache.avalon.framework.configuration.Configuration configuration)
           
 java.lang.String getBackupDirectory()
          Get the backup directory
static RCEnvironment getInstance(java.lang.String contextPath, org.apache.avalon.framework.logger.Logger logger)
          Returns the singleton RC environment for this context path.
 java.lang.String getRCMLDirectory()
          Get the RCML directory
protected  void setBackupDirectory(java.lang.String backupDir)
          Set the backup directory
protected  void setRCMLDirectory(java.lang.String rcmlDir)
          Set the rcml directory
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONFIGURATION_FILE

public static final java.lang.String CONFIGURATION_FILE
CONFIGURATION_FILE The configuration file


RCML_DIRECTORY

public static final java.lang.String RCML_DIRECTORY
RCML_DIRECTORY The RCML directory

See Also:
Constant Field Values

BACKUP_DIRECTORY

public static final java.lang.String BACKUP_DIRECTORY
BACKUP_DIRECTORY The backup directory

See Also:
Constant Field Values
Constructor Detail

RCEnvironment

public RCEnvironment(java.lang.String contextPath,
                     org.apache.avalon.framework.logger.Logger logger)
Creates a new RCEnvironment object from the context path

Parameters:
contextPath - The context path
logger - The logger.
Method Detail

getInstance

public static RCEnvironment getInstance(java.lang.String contextPath,
                                        org.apache.avalon.framework.logger.Logger logger)
Returns the singleton RC environment for this context path.

Parameters:
contextPath - The context path (the Lenya webapp directory).
logger - The logger.
Returns:
An RC environment.

configure

public void configure(org.apache.avalon.framework.configuration.Configuration configuration)
               throws org.apache.avalon.framework.configuration.ConfigurationException
Specified by:
configure in interface org.apache.avalon.framework.configuration.Configurable
Throws:
org.apache.avalon.framework.configuration.ConfigurationException
See Also:
Configurable.configure(org.apache.avalon.framework.configuration.Configuration)

getRCMLDirectory

public java.lang.String getRCMLDirectory()
Get the RCML directory

Returns:
The RCML directory

setRCMLDirectory

protected void setRCMLDirectory(java.lang.String rcmlDir)
Set the rcml directory

Parameters:
rcmlDir - the path to the rcml directory

getBackupDirectory

public java.lang.String getBackupDirectory()
Get the backup directory

Returns:
The backup directory

setBackupDirectory

protected void setBackupDirectory(java.lang.String backupDir)
Set the backup directory

Parameters:
backupDir - path to the backup directory


Copyright 1999-2006 Apache Software Foundation. All Rights Reserved.