|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.avalon.framework.logger.AbstractLogEnabled
org.apache.cocoon.Cocoon
The Cocoon Object is the main Kernel for the entire Cocoon system.
Nested Class Summary |
Nested classes inherited from class org.apache.cocoon.Processor |
Processor.InternalPipelineDescription |
Field Summary | |
protected Core |
core
The Cocoon Core |
protected EnvironmentHelper |
environmentHelper
The environment helper |
protected Map |
processorAttributes
Processor attributes |
protected RequestListener |
requestListener
An optional Avalon Component that is called before and after processing all requests. |
protected CocoonServiceManager |
serviceManager
A service manager |
protected SourceResolver |
sourceResolver
The source resolver |
Fields inherited from interface org.apache.cocoon.Processor |
ROLE |
Constructor Summary | |
Cocoon()
Creates a new Cocoon instance. |
Method Summary | |
Processor.InternalPipelineDescription |
buildPipeline(Environment environment)
Process the given Environment to assemble
a ProcessingPipeline .
|
void |
contextualize(Context context)
|
protected void |
debug(Environment environment,
boolean internal)
Log debug information about the current environment. |
void |
dispose()
|
void |
enableLogging(Logger logger)
|
int |
getActiveRequestCount()
Accessor for active request count |
Object |
getAttribute(String name)
Gets an attribute |
Configuration[] |
getComponentConfigurations()
Get the sitemap component configurations |
String |
getContext()
Get the context URI for this processor |
Processor |
getRootProcessor()
Return this (Cocoon is always at the root of the processing chain). |
ServiceManager |
getServiceManager()
FIXME - Do we really need this method? |
SourceResolver |
getSourceResolver()
Get the source resolver for this processor |
static String |
getSystemProperty(String property,
String value)
Helper method to retrieve system property. |
void |
initialize()
|
boolean |
modifiedSince(long date)
Queries the class to estimate its ergodic period termination. |
boolean |
process(Environment environment)
Process the given Environment producing the output. |
Object |
removeAttribute(String name)
Remove an attribute. |
void |
service(ServiceManager manager)
Get the parent service manager. |
void |
setAttribute(String name,
Object value)
Sets an attribute |
void |
setLoggerManager(LoggerManager loggerManager)
The setLoggerManager method will get a LoggerManager
for further use. |
protected void |
setSystemProperties()
Sets required system properties. |
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled |
getLogger, setupLogger, setupLogger, setupLogger |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected SourceResolver sourceResolver
protected EnvironmentHelper environmentHelper
protected CocoonServiceManager serviceManager
protected RequestListener requestListener
protected Core core
protected Map processorAttributes
Constructor Detail |
public Cocoon()
Cocoon
instance.
Method Detail |
public void enableLogging(Logger logger)
enableLogging
in interface LogEnabled
LogEnabled.enableLogging(org.apache.avalon.framework.logger.Logger)
public void service(ServiceManager manager) throws ServiceException
service
in interface Serviceable
manager
- the parent component manager. May be null
ServiceException
public void contextualize(Context context) throws ContextException
contextualize
in interface Contextualizable
ContextException
public void setLoggerManager(LoggerManager loggerManager)
setLoggerManager
method will get a LoggerManager
for further use.
loggerManager
- a LoggerManager
valuepublic void initialize() throws Exception
initialize
in interface Initializable
Exception
public boolean modifiedSince(long date)
modifiedSince
in interface Modifiable
date
- a long
value
boolean
valuepublic static String getSystemProperty(String property, String value)
protected void setSystemProperties()
public void dispose()
dispose
in interface Disposable
Disposable.dispose()
protected void debug(Environment environment, boolean internal)
environment
- an Environment
valuepublic boolean process(Environment environment) throws Exception
Processor
Environment
producing the output.
process
in interface Processor
true
is returned.
If no match is found in the sitemap false
is returned.
Exception
public Processor.InternalPipelineDescription buildPipeline(Environment environment) throws Exception
Processor
Environment
to assemble
a ProcessingPipeline
.
Don't forget to release the pipeline using
Processor.InternalPipelineDescription.release()
.
buildPipeline
in interface Processor
Exception
public Configuration[] getComponentConfigurations()
Processor
getComponentConfigurations
in interface Processor
public Processor getRootProcessor()
getRootProcessor
in interface Processor
public int getActiveRequestCount()
public SourceResolver getSourceResolver()
Processor
getSourceResolver
in interface Processor
public String getContext()
Processor
getContext
in interface Processor
public ServiceManager getServiceManager()
public Object getAttribute(String name)
Processor
getAttribute
in interface Processor
Processor.getAttribute(java.lang.String)
public Object removeAttribute(String name)
Processor
removeAttribute
in interface Processor
Processor.removeAttribute(java.lang.String)
public void setAttribute(String name, Object value)
Processor
setAttribute
in interface Processor
Processor.setAttribute(java.lang.String, java.lang.Object)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |