org.opencms.gwt

类 CmsCoreService

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

org.opencms.gwt.CmsCoreService

所有已实现的接口:

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

public class CmsCoreService
extends CmsGwtService
implements I_CmsCoreService

Provides general core services.

从以下版本开始:

8.0.0

另请参阅:

CmsCoreService, I_CmsCoreService, I_CmsCoreServiceAsync, 序列化表格

字段概要

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

perThreadRequest, perThreadResponse

构造器概要

构造器

构造器和说明
CmsCoreService()

方法概要

方法

限定符和类型	方法和说明
CmsUUID	createUUID() Creates a new UUID.
protected java.util.Map<java.lang.String,java.lang.String>	getBuildIds() Collect GWT build ids from the different ADE modules.
java.util.List<CmsCategoryTreeEntry>	getCategories(java.lang.String fromPath, boolean includeSubCats, java.util.List<java.lang.String> refPaths) Returns the categories for the given search parameters.
java.util.List<CmsCategoryTreeEntry>	getCategoriesForSitePath(java.lang.String sitePath) Returns the categories for the given reference site-path.
CmsResourceCategoryInfo	getCategoryInfo(CmsUUID structureId) Returns the category information for the given resource.
static java.util.List<CmsContextMenuEntryBean>	getContextMenuEntries(CmsObject cms, CmsUUID structureId, CmsCoreData.AdeContext context) Returns the context menu entries for the given URI.
java.util.List<CmsContextMenuEntryBean>	getContextMenuEntries(CmsUUID structureId, CmsCoreData.AdeContext context) Returns the context menu entries for the given URI.
CmsReturnLinkInfo	getLinkForReturnCode(java.lang.String returnCode) Given a return code, returns the link to the page which corresponds to the return code.
protected CmsLockInfo	getLock(CmsUUID structureId) Helper method for locking a resource which returns some information on whether the locking failed, and why.
protected CmsLockInfo	getLock(java.lang.String sitepath) Helper method for locking a resource which returns some information on whether the locking failed, and why.
CmsResourceState	getResourceState(CmsUUID structureId) Gets the resource state for a resource with a given path.
java.lang.String	getUniqueFileName(java.lang.String parentFolder, java.lang.String baseName) Returns a unique filename for the given base name and the parent folder.
static I_CmsValidationService	getValidationService(java.lang.String name) Internal helper method for getting a validation service.
java.lang.String	getWorkplaceLink(CmsUUID structureId) Returns a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.
static <T> T	instantiate(java.lang.Class<T> anInterface, java.lang.String className) Instantiates a class given its name using its default constructor.
CmsReturnLinkInfo	internalGetLinkForReturnCode(java.lang.String returnCode) Implementation method for getting the link for a given return code.
java.lang.String	lockIfExists(java.lang.String sitePath) Locks the given resource with a temporary lock if it exists.
java.lang.String	lockTemp(CmsUUID structureId) Locks the given resource with a temporary lock.
CmsLockInfo	lockTempAndCheckModification(CmsUUID structureId, long modification) Locks the given resource with a temporary lock additionally checking that the given resource has not been modified after the given timestamp.
void	ping() An RPC method which does nothing and is just used to keep the session alive.
CmsCoreData	prefetch() Generates core data for prefetching in the host page.
static CmsCoreData	prefetch(javax.servlet.http.HttpServletRequest request) Fetches the core data.
void	setAvailabilityInfo(CmsUUID structureId, CmsAvailabilityInfoBean bean) Applies the changes stored in the info bean to the vfs of OpenCms.
void	setAvailabilityInfo(java.lang.String uri, CmsAvailabilityInfoBean bean) Applies the changes stored in the info bean to the vfs of OpenCms.
void	setResourceCategories(CmsUUID structureId, java.util.List<java.lang.String> categories) Sets the categories of the given resource.
void	setShowEditorHelp(boolean visible) Sets the show editor help flag.
void	setToolbarVisible(boolean visible) Writes the tool-bar visibility into the session cache.
java.lang.String	unlock(CmsUUID structureId) Unlocks the given resource.
java.lang.String	unlock(java.lang.String sitePath) Unlocks the given resource.
java.util.Map<java.lang.String,CmsValidationResult>	validate(java.util.Map<java.lang.String,CmsValidationQuery> validationQueries) Performs a batch of validations and returns the results.
java.util.Map<java.lang.String,CmsValidationResult>	validate(java.lang.String formValidatorClass, java.util.Map<java.lang.String,CmsValidationQuery> validationQueries, java.util.Map<java.lang.String,java.lang.String> values, java.lang.String config) Performs a batch of validations using a custom form validator class.

从类继承的方法 org.opencms.gwt.CmsGwtService

checkPermissions, clearThreadStorage, doGetSerializationPolicy, doUnexpectedFailure, ensureLock, ensureLock, ensureLock, ensureSession, error, getCmsObject, getPropertiesByName, getRequest, getResponse, log, log, logError, service, setCms, setContext, setRequest, setResponse, tryUnlock

从类继承的方法 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

构造器详细资料

CmsCoreService

public CmsCoreService()

方法详细资料

getContextMenuEntries

public static java.util.List<CmsContextMenuEntryBean> getContextMenuEntries(CmsObject cms,
                                                            CmsUUID structureId,
                                                            CmsCoreData.AdeContext context)

Returns the context menu entries for the given URI.

参数:

cms - the cms context

structureId - the currently requested structure id

context - the ade context (sitemap or containerpage)

返回:

the context menu entries

getValidationService

public static I_CmsValidationService getValidationService(java.lang.String name)
                                                   throws CmsException

Internal helper method for getting a validation service.

参数:

name - the class name of the validation service

返回:

the validation service

抛出:

CmsException - if something goes wrong

instantiate

public static <T> T instantiate(java.lang.Class<T> anInterface,
                java.lang.String className)
                     throws CmsException

Instantiates a class given its name using its default constructor.

Also checks whether the class with the given name is the subclass of another class/interface.

类型参数:

T - the type of the interface/class passed as a parameter

参数:

anInterface - the interface or class against which the class should be checked

className - the name of the class

返回:

a new instance of the class

抛出:

CmsException - if the instantiation fails

prefetch

public static CmsCoreData prefetch(javax.servlet.http.HttpServletRequest request)

Fetches the core data.

参数:

request - the current request

返回:

the core data

createUUID

public CmsUUID createUUID()

从接口复制的说明: I_CmsCoreService

Creates a new UUID.

指定者:

createUUID 在接口中 I_CmsCoreService

返回:

the created UUID

另请参阅:

I_CmsCoreService.createUUID()

getCategories

public java.util.List<CmsCategoryTreeEntry> getCategories(java.lang.String fromPath,
                                                 boolean includeSubCats,
                                                 java.util.List<java.lang.String> refPaths)
                                                   throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Returns the categories for the given search parameters.

指定者:

getCategories 在接口中 I_CmsCoreService

参数:

fromPath - the category path to start with, can be null or empty to use the root

includeSubCats - if to include all categories, or first level child categories only

refPaths - the reference paths, can be null to only use the system repository

返回:

the resource categories

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.getCategories(java.lang.String, boolean, java.util.List)

getCategoriesForSitePath

public java.util.List<CmsCategoryTreeEntry> getCategoriesForSitePath(java.lang.String sitePath)
                                                              throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Returns the categories for the given reference site-path.

指定者:

getCategoriesForSitePath 在接口中 I_CmsCoreService

参数:

sitePath - the reference site-path

返回:

the categories for the given reference site-path

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.getCategoriesForSitePath(java.lang.String)

getCategoryInfo

public CmsResourceCategoryInfo getCategoryInfo(CmsUUID structureId)
                                        throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Returns the category information for the given resource.

指定者:

getCategoryInfo 在接口中 I_CmsCoreService

参数:

structureId - the resource structure id

返回:

the category information

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.getCategoryInfo(org.opencms.util.CmsUUID)

getContextMenuEntries

public java.util.List<CmsContextMenuEntryBean> getContextMenuEntries(CmsUUID structureId,
                                                            CmsCoreData.AdeContext context)
                                                              throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Returns the context menu entries for the given URI.

指定者:

getContextMenuEntries 在接口中 I_CmsCoreService

参数:

structureId - the currently requested structure id

context - the ade context (sitemap or containerpage)

返回:

the context menu entries

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.getContextMenuEntries(org.opencms.util.CmsUUID, org.opencms.gwt.shared.CmsCoreData.AdeContext)

getLinkForReturnCode

public CmsReturnLinkInfo getLinkForReturnCode(java.lang.String returnCode)
                                       throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Given a return code, returns the link to the page which corresponds to the return code.

指定者:

getLinkForReturnCode 在接口中 I_CmsCoreService

参数:

returnCode - the return code

返回:

the link for the return code

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.getLinkForReturnCode(java.lang.String)

getResourceState

public CmsResourceState getResourceState(CmsUUID structureId)
                                  throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Gets the resource state for a resource with a given path.

指定者:

getResourceState 在接口中 I_CmsCoreService

参数:

structureId - the resource structure id

返回:

the resource state of the resource

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.getResourceState(org.opencms.util.CmsUUID)

getUniqueFileName

public java.lang.String getUniqueFileName(java.lang.String parentFolder,
                                 java.lang.String baseName)

从接口复制的说明: I_CmsCoreService

Returns a unique filename for the given base name and the parent folder.

指定者:

getUniqueFileName 在接口中 I_CmsCoreService

参数:

parentFolder - the parent folder of the file

baseName - the proposed file name

返回:

the unique file name

另请参阅:

I_CmsCoreService.getUniqueFileName(java.lang.String, java.lang.String)

getWorkplaceLink

public java.lang.String getWorkplaceLink(CmsUUID structureId)
                                  throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Returns a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.

指定者:

getWorkplaceLink 在接口中 I_CmsCoreService

参数:

structureId - the structure id of the resource for which to open the workplace

返回:

a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.getWorkplaceLink(org.opencms.util.CmsUUID)

internalGetLinkForReturnCode

public CmsReturnLinkInfo internalGetLinkForReturnCode(java.lang.String returnCode)
                                               throws CmsException

Implementation method for getting the link for a given return code.

参数:

returnCode - the return code

返回:

the link for the return code

抛出:

CmsException - if something goes wrong

lockIfExists

public java.lang.String lockIfExists(java.lang.String sitePath)
                              throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Locks the given resource with a temporary lock if it exists.

If the resource does not exist yet, the closest existing ancestor folder will check if it is lockable.

指定者:

lockIfExists 在接口中 I_CmsCoreService

参数:

sitePath - the site path of the resource to lock

返回:

null if successful, an error message if not

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.lockIfExists(java.lang.String)

lockTemp

public java.lang.String lockTemp(CmsUUID structureId)
                          throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Locks the given resource with a temporary lock.

指定者:

lockTemp 在接口中 I_CmsCoreService

参数:

structureId - the structure id of the resource to lock

返回:

null if successful, an error message if not

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.lockTemp(org.opencms.util.CmsUUID)

lockTempAndCheckModification

public CmsLockInfo lockTempAndCheckModification(CmsUUID structureId,
                                       long modification)
                                         throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Locks the given resource with a temporary lock additionally checking that the given resource has not been modified after the given timestamp.

指定者:

lockTempAndCheckModification 在接口中 I_CmsCoreService

参数:

structureId - the structure id of the resource to lock

modification - the timestamp to check

返回:

null if successful, an error message if not

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.lockTempAndCheckModification(org.opencms.util.CmsUUID, long)

ping

public void ping()

从接口复制的说明: I_CmsCoreService

An RPC method which does nothing and is just used to keep the session alive.

指定者:

ping 在接口中 I_CmsCoreService

另请参阅:

I_CmsCoreService.ping()

prefetch

public CmsCoreData prefetch()

从接口复制的说明: I_CmsCoreService

Generates core data for prefetching in the host page.

指定者:

prefetch 在接口中 I_CmsCoreService

返回:

the core data

另请参阅:

I_CmsCoreService.prefetch()

setAvailabilityInfo

public void setAvailabilityInfo(CmsUUID structureId,
                       CmsAvailabilityInfoBean bean)
                         throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Applies the changes stored in the info bean to the vfs of OpenCms.

指定者:

setAvailabilityInfo 在接口中 I_CmsCoreService

参数:

structureId - the structure id of the modified resource

bean - the bean with the information of the dialog

抛出:

CmsRpcException - if the RPC call goes wrong

另请参阅:

I_CmsCoreService.setAvailabilityInfo(org.opencms.util.CmsUUID, org.opencms.gwt.shared.CmsAvailabilityInfoBean)

setAvailabilityInfo

public void setAvailabilityInfo(java.lang.String uri,
                       CmsAvailabilityInfoBean bean)
                         throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Applies the changes stored in the info bean to the vfs of OpenCms.

指定者:

setAvailabilityInfo 在接口中 I_CmsCoreService

参数:

uri - the vfs path of the modified resource

bean - the bean with the information of the dialog

抛出:

CmsRpcException - if the RPC call goes wrong

另请参阅:

I_CmsCoreService.setAvailabilityInfo(java.lang.String, org.opencms.gwt.shared.CmsAvailabilityInfoBean)

setResourceCategories

public void setResourceCategories(CmsUUID structureId,
                         java.util.List<java.lang.String> categories)
                           throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Sets the categories of the given resource. Will remove all other categories.

指定者:

setResourceCategories 在接口中 I_CmsCoreService

参数:

structureId - the resource structure id

categories - the categories to set

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.setResourceCategories(org.opencms.util.CmsUUID, java.util.List)

setShowEditorHelp

public void setShowEditorHelp(boolean visible)
                       throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Sets the show editor help flag.

指定者:

setShowEditorHelp 在接口中 I_CmsCoreService

参数:

visible - the show help flag

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.setShowEditorHelp(boolean)

setToolbarVisible

public void setToolbarVisible(boolean visible)
                       throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Writes the tool-bar visibility into the session cache.

指定者:

setToolbarVisible 在接口中 I_CmsCoreService

参数:

visible - true if the tool-bar is visible

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.setToolbarVisible(boolean)

unlock

public java.lang.String unlock(CmsUUID structureId)
                        throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Unlocks the given resource.

指定者:

unlock 在接口中 I_CmsCoreService

参数:

structureId - the structure id of the resource to unlock

返回:

null if successful, an error message if not

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.unlock(org.opencms.util.CmsUUID)

unlock

public java.lang.String unlock(java.lang.String sitePath)
                        throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Unlocks the given resource.

指定者:

unlock 在接口中 I_CmsCoreService

参数:

sitePath - the site path of the resource to unlock

返回:

null if successful, an error message if not

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.unlock(java.lang.String)

validate

public java.util.Map<java.lang.String,CmsValidationResult> validate(java.util.Map<java.lang.String,CmsValidationQuery> validationQueries)
                                                             throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Performs a batch of validations and returns the results.

指定者:

validate 在接口中 I_CmsCoreService

参数:

validationQueries - a map from field names to validation queries

返回:

a map from field names to validation results

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsCoreService.validate(java.util.Map)

validate

public java.util.Map<java.lang.String,CmsValidationResult> validate(java.lang.String formValidatorClass,
                                                           java.util.Map<java.lang.String,CmsValidationQuery> validationQueries,
                                                           java.util.Map<java.lang.String,java.lang.String> values,
                                                           java.lang.String config)
                                                             throws CmsRpcException

从接口复制的说明: I_CmsCoreService

Performs a batch of validations using a custom form validator class.

指定者:

validate 在接口中 I_CmsCoreService

参数:

formValidatorClass - the class name of the form validator

validationQueries - a map from field names to validation queries

values - the map of all field values

config - the form validator configuration string

返回:

a map from field names to validation results

抛出:

CmsRpcException - if the RPC call goes wrong

另请参阅:

I_CmsCoreService.validate(java.lang.String, java.util.Map, java.util.Map, java.lang.String)

getBuildIds

protected java.util.Map<java.lang.String,java.lang.String> getBuildIds()

Collect GWT build ids from the different ADE modules.

返回:

the map of GWT build ids

getLock

protected CmsLockInfo getLock(CmsUUID structureId)
                       throws CmsException

Helper method for locking a resource which returns some information on whether the locking failed, and why.

参数:

structureId - the structure id of the resource

返回:

the locking information

抛出:

CmsException - if something went wrong

getLock

protected CmsLockInfo getLock(java.lang.String sitepath)
                       throws CmsException

Helper method for locking a resource which returns some information on whether the locking failed, and why.

参数:

sitepath - the site path of the resource to lock

返回:

the locking information

抛出:

CmsException - if something went wrong