org.opencms.main

类 OpenCmsServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.opencms.main.OpenCmsServlet

所有已实现的接口:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, I_CmsRequestHandler

直接已知子类:

OpenCmsServletErrorHandler

public class OpenCmsServlet
extends javax.servlet.http.HttpServlet
implements I_CmsRequestHandler

This the main servlet of the OpenCms system.

From here, all operations that are results of HTTP requests are invoked. Any incoming request is handled in multiple steps:

1. The requesting CmsUser is authenticated and a CmsObject with this users context information is created. This CmsObject is used to access all functions of OpenCms, limited by the authenticated users permissions. If the user is not identified, it is set to the default user, usually named "Guest".
2. The requested CmsResource is loaded into OpenCms and depending on its type (and the users persmissions to display or modify it), it is send to one of the OpenCms I_CmsResourceLoader implementations do be processed.
3. The I_CmsResourceLoader will then decide what to do with the contents of the requested CmsResource. In case of a JSP resource the JSP handling mechanism is invoked with the CmsJspLoader, in case of an image (or another static resource) this will be returned by the CmsDumpLoader etc.

从以下版本开始:

6.0.0

另请参阅:

CmsShell, CmsObject, OpenCms, 序列化表格

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	HANDLE_GWT GWT RPC services suffix.
static java.lang.String	SERVLET_PARAM_DEFAULT_WEB_APPLICATION Name of the DefaultWebApplication parameter in the web.xml OpenCms servlet configuration.
static java.lang.String	SERVLET_PARAM_OPEN_CMS_HOME Name of the OpenCmsHome parameter in the web.xml OpenCms servlet configuration.
static java.lang.String	SERVLET_PARAM_OPEN_CMS_SERVLET Name of the OpenCmsServlet parameter in the web.xml OpenCms servlet configuration.
static java.lang.String	SERVLET_PARAM_WEB_APPLICATION_CONTEXT Name of the WebApplicationContext parameter in the web.xml OpenCms servlet configuration.

构造器概要

构造器

构造器和说明
OpenCmsServlet()

方法概要

方法

限定符和类型	方法和说明
void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) OpenCms servlet main request handling method.
void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) OpenCms servlet POST request handling method, will just call doGet(HttpServletRequest, HttpServletResponse).
java.lang.String[]	getHandlerNames() Returns the handler name.
void	handle(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String name) Handles an OpenCms request.
void	init(javax.servlet.ServletConfig config)
protected void	invokeHandler(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Manages requests to internal OpenCms request handlers.
protected void	openErrorHandler(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, int errorCode) Displays an error code handler loaded from the OpenCms VFS, or if such a page does not exist, displays the default servlet container error code.

从类继承的方法 javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

从类继承的方法 javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

HANDLE_GWT

public static final java.lang.String HANDLE_GWT

GWT RPC services suffix.

另请参阅:

常量字段值

SERVLET_PARAM_DEFAULT_WEB_APPLICATION

public static final java.lang.String SERVLET_PARAM_DEFAULT_WEB_APPLICATION

Name of the DefaultWebApplication parameter in the web.xml OpenCms servlet configuration.

另请参阅:

常量字段值

SERVLET_PARAM_OPEN_CMS_HOME

public static final java.lang.String SERVLET_PARAM_OPEN_CMS_HOME

Name of the OpenCmsHome parameter in the web.xml OpenCms servlet configuration.

另请参阅:

常量字段值

SERVLET_PARAM_OPEN_CMS_SERVLET

public static final java.lang.String SERVLET_PARAM_OPEN_CMS_SERVLET

Name of the OpenCmsServlet parameter in the web.xml OpenCms servlet configuration.

另请参阅:

常量字段值

SERVLET_PARAM_WEB_APPLICATION_CONTEXT

public static final java.lang.String SERVLET_PARAM_WEB_APPLICATION_CONTEXT

Name of the WebApplicationContext parameter in the web.xml OpenCms servlet configuration.

另请参阅:

常量字段值

构造器详细资料

OpenCmsServlet

public OpenCmsServlet()

方法详细资料

doGet

public void doGet(javax.servlet.http.HttpServletRequest req,
         javax.servlet.http.HttpServletResponse res)
           throws java.io.IOException,
                  javax.servlet.ServletException

OpenCms servlet main request handling method.

覆盖:

doGet 在类中 javax.servlet.http.HttpServlet

抛出:

java.io.IOException

javax.servlet.ServletException

另请参阅:

HttpServlet.doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doPost

public void doPost(javax.servlet.http.HttpServletRequest req,
          javax.servlet.http.HttpServletResponse res)
            throws java.io.IOException,
                   javax.servlet.ServletException

OpenCms servlet POST request handling method, will just call doGet(HttpServletRequest, HttpServletResponse).

覆盖:

doPost 在类中 javax.servlet.http.HttpServlet

抛出:

java.io.IOException

javax.servlet.ServletException

另请参阅:

HttpServlet.doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getHandlerNames

public java.lang.String[] getHandlerNames()

从接口复制的说明: I_CmsRequestHandler

Returns the handler name.

指定者:

getHandlerNames 在接口中 I_CmsRequestHandler

返回:

the handler name

另请参阅:

I_CmsRequestHandler.getHandlerNames()

handle

public void handle(javax.servlet.http.HttpServletRequest req,
          javax.servlet.http.HttpServletResponse res,
          java.lang.String name)
            throws java.io.IOException,
                   javax.servlet.ServletException

从接口复制的说明: I_CmsRequestHandler

Handles an OpenCms request.

指定者:

handle 在接口中 I_CmsRequestHandler

参数:

req - the current request

res - the current response

name - the handler name to invoke

抛出:

java.io.IOException - in case an error occurs

javax.servlet.ServletException - in case an error occurs

另请参阅:

I_CmsRequestHandler.handle(HttpServletRequest, HttpServletResponse, String)

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

指定者:

init 在接口中 javax.servlet.Servlet

覆盖:

init 在类中 javax.servlet.GenericServlet

抛出:

javax.servlet.ServletException

另请参阅:

Servlet.init(javax.servlet.ServletConfig)

invokeHandler

protected void invokeHandler(javax.servlet.http.HttpServletRequest req,
                 javax.servlet.http.HttpServletResponse res)
                      throws java.io.IOException,
                             javax.servlet.ServletException

Manages requests to internal OpenCms request handlers.

参数:

req - the current request

res - the current response

抛出:

javax.servlet.ServletException - in case an error occurs

javax.servlet.ServletException - in case an error occurs

java.io.IOException - in case an error occurs

openErrorHandler

protected void openErrorHandler(javax.servlet.http.HttpServletRequest req,
                    javax.servlet.http.HttpServletResponse res,
                    int errorCode)
                         throws java.io.IOException,
                                javax.servlet.ServletException

Displays an error code handler loaded from the OpenCms VFS, or if such a page does not exist, displays the default servlet container error code.

参数:

req - the current request

res - the current response

errorCode - the error code to display

抛出:

java.io.IOException - if something goes wrong

javax.servlet.ServletException - if something goes wrong