Apache Cocoon 2.1.13

The Apache Software Foundation is proud to present...

Version: 2.1.13

Java2HTML example

Orthogonal views: Content Pretty content Links

Source file: Cocoon

Summary
Package	Type	Name	Description
org.apache.cocoon	class	Cocoon	The Cocoon Object is the main Kernel for the entire Cocoon system

Field Summary
Modifier	Type	Name	Description
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 Summary
Modifier	Name	Description
public	Cocoon ()	Creates a new<code>Cocoon</code>instance

Method Summary
Modifier	Type	Name	Description
public	void	enableLogging (Logger logger)
public	void	compose (ComponentManager manager)	Get the parent component manager
public	void	contextualize (Context context)	Describe<code>contextualize</code>method here
public	void	setLoggerManager (LoggerManager loggerManager)	The<code>setLoggerManager</code>method will get a<code>LoggerManager</code>for further use
public	void	setInstrumentManager (InstrumentManager manager)	Set the<code>InstrumentManager</code>for this Cocoon instance
public	void	initialize ()	The<code>initialize</code>method
private	void	dumpSystemProperties ()	Dump System Properties
public	void	configure (ExcaliburComponentManager startupManager)	Configure this<code>Cocoon</code>instance
public	boolean	modifiedSince (long date)	Queries the class to estimate its ergodic period termination
public static	String	getSystemProperty (String property ,String value)	Helper method to retrieve system property
protected	void	setSystemProperties ()	Sets required system properties
public	void	dispose ()	Dispose this instance
protected	void	debug (Environment environment ,boolean internal)	Log debug information about the current environment
public	boolean	process (Environment environment)	Process the given<code>Environment</code>to produce the output
public	ProcessingPipeline	buildPipeline (Environment environment)	Process the given<code>Environment</code>to assemblea<code>ProcessingPipeline</code>
public	Map	getComponentConfigurations ()	Get the sitemap component configurations
public	Processor	getRootProcessor ()	Return this (Cocoon is always at the root of the processing chain)
public	int	getActiveRequestCount ()	Accessor for active request count
public	ExcaliburComponentManager	getComponentManager ()
protected	SourceResolver	createSourceResolver (Logger logger)	Create a simple source resolver

public void enableLogging (Logger logger)
Parameters: `logger` - Returns: `void`

public void compose (ComponentManager manager)
Get the parent component manager. For purposes ofavoiding extra method calls, the manager parameter may be null. Parameters: `manager` - the parent component manager. May be<code>null</code> Returns: `void`

public void contextualize (Context context)
Describe`contextualize`method here. Parameters: `context` - a<code>Context</code>value Returns: `void`

public void setLoggerManager (LoggerManager loggerManager)
The`setLoggerManager`method will get a`LoggerManager`for further use. Parameters: `loggerManager` - a<code>LoggerManager</code>value Returns: `void`

public void setInstrumentManager (InstrumentManager manager)
Set the`InstrumentManager`for this Cocoon instance. Parameters: `manager` - an<code>InstrumentManager</code>instance Returns: `void`

public void initialize ()
The`initialize`method Parameters: Returns: `void`

private void dumpSystemProperties ()
Dump System Properties Parameters: Returns: `void`

public void configure (ExcaliburComponentManager startupManager)
Configure this`Cocoon`instance. Parameters: `startupManager` - an<code>ExcaliburComponentManager</code>value Returns: `void`

public boolean modifiedSince (long date)
Queries the class to estimate its ergodic period termination. Parameters: `date` - a<code>long</code>value Returns: `boolean` - a<code>boolean</code>value

public static String getSystemProperty (String property ,String value)
Helper method to retrieve system property.Returns default value if SecurityException is caught. Parameters: `property` - `value` - Returns: `String`

protected void setSystemProperties ()
Sets required system properties. Parameters: Returns: `void`

public void dispose ()
Dispose this instance Parameters: Returns: `void`

protected void debug (Environment environment ,boolean internal)
Log debug information about the current environment. Parameters: `environment` - an<code>Environment</code>value `internal` - Returns: `void`

public boolean process (Environment environment)
Process the given`Environment`to produce the output. Parameters: `environment` - an<code>Environment</code>value Returns: `boolean` - a<code>boolean</code>value

public ProcessingPipeline buildPipeline (Environment environment)
Process the given`Environment`to assemblea`ProcessingPipeline`. Parameters: `environment` - Returns: `ProcessingPipeline`

public Map getComponentConfigurations ()
Get the sitemap component configurations Parameters: Returns: `Map`

public Processor getRootProcessor ()
Return this (Cocoon is always at the root of the processing chain). Parameters: Returns: `Processor`

public int getActiveRequestCount ()
Accessor for active request count Parameters: Returns: `int`

public ExcaliburComponentManager getComponentManager ()
Parameters: Returns: `ExcaliburComponentManager`

protected SourceResolver createSourceResolver (Logger logger)
Create a simple source resolver. Parameters: `logger` - Returns: `SourceResolver`