org.opencms.gwt

类 CmsGwtService

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

com.google.gwt.user.server.rpc.RemoteServiceServlet

org.opencms.gwt.CmsGwtService

所有已实现的接口:

com.google.gwt.user.server.rpc.SerializationPolicyProvider, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

直接已知子类:

CmsContainerpageService, CmsContentService, CmsCoreService, CmsGalleryService, CmsLogService, CmsPostUploadDialogService, CmsPreviewService, CmsPublishService, CmsUploadService, CmsVfsService, CmsVfsSitemapService

public class CmsGwtService
extends com.google.gwt.user.server.rpc.RemoteServiceServlet

Wrapper for GWT services served through OpenCms.

从以下版本开始:

8.0.0

另请参阅:

序列化表格

字段概要

从类继承的字段 com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

perThreadRequest, perThreadResponse

构造器概要

构造器

构造器和说明
CmsGwtService() Constructor.

方法概要

方法

限定符和类型	方法和说明
void	checkPermissions(CmsObject cms) Checks the permissions of the current user to match the required security level.
protected void	clearThreadStorage() Clears the objects stored in thread local.
protected com.google.gwt.user.server.rpc.SerializationPolicy	doGetSerializationPolicy(javax.servlet.http.HttpServletRequest request, java.lang.String moduleBaseURL, java.lang.String strongName) We do not want that the server goes to fetch files from the servlet context.
protected void	doUnexpectedFailure(java.lang.Throwable e)
protected CmsLockActionRecord	ensureLock(CmsResource resource) Locks the given resource with a temporary, if not already locked by the current user.
protected CmsLockActionRecord	ensureLock(CmsUUID structureId) Locks the given resource with a temporary, if not already locked by the current user.
protected CmsLockActionRecord	ensureLock(java.lang.String sitepath) Locks the given resource with a temporary, if not already locked by the current user.
protected void	ensureSession() Ensures that the user session is still valid.
void	error(java.lang.Throwable t) Logs and re-throws the given exception for RPC responses.
CmsObject	getCmsObject() Returns the current cms context.
protected java.util.Map<java.lang.String,CmsProperty>	getPropertiesByName(java.util.List<CmsProperty> properties) Converts a list of properties to a map.
javax.servlet.http.HttpServletRequest	getRequest() Returns the current request.
javax.servlet.http.HttpServletResponse	getResponse() Returns the current response.
void	log(java.lang.String msg)
void	log(java.lang.String message, java.lang.Throwable t)
void	logError(java.lang.Throwable t) Logs the given exception.
void	service(javax.servlet.ServletRequest arg0, javax.servlet.ServletResponse arg1)
void	setCms(CmsObject cms) Sets the current cms context.
void	setContext(CmsGwtServiceContext context) Sets the service context.
void	setRequest(javax.servlet.http.HttpServletRequest request) Sets the current request.
void	setResponse(javax.servlet.http.HttpServletResponse response) Sets the current response.
protected void	tryUnlock(CmsResource resource) Tries to unlock a resource.

从类继承的方法 com.google.gwt.user.server.rpc.RemoteServiceServlet

checkPermutationStrongName, getSerializationPolicy, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processPost, shouldCompressResponse

从类继承的方法 com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

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

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

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

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

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

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

构造器详细资料

CmsGwtService

public CmsGwtService()

Constructor.

方法详细资料

checkPermissions

public void checkPermissions(CmsObject cms)
                      throws CmsRoleViolationException

Checks the permissions of the current user to match the required security level.

Note that the current request and response are not available yet.

Override if needed.

参数:

cms - the current cms object

抛出:

CmsRoleViolationException - if the security level can not be satisfied

error

public void error(java.lang.Throwable t)
           throws CmsRpcException

Logs and re-throws the given exception for RPC responses.

参数:

t - the exception

抛出:

CmsRpcException - the converted exception

getCmsObject

public CmsObject getCmsObject()

Returns the current cms context.

返回:

the current cms context

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns the current request.

返回:

the current request

另请参阅:

AbstractRemoteServiceServlet.getThreadLocalRequest()

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Returns the current response.

返回:

the current response

另请参阅:

AbstractRemoteServiceServlet.getThreadLocalResponse()

log

public void log(java.lang.String msg)

覆盖:

log 在类中 javax.servlet.GenericServlet

另请参阅:

GenericServlet.log(java.lang.String)

log

public void log(java.lang.String message,
       java.lang.Throwable t)

覆盖:

log 在类中 javax.servlet.GenericServlet

另请参阅:

GenericServlet.log(java.lang.String, java.lang.Throwable)

logError

public void logError(java.lang.Throwable t)

Logs the given exception.

参数:

t - the exception to log

service

public void service(javax.servlet.ServletRequest arg0,
           javax.servlet.ServletResponse arg1)
             throws javax.servlet.ServletException,
                    java.io.IOException

指定者:

service 在接口中 javax.servlet.Servlet

覆盖:

service 在类中 javax.servlet.http.HttpServlet

抛出:

javax.servlet.ServletException

java.io.IOException

另请参阅:

HttpServlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)

setCms

public void setCms(CmsObject cms)

Sets the current cms context.

参数:

cms - the current cms context to set

setContext

public void setContext(CmsGwtServiceContext context)

Sets the service context.

参数:

context - the new service context

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)

Sets the current request.

参数:

request - the request to set

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse response)

Sets the current response.

参数:

response - the response to set

doGetSerializationPolicy

protected com.google.gwt.user.server.rpc.SerializationPolicy doGetSerializationPolicy(javax.servlet.http.HttpServletRequest request,
                                                                          java.lang.String moduleBaseURL,
                                                                          java.lang.String strongName)

We do not want that the server goes to fetch files from the servlet context.

覆盖:

doGetSerializationPolicy 在类中 com.google.gwt.user.server.rpc.RemoteServiceServlet

另请参阅:

RemoteServiceServlet.doGetSerializationPolicy(javax.servlet.http.HttpServletRequest, java.lang.String, java.lang.String)

doUnexpectedFailure

protected void doUnexpectedFailure(java.lang.Throwable e)

覆盖:

doUnexpectedFailure 在类中 com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

另请参阅:

AbstractRemoteServiceServlet.doUnexpectedFailure(java.lang.Throwable)

ensureLock

protected CmsLockActionRecord ensureLock(CmsResource resource)
                                  throws CmsException

Locks the given resource with a temporary, if not already locked by the current user. Will throw an exception if the resource could not be locked for the current user.

参数:

resource - the resource to lock

返回:

the assigned lock

抛出:

CmsException - if the resource could not be locked

ensureLock

protected CmsLockActionRecord ensureLock(CmsUUID structureId)
                                  throws CmsException

Locks the given resource with a temporary, if not already locked by the current user. Will throw an exception if the resource could not be locked for the current user.

参数:

structureId - the structure id of the resource

返回:

the assigned lock

抛出:

CmsException - if something goes wrong

ensureLock

protected CmsLockActionRecord ensureLock(java.lang.String sitepath)
                                  throws CmsException

Locks the given resource with a temporary, if not already locked by the current user. Will throw an exception if the resource could not be locked for the current user.

参数:

sitepath - the site-path of the resource to lock

返回:

the assigned lock

抛出:

CmsException - if the resource could not be locked

ensureSession

protected void ensureSession()
                      throws CmsException

Ensures that the user session is still valid.

抛出:

CmsException - if the current user is the guest user

getPropertiesByName

protected java.util.Map<java.lang.String,CmsProperty> getPropertiesByName(java.util.List<CmsProperty> properties)

Converts a list of properties to a map.

参数:

properties - the list of properties

返回:

a map from property names to properties

tryUnlock

protected void tryUnlock(CmsResource resource)

Tries to unlock a resource.

参数:

resource - the resource to unlock

clearThreadStorage

protected void clearThreadStorage()

Clears the objects stored in thread local.