Save This Page
Home » cocoon-2.1.11-src » org.apache » cocoon » [javadoc | source]
org.apache.cocoon
public class: Cocoon [javadoc | source]
java.lang.Object
   org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.Cocoon

All Implemented Interfaces:
    Modifiable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.thread.ThreadSafe, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.activity.Initializable, org.apache.excalibur.instrument.InstrumentManageable, org.apache.avalon.framework.component.Composable, Processor

The Cocoon Object is the main Kernel for the entire Cocoon system.
Field Summary
static  Cocoon instance     
protected  SourceResolver sourceResolver    The source resolver 
protected  RequestListener requestListener    An optional Avalon Component that is called before and after processing all requests. 
Constructor:
 public Cocoon() throws ConfigurationException 
    Creates a new Cocoon instance.
    Throws:
    ConfigurationException - if an error occurs
    exception: ConfigurationException - if an error occurs
Method from org.apache.cocoon.Cocoon Summary:
buildPipeline,   compose,   configure,   contextualize,   createSourceResolver,   debug,   dispose,   enableLogging,   getActiveRequestCount,   getComponentConfigurations,   getComponentManager,   getRootProcessor,   getSystemProperty,   initialize,   modifiedSince,   process,   setInstrumentManager,   setLoggerManager,   setSystemProperties
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.cocoon.Cocoon Detail:
 public ProcessingPipeline buildPipeline(Environment environment) throws Exception 
    Process the given Environment to assemble a ProcessingPipeline.
 public  void compose(ComponentManager manager) throws ComponentException 
    Get the parent component manager. For purposes of avoiding extra method calls, the manager parameter may be null.
 public  void configure(ExcaliburComponentManager startupManager) throws ContextException, ConfigurationException 
    Configure this Cocoon instance.
 public  void contextualize(Context context) throws ContextException 
    Describe contextualize method here.
 protected SourceResolver createSourceResolver(Logger logger) throws ContextException 
    Create a simple source resolver.
 protected  void debug(Environment environment,
    boolean internal) 
    Log debug information about the current environment.
 public  void dispose() 
    Dispose this instance
 public  void enableLogging(Logger logger) 
 public int getActiveRequestCount() 
    Accessor for active request count
 public Map getComponentConfigurations() 
    Get the sitemap component configurations
 public ExcaliburComponentManager getComponentManager() 
 public Processor getRootProcessor() 
    Return this (Cocoon is always at the root of the processing chain).
 public static String getSystemProperty(String property,
    String value) 
    Helper method to retrieve system property. Returns default value if SecurityException is caught.
 public  void initialize() throws Exception 
    The initialize method
 public boolean modifiedSince(long date) 
    Queries the class to estimate its ergodic period termination.
 public boolean process(Environment environment) throws Exception 
    Process the given Environment to produce the output.
 public  void setInstrumentManager(InstrumentManager manager) 
    Set the InstrumentManager for this Cocoon instance.
 public  void setLoggerManager(LoggerManager loggerManager) 
    The setLoggerManager method will get a LoggerManager for further use.
 protected  void setSystemProperties() 
    Sets required system properties.