org.apache.lenya.cms.publishing
Class PublishingEnvironment

java.lang.Object
  extended by org.apache.lenya.cms.publishing.PublishingEnvironment
All Implemented Interfaces:
org.apache.avalon.framework.configuration.Configurable
Direct Known Subclasses:
ResourcePublishingEnvironment

public class PublishingEnvironment
extends java.lang.Object
implements org.apache.avalon.framework.configuration.Configurable


Field Summary
static java.lang.String CONFIGURATION_FILE
           
static java.lang.String PARAMETER_AUTHORING_PATH
           
static java.lang.String PARAMETER_EXPORT_PATH
           
static java.lang.String PARAMETER_LIVE_PATH
           
static java.lang.String PARAMETER_REPLICATION_PATH
           
static java.lang.String PARAMETER_SUBSTITUTE_REGEXP
           
static java.lang.String PARAMETER_SUBSTITUTE_REPLACEMENT
           
static java.lang.String PARAMETER_TREE_AUTHORING_PATH
           
static java.lang.String PARAMETER_TREE_LIVE_PATH
           
static java.lang.String PUBLICATION_PATH
           
static java.lang.String PUBLICATION_PREFIX
           
 
Constructor Summary
PublishingEnvironment(java.lang.String publicationPath)
          Creates a new PublishingEnvironment object.
PublishingEnvironment(java.lang.String contextPath, java.lang.String publicationId)
          Creates a new PublishingEnvironment object.
 
Method Summary
 void configure(org.apache.avalon.framework.configuration.Configuration configuration)
          DOCUMENT ME!
 java.lang.String getAuthoringPath()
          DOCUMENT ME!
 java.lang.String getExportDirectory()
          DOCUMENT ME!
 java.lang.String getLivePath()
          DOCUMENT ME!
 java.io.File getPublicationDirectory()
          Returns the publication directory.
 java.lang.String getPublicationPath()
          Returns the publication directory.
static java.lang.String getPublicationPath(java.lang.String servletContextPath, java.lang.String publicationId)
          DOCUMENT ME!
 java.lang.String getReplicationDirectory()
          DOCUMENT ME!
 java.lang.String getSubstituteExpression()
          DOCUMENT ME!
 java.lang.String getSubstituteReplacement()
          Get the replacement string, which was read from publisher.xconf
 java.lang.String getTreeAuthoringPath()
          DOCUMENT ME!
 java.lang.String getTreeLivePath()
          DOCUMENT ME!
protected  void setAuthoringPath(java.lang.String path)
           
protected  void setExportDirectory(java.lang.String directory)
           
protected  void setLivePath(java.lang.String path)
           
protected  void setPublicationPath(java.lang.String path)
           
protected  void setReplicationDirectory(java.lang.String directory)
           
protected  void setSubstituteExpression(java.lang.String substitute)
           
protected  void setSubstituteReplacementExpression(java.lang.String replacement)
          Set replacement string, which was read from publisher.xconf
protected  void setTreeAuthoringPath(java.lang.String path)
           
protected  void setTreeLivePath(java.lang.String path)
           
 
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

PUBLICATION_PREFIX

public static final java.lang.String PUBLICATION_PREFIX

PUBLICATION_PATH

public static final java.lang.String PUBLICATION_PATH
See Also:
Constant Field Values

PARAMETER_AUTHORING_PATH

public static final java.lang.String PARAMETER_AUTHORING_PATH
See Also:
Constant Field Values

PARAMETER_TREE_AUTHORING_PATH

public static final java.lang.String PARAMETER_TREE_AUTHORING_PATH
See Also:
Constant Field Values

PARAMETER_LIVE_PATH

public static final java.lang.String PARAMETER_LIVE_PATH
See Also:
Constant Field Values

PARAMETER_TREE_LIVE_PATH

public static final java.lang.String PARAMETER_TREE_LIVE_PATH
See Also:
Constant Field Values

PARAMETER_REPLICATION_PATH

public static final java.lang.String PARAMETER_REPLICATION_PATH
See Also:
Constant Field Values

PARAMETER_EXPORT_PATH

public static final java.lang.String PARAMETER_EXPORT_PATH
See Also:
Constant Field Values

PARAMETER_SUBSTITUTE_REGEXP

public static final java.lang.String PARAMETER_SUBSTITUTE_REGEXP
See Also:
Constant Field Values

PARAMETER_SUBSTITUTE_REPLACEMENT

public static final java.lang.String PARAMETER_SUBSTITUTE_REPLACEMENT
See Also:
Constant Field Values
Constructor Detail

PublishingEnvironment

public PublishingEnvironment(java.lang.String contextPath,
                             java.lang.String publicationId)
Creates a new PublishingEnvironment object.

Parameters:
contextPath - DOCUMENT ME!
publicationId - DOCUMENT ME!

PublishingEnvironment

public PublishingEnvironment(java.lang.String publicationPath)
Creates a new PublishingEnvironment object.

Parameters:
publicationPath - DOCUMENT ME!
Method Detail

configure

public void configure(org.apache.avalon.framework.configuration.Configuration configuration)
               throws org.apache.avalon.framework.configuration.ConfigurationException
DOCUMENT ME!

Specified by:
configure in interface org.apache.avalon.framework.configuration.Configurable
Parameters:
configuration - DOCUMENT ME!
Throws:
org.apache.avalon.framework.configuration.ConfigurationException - DOCUMENT ME!

getPublicationPath

public java.lang.String getPublicationPath()
Returns the publication directory.

Returns:
DOCUMENT ME!

getPublicationDirectory

public java.io.File getPublicationDirectory()
Returns the publication directory.


setPublicationPath

protected void setPublicationPath(java.lang.String path)

getAuthoringPath

public java.lang.String getAuthoringPath()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setAuthoringPath

protected void setAuthoringPath(java.lang.String path)

getLivePath

public java.lang.String getLivePath()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setLivePath

protected void setLivePath(java.lang.String path)

getTreeAuthoringPath

public java.lang.String getTreeAuthoringPath()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setTreeAuthoringPath

protected void setTreeAuthoringPath(java.lang.String path)

getTreeLivePath

public java.lang.String getTreeLivePath()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setTreeLivePath

protected void setTreeLivePath(java.lang.String path)

getReplicationDirectory

public java.lang.String getReplicationDirectory()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setReplicationDirectory

protected void setReplicationDirectory(java.lang.String directory)

getExportDirectory

public java.lang.String getExportDirectory()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setExportDirectory

protected void setExportDirectory(java.lang.String directory)

getSubstituteExpression

public java.lang.String getSubstituteExpression()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setSubstituteExpression

protected void setSubstituteExpression(java.lang.String substitute)

setSubstituteReplacementExpression

protected void setSubstituteReplacementExpression(java.lang.String replacement)
Set replacement string, which was read from publisher.xconf


getSubstituteReplacement

public java.lang.String getSubstituteReplacement()
Get the replacement string, which was read from publisher.xconf

Returns:
The replacement string

getPublicationPath

public static java.lang.String getPublicationPath(java.lang.String servletContextPath,
                                                  java.lang.String publicationId)
DOCUMENT ME!

Parameters:
servletContextPath - DOCUMENT ME!
publicationId - DOCUMENT ME!
Returns:
DOCUMENT ME!


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.