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.cocoonclassCocoonThe Cocoon Object is the main Kernel for the entire Cocoon system 

 Field Summary 
 Modifier  Type  Name  Description 
static   Cocooninstance 
protected   SourceResolversourceResolverThe source resolver 
protected   RequestListenerrequestListenerAn 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  voidenableLogging (Logger logger)  
public  voidcompose (ComponentManager manager) Get the parent component manager 
public  voidcontextualize (Context context) Describe<code>contextualize</code>method here 
public  voidsetLoggerManager (LoggerManager loggerManager) The<code>setLoggerManager</code>method will get a<code>LoggerManager</code>for further use 
public  voidsetInstrumentManager (InstrumentManager manager) Set the<code>InstrumentManager</code>for this Cocoon instance 
public  voidinitialize () The<code>initialize</code>method 
private  voiddumpSystemProperties () Dump System Properties 
public  voidconfigure (ExcaliburComponentManager startupManager) Configure this<code>Cocoon</code>instance 
public  booleanmodifiedSince (long date) Queries the class to estimate its ergodic period termination 
public  static  StringgetSystemProperty (String property ,String value) Helper method to retrieve system property 
protected  voidsetSystemProperties () Sets required system properties 
public  voiddispose () Dispose this instance 
protected  voiddebug (Environment environment ,boolean internal) Log debug information about the current environment 
public  booleanprocess (Environment environment) Process the given<code>Environment</code>to produce the output 
public  ProcessingPipelinebuildPipeline (Environment environment) Process the given<code>Environment</code>to assemblea<code>ProcessingPipeline</code> 
public  MapgetComponentConfigurations () Get the sitemap component configurations 
public  ProcessorgetRootProcessor () Return this (Cocoon is always at the root of the processing chain) 
public  intgetActiveRequestCount () Accessor for active request count 
public  ExcaliburComponentManagergetComponentManager ()  
protected  SourceResolvercreateSourceResolver (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)
Describecontextualizemethod here.
Parameters:
context - a<code>Context</code>value
Returns:
void

public  void  setLoggerManager (LoggerManager loggerManager)
ThesetLoggerManagermethod will get aLoggerManagerfor further use.
Parameters:
loggerManager - a<code>LoggerManager</code>value
Returns:
void

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

public  void  initialize ()
Theinitializemethod
Parameters:
Returns:
void

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

public  void  configure (ExcaliburComponentManager startupManager)
Configure thisCocooninstance.
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 givenEnvironmentto produce the output.
Parameters:
environment - an<code>Environment</code>value
Returns:
boolean - a<code>boolean</code>value

public  ProcessingPipeline  buildPipeline (Environment environment)
Process the givenEnvironmentto assembleaProcessingPipeline.
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