| javax.servlet.http.HttpServlet
 org.apache.cocoon.servlet.CocoonServlet
| Method Summary | |
| protected void | addClassLoaderDirectory(String dir)
Adds a directory to the classloader. | | protected void | addClassLoaderURL(URL URL)
Adds an URL to the classloader. | | protected synchronized void | createCocoon()
Creates the Cocoon object and handles exception handling. | | public void | destroy()
| | final protected void | disposeCocoon()
| | protected String | getClassPath()
This builds the important ClassPath used by this Servlet. | | protected Environment | getEnvironment(String uri, HttpServletRequest req, HttpServletResponse res)
| | protected String | getExtraClassPath()
Retreives the "extra-classpath" attribute, that needs to be
added to the class path. | | public String | getInitParameter(String name)
Get an initialisation parameter. | | protected String | getInitParameter(String name, String defaultValue)
| | protected boolean | getInitParameterAsBoolean(String name, boolean defaultValue)
| | protected int | getInitParameterAsInteger(String name, int defaultValue)
| | protected Logger | getLogger()
| | protected LoggerManager | getLoggerManager()
| | protected synchronized ComponentManager | getParentComponentManager()
Instatiates the parent component manager, as specified in the
parent-component-manager init parameter. | | public void | init(ServletConfig conf)
Initialize this CocoonServlet instance. | | protected void | initLogger()
Set up the log level and path. | | protected void | manageException(HttpServletRequest req, HttpServletResponse res, Environment env, String uri, int errorStatus, String title, String message, String description, Exception e)
| | public void | service(HttpServletRequest req, HttpServletResponse res)
Process the specified HttpServletRequest producing output
on the specified HttpServletResponse. | | protected void | updateEnvironment()
Method to update the environment before Cocoon instances are created.
This is also useful if you wish to customize any of the 'protected'
variables from this class before a Cocoon instance is built in a derivative
of this class (eg. |
| CONTEXT_SERVLET_CONFIG | | final public static String CONTEXT_SERVLET_CONFIG(Code) | | Application Context Key for the servlet configuration
since:
2.1.3 |
| HOUR | | final static float HOUR(Code) | | |
| MINUTE | | final static float MINUTE(Code) | | |
| PROCESSED_BY | | final protected static String PROCESSED_BY(Code) | | |
| SECOND | | final static float SECOND(Code) | | |
| allowReload | | protected boolean allowReload(Code) | | Allow reloading of cocoon by specifying the
cocoon-reload=true parameter with a request
|
| appContext | | protected DefaultContext appContext(Code) | | Avalon application context
|
| classLoader | | protected ClassLoader classLoader(Code) | | The classloader that will be set as the context classloader if init-classloader is true
|
| creationTime | | protected long creationTime(Code) | | The time the cocoon instance was created
|
| exception | | protected Exception exception(Code) | | Holds exception happened during initialization (if any)
|
| forceSystemProperty | | protected String forceSystemProperty(Code) | | |
| hiddenShowTime | | protected boolean hiddenShowTime(Code) | | If true, processing time will be added as an HTML comment
|
| initClassLoader | | protected boolean initClassLoader(Code) | | |
| requestFactory | | protected RequestFactory requestFactory(Code) | | The RequestFactory is responsible for wrapping multipart-encoded
forms and for handing the file payload of incoming requests
|
| servletContextPath | | protected String servletContextPath(Code) | | This is the path to the servlet context (or the result
of calling getRealPath('/') on the ServletContext.
Note, that this can be null.
|
| servletContextURL | | protected String servletContextURL(Code) | | This is the url to the servlet context directory
|
| showTime | | protected boolean showTime(Code) | | Allow adding processing time to the response
|
| addClassLoaderDirectory | | protected void addClassLoaderDirectory(String dir)(Code) | | Adds a directory to the classloader. Does nothing here, but is
overriden in
ParanoidCocoonServlet .
|
| addClassLoaderURL | | protected void addClassLoaderURL(URL URL)(Code) | | Adds an URL to the classloader. Does nothing here, but is
overriden in
ParanoidCocoonServlet .
|
| createCocoon | | protected synchronized void createCocoon() throws ServletException(Code) | | Creates the Cocoon object and handles exception handling.
|
| destroy | | public void destroy()(Code) | | Dispose Cocoon when servlet is destroyed
|
| disposeCocoon | | final protected void disposeCocoon()(Code) | | Destroy Cocoon
|
| getClassPath | | protected String getClassPath() throws ServletException(Code) | | This builds the important ClassPath used by this Servlet. It
does so in a Servlet Engine neutral way. It uses the
ServletContext's getRealPath method
to get the Servlet 2.2 identified classes and lib directories.
It iterates in alphabetical order through every file in the
lib directory and adds it to the classpath.
Also, we add the files to the ClassLoader for the Cocoon system.
In order to protect ourselves from skitzofrantic classloaders,
we need to work with a known one.
We need to get this to work properly when Cocoon is in a war.
throws:
ServletException - |
| getInitParameter | | public String getInitParameter(String name)(Code) | | Get an initialisation parameter. The value is trimmed, and null is returned if the trimmed value
is empty.
|
| getInitParameter | | protected String getInitParameter(String name, String defaultValue)(Code) | | Convenience method to access servlet parameters
|
| getInitParameterAsBoolean | | protected boolean getInitParameterAsBoolean(String name, boolean defaultValue)(Code) | | Convenience method to access boolean servlet parameters
|
| getInitParameterAsInteger | | protected int getInitParameterAsInteger(String name, int defaultValue)(Code) | | |
| getLogger | | protected Logger getLogger()(Code) | | |
| getLoggerManager | | protected LoggerManager getLoggerManager()(Code) | | |
| getParentComponentManager | | protected synchronized ComponentManager getParentComponentManager()(Code) | | Instatiates the parent component manager, as specified in the
parent-component-manager init parameter.
If none is specified, the method returns null.
the parent component manager, or null. |
| init | | public void init(ServletConfig conf) throws ServletException(Code) | | Initialize this CocoonServlet instance. You will
notice that I have broken the init into sub methods to make it
easier to maintain (BL). The context is passed to a couple of
the subroutines. This is also because it is better to explicitly
pass variables than implicitely. It is both more maintainable,
and more elegant.
Parameters:
conf - The ServletConfig object from the servlet engine.
throws:
ServletException - |
| initLogger | | protected void initLogger()(Code) | | Set up the log level and path. The default log level is
Priority.ERROR, although it can be overwritten by the parameter
"log-level". The log system goes to both a file and the Servlet
container's log system. Only messages that are Priority.ERROR
and above go to the servlet context. The log messages can
be as restrictive (Priority.FATAL_ERROR and above) or as liberal
(Priority.DEBUG and above) as you want that get routed to the
file.
|
| updateEnvironment | | protected void updateEnvironment() throws ServletException(Code) | | Method to update the environment before Cocoon instances are created.
This is also useful if you wish to customize any of the 'protected'
variables from this class before a Cocoon instance is built in a derivative
of this class (eg. Cocoon Context).
|
| Methods inherited from javax.servlet.http.HttpServlet | protected void doDelete(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doHead(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doOptions(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doPut(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected void doTrace(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
protected long getLastModified(HttpServletRequest req)(Code)(Java Doc)
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException(Code)(Java Doc)
public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException(Code)(Java Doc)
|
|
|