org.opencms.gwt

Class 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

All Implemented Interfaces:

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.

Since:

8.0.0

See Also:

CmsCoreService, I_CmsCoreService, I_CmsCoreServiceAsync, Serialized Form

Field Summary

Fields inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

perThreadRequest, perThreadResponse

Constructor Summary

Constructors

Constructor and Description
CmsCoreService()

Method Summary

Methods

Modifier and Type	Method and Description
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.

Methods inherited from 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

Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet

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

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsCoreService

public CmsCoreService()

Method Detail

getContextMenuEntries

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

Returns the context menu entries for the given URI.

Parameters:

cms - the cms context

structureId - the currently requested structure id

context - the ade context (sitemap or containerpage)

Returns:

the context menu entries

getValidationService

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

Internal helper method for getting a validation service.

Parameters:

name - the class name of the validation service

Returns:

the validation service

Throws:

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.

Type Parameters:

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

Parameters:

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

className - the name of the class

Returns:

a new instance of the class

Throws:

CmsException - if the instantiation fails

prefetch

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

Fetches the core data.

Parameters:

request - the current request

Returns:

the core data

createUUID

public CmsUUID createUUID()

Description copied from interface: I_CmsCoreService

Creates a new UUID.

Specified by:

createUUID in interface I_CmsCoreService

Returns:

the created UUID

See Also:

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

Description copied from interface: I_CmsCoreService

Returns the categories for the given search parameters.

Specified by:

getCategories in interface I_CmsCoreService

Parameters:

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

Returns:

the resource categories

Throws:

CmsRpcException - if something goes wrong

See Also:

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

getCategoriesForSitePath

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

Description copied from interface: I_CmsCoreService

Returns the categories for the given reference site-path.

Specified by:

getCategoriesForSitePath in interface I_CmsCoreService

Parameters:

sitePath - the reference site-path

Returns:

the categories for the given reference site-path

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsCoreService.getCategoriesForSitePath(java.lang.String)

getCategoryInfo

public CmsResourceCategoryInfo getCategoryInfo(CmsUUID structureId)
                                        throws CmsRpcException

Description copied from interface: I_CmsCoreService

Returns the category information for the given resource.

Specified by:

getCategoryInfo in interface I_CmsCoreService

Parameters:

structureId - the resource structure id

Returns:

the category information

Throws:

CmsRpcException - if something goes wrong

See Also:

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

getContextMenuEntries

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

Description copied from interface: I_CmsCoreService

Returns the context menu entries for the given URI.

Specified by:

getContextMenuEntries in interface I_CmsCoreService

Parameters:

structureId - the currently requested structure id

context - the ade context (sitemap or containerpage)

Returns:

the context menu entries

Throws:

CmsRpcException - if something goes wrong

See Also:

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

getLinkForReturnCode

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

Description copied from interface: I_CmsCoreService

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

Specified by:

getLinkForReturnCode in interface I_CmsCoreService

Parameters:

returnCode - the return code

Returns:

the link for the return code

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsCoreService.getLinkForReturnCode(java.lang.String)

getResourceState

public CmsResourceState getResourceState(CmsUUID structureId)
                                  throws CmsRpcException

Description copied from interface: I_CmsCoreService

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

Specified by:

getResourceState in interface I_CmsCoreService

Parameters:

structureId - the resource structure id

Returns:

the resource state of the resource

Throws:

CmsRpcException - if something goes wrong

See Also:

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

getUniqueFileName

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

Description copied from interface: I_CmsCoreService

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

Specified by:

getUniqueFileName in interface I_CmsCoreService

Parameters:

parentFolder - the parent folder of the file

baseName - the proposed file name

Returns:

the unique file name

See Also:

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

getWorkplaceLink

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

Description copied from interface: 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.

Specified by:

getWorkplaceLink in interface I_CmsCoreService

Parameters:

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

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.

Throws:

CmsRpcException - if something goes wrong

See Also:

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.

Parameters:

returnCode - the return code

Returns:

the link for the return code

Throws:

CmsException - if something goes wrong

lockIfExists

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

Description copied from interface: 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.

Specified by:

lockIfExists in interface I_CmsCoreService

Parameters:

sitePath - the site path of the resource to lock

Returns:

null if successful, an error message if not

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsCoreService.lockIfExists(java.lang.String)

lockTemp

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

Description copied from interface: I_CmsCoreService

Locks the given resource with a temporary lock.

Specified by:

lockTemp in interface I_CmsCoreService

Parameters:

structureId - the structure id of the resource to lock

Returns:

null if successful, an error message if not

Throws:

CmsRpcException - if something goes wrong

See Also:

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

lockTempAndCheckModification

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

Description copied from interface: I_CmsCoreService

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

Specified by:

lockTempAndCheckModification in interface I_CmsCoreService

Parameters:

structureId - the structure id of the resource to lock

modification - the timestamp to check

Returns:

null if successful, an error message if not

Throws:

CmsRpcException - if something goes wrong

See Also:

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

ping

public void ping()

Description copied from interface: I_CmsCoreService

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

Specified by:

ping in interface I_CmsCoreService

See Also:

I_CmsCoreService.ping()

prefetch

public CmsCoreData prefetch()

Description copied from interface: I_CmsCoreService

Generates core data for prefetching in the host page.

Specified by:

prefetch in interface I_CmsCoreService

Returns:

the core data

See Also:

I_CmsCoreService.prefetch()

setAvailabilityInfo

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

Description copied from interface: I_CmsCoreService

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

Specified by:

setAvailabilityInfo in interface I_CmsCoreService

Parameters:

structureId - the structure id of the modified resource

bean - the bean with the information of the dialog

Throws:

CmsRpcException - if the RPC call goes wrong

See Also:

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

setAvailabilityInfo

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

Description copied from interface: I_CmsCoreService

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

Specified by:

setAvailabilityInfo in interface I_CmsCoreService

Parameters:

uri - the vfs path of the modified resource

bean - the bean with the information of the dialog

Throws:

CmsRpcException - if the RPC call goes wrong

See Also:

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

Description copied from interface: I_CmsCoreService

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

Specified by:

setResourceCategories in interface I_CmsCoreService

Parameters:

structureId - the resource structure id

categories - the categories to set

Throws:

CmsRpcException - if something goes wrong

See Also:

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

setShowEditorHelp

public void setShowEditorHelp(boolean visible)
                       throws CmsRpcException

Description copied from interface: I_CmsCoreService

Sets the show editor help flag.

Specified by:

setShowEditorHelp in interface I_CmsCoreService

Parameters:

visible - the show help flag

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsCoreService.setShowEditorHelp(boolean)

setToolbarVisible

public void setToolbarVisible(boolean visible)
                       throws CmsRpcException

Description copied from interface: I_CmsCoreService

Writes the tool-bar visibility into the session cache.

Specified by:

setToolbarVisible in interface I_CmsCoreService

Parameters:

visible - true if the tool-bar is visible

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsCoreService.setToolbarVisible(boolean)

unlock

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

Description copied from interface: I_CmsCoreService

Unlocks the given resource.

Specified by:

unlock in interface I_CmsCoreService

Parameters:

structureId - the structure id of the resource to unlock

Returns:

null if successful, an error message if not

Throws:

CmsRpcException - if something goes wrong

See Also:

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

unlock

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

Description copied from interface: I_CmsCoreService

Unlocks the given resource.

Specified by:

unlock in interface I_CmsCoreService

Parameters:

sitePath - the site path of the resource to unlock

Returns:

null if successful, an error message if not

Throws:

CmsRpcException - if something goes wrong

See Also:

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

Description copied from interface: I_CmsCoreService

Performs a batch of validations and returns the results.

Specified by:

validate in interface I_CmsCoreService

Parameters:

validationQueries - a map from field names to validation queries

Returns:

a map from field names to validation results

Throws:

CmsRpcException - if something goes wrong

See Also:

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

Description copied from interface: I_CmsCoreService

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

Specified by:

validate in interface I_CmsCoreService

Parameters:

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

Returns:

a map from field names to validation results

Throws:

CmsRpcException - if the RPC call goes wrong

See Also:

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.

Returns:

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.

Parameters:

structureId - the structure id of the resource

Returns:

the locking information

Throws:

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.

Parameters:

sitepath - the site path of the resource to lock

Returns:

the locking information

Throws:

CmsException - if something went wrong