Package 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
-
-
Constructor Summary
Constructors Constructor Description CmsCoreService()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.util.List<CmsCategoryTreeEntry>
buildCategoryTree(CmsObject cms, java.util.List<CmsCategory> categories)
Builds the tree structure for the given categories.java.lang.String
changePassword(java.lang.String oldPassword, java.lang.String newPassword, java.lang.String newPasswordConfirm)
Changes the password of the current user.CmsUUID
createUUID()
Creates a new UUID.java.util.List<CmsBroadcastMessage>
getBroadcast()
Returns the latest messages for the current user.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.lang.String refPath)
Returns the categories for the given search parameters.java.util.List<CmsCategoryTreeEntry>
getCategories(java.lang.String fromPath, boolean includeSubCats, java.lang.String refPath, boolean showWithRepositories)
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.static java.util.List<CmsCategoryTreeEntry>
getCategoriesForSitePathStatic(CmsObject cms, java.lang.String sitePath)
Helper method for getting the category beans for the given site path.static java.util.List<CmsCategoryTreeEntry>
getCategoriesForSitePathStatic(CmsObject cms, java.lang.String sitePath, java.lang.String localCategoryRepositoryPath)
Helper method for getting the category beans for the given 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.static java.lang.String
getFileExplorerLink(CmsObject cms, java.lang.String siteRoot)
Returns the file explorer link prefix.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(java.lang.String sitepath)
Helper method for locking a resource which returns some information on whether the locking failed, and why.protected CmsLockInfo
getLock(CmsUUID structureId)
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.CmsCoreData.UserInfo
getUserInfo()
Returns the user info.static java.lang.String
getVaadinWorkplaceLink(CmsObject cms, java.lang.String resourceRootFolder)
Returns the workplace link.static java.lang.String
getVaadinWorkplaceLink(CmsObject cms, CmsUUID structureId)
Returns the workplace link.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.java.lang.String
getWorkplaceLinkForPath(java.lang.String path)
Gets the workplace link for the given path.static <T> T
instantiate(java.lang.Class<T> anInterface, java.lang.String className)
Instantiates a class given its name using its default constructor.static CmsReturnLinkInfo
internalGetLinkForReturnCode(CmsObject cms, java.lang.String returnCode)
Implementation method for getting the link for a given return code.CmsUserSettingsBean
loadUserSettings()
Loads the user settings for the current user.java.lang.String
lockIfExists(java.lang.String sitePath)
Locks the given resource with a temporary lock if it exists.java.lang.String
lockIfExists(java.lang.String sitePath, long loadTime)
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.java.lang.String
lockTemp(CmsUUID structureId, long loadTime)
Locks the given resource with a temporary lock.CmsCoreData
prefetch()
Generates core data for prefetching in the host page.static CmsCoreData
prefetch(javax.servlet.http.HttpServletRequest request)
Fetches the core data.void
saveUserSettings(java.util.Map<java.lang.String,java.lang.String> userSettings, java.util.Set<java.lang.String> edited)
Saves the user settings for the current user.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(java.lang.String sitePath)
Unlocks the given resource.java.lang.String
unlock(CmsUUID structureId)
Unlocks the given resource.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.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.-
Methods inherited from class org.opencms.gwt.CmsGwtService
checkPermissions, clearThreadStorage, doGetSerializationPolicy, doUnexpectedFailure, ensureLock, ensureLock, ensureLock, ensureLock, ensureSession, error, getCmsObject, getPropertiesByName, getRequest, getResponse, isBroadcastCall, log, log, logError, service, setBroadcastPoll, setCms, setContext, setRequest, setResponse, tryUnlock
-
Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet
checkPermutationStrongName, getCodeServerPolicyUrl, getRequestModuleBasePath, getSerializationPolicy, init, loadPolicyFromCodeServer, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, 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
-
-
-
-
Constructor Detail
-
CmsCoreService
public CmsCoreService()
-
-
Method Detail
-
buildCategoryTree
public static java.util.List<CmsCategoryTreeEntry> buildCategoryTree(CmsObject cms, java.util.List<CmsCategory> categories)
Builds the tree structure for the given categories.- Parameters:
cms
- the current cms contextcategories
- the categories- Returns:
- the tree root element
-
getCategoriesForSitePathStatic
public static java.util.List<CmsCategoryTreeEntry> getCategoriesForSitePathStatic(CmsObject cms, java.lang.String sitePath) throws CmsException
Helper method for getting the category beans for the given site path.- Parameters:
cms
- the CMS context to usesitePath
- the site path- Returns:
- the list of category beans
- Throws:
CmsException
- if something goes wrong
-
getCategoriesForSitePathStatic
public static java.util.List<CmsCategoryTreeEntry> getCategoriesForSitePathStatic(CmsObject cms, java.lang.String sitePath, java.lang.String localCategoryRepositoryPath) throws CmsException
Helper method for getting the category beans for the given site path.- Parameters:
cms
- the CMS context to usesitePath
- the site pathlocalCategoryRepositoryPath
- the categories for this repository are added separately- Returns:
- the list of category beans
- Throws:
CmsException
- if something goes wrong
-
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 contextstructureId
- the currently requested structure idcontext
- the ade context (sitemap or containerpage)- Returns:
- the context menu entries
-
getFileExplorerLink
public static java.lang.String getFileExplorerLink(CmsObject cms, java.lang.String siteRoot)
Returns the file explorer link prefix. Append resource site path for complete link.- Parameters:
cms
- the cms contextsiteRoot
- the site root- Returns:
- the file explorer link prefix
-
getVaadinWorkplaceLink
public static java.lang.String getVaadinWorkplaceLink(CmsObject cms, CmsUUID structureId)
Returns the workplace link.- Parameters:
cms
- the cms contextstructureId
- the structure id of the current resource- Returns:
- the workplace link
-
getVaadinWorkplaceLink
public static java.lang.String getVaadinWorkplaceLink(CmsObject cms, java.lang.String resourceRootFolder)
Returns the workplace link.- Parameters:
cms
- the cms contextresourceRootFolder
- the resource folder root path- Returns:
- the workplace link
-
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 checkedclassName
- the name of the class- Returns:
- a new instance of the class
- Throws:
CmsException
- if the instantiation fails
-
internalGetLinkForReturnCode
public static CmsReturnLinkInfo internalGetLinkForReturnCode(CmsObject cms, java.lang.String returnCode) throws CmsException
Implementation method for getting the link for a given return code.- Parameters:
cms
- the CMS contextreturnCode
- the return code- Returns:
- the link for the return code
- Throws:
CmsException
- if something goes wrong
-
prefetch
public static CmsCoreData prefetch(javax.servlet.http.HttpServletRequest request)
Fetches the core data.- Parameters:
request
- the current request- Returns:
- the core data
-
changePassword
public java.lang.String changePassword(java.lang.String oldPassword, java.lang.String newPassword, java.lang.String newPasswordConfirm) throws CmsRpcException
Description copied from interface:I_CmsCoreService
Changes the password of the current user.- Specified by:
changePassword
in interfaceI_CmsCoreService
- Parameters:
oldPassword
- the old passwordnewPassword
- the value entered for the new passwordnewPasswordConfirm
- the value entered for the confirmation of the new password- Returns:
- an error message if an error occurred, or null if the password was successfully changed
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsCoreService.changePassword(java.lang.String, java.lang.String, java.lang.String)
-
createUUID
public CmsUUID createUUID()
Description copied from interface:I_CmsCoreService
Creates a new UUID.- Specified by:
createUUID
in interfaceI_CmsCoreService
- Returns:
- the created UUID
- See Also:
I_CmsCoreService.createUUID()
-
getBroadcast
public java.util.List<CmsBroadcastMessage> getBroadcast()
Description copied from interface:I_CmsCoreService
Returns the latest messages for the current user.- Specified by:
getBroadcast
in interfaceI_CmsCoreService
- Returns:
- the messages
- See Also:
I_CmsCoreService.getBroadcast()
-
getCategories
public java.util.List<CmsCategoryTreeEntry> getCategories(java.lang.String fromPath, boolean includeSubCats, java.lang.String refPath) throws CmsRpcException
Description copied from interface:I_CmsCoreService
Returns the categories for the given search parameters.- Specified by:
getCategories
in interfaceI_CmsCoreService
- Parameters:
fromPath
- the category path to start with, can benull
or empty to use the rootincludeSubCats
- if to include all categories, or first level child categories onlyrefPath
- the reference path (site-relative path according to which the available category repositories are determined), can benull
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.lang.String)
-
getCategories
public java.util.List<CmsCategoryTreeEntry> getCategories(java.lang.String fromPath, boolean includeSubCats, java.lang.String refPath, boolean showWithRepositories) throws CmsRpcException
Description copied from interface:I_CmsCoreService
Returns the categories for the given search parameters.- Specified by:
getCategories
in interfaceI_CmsCoreService
- Parameters:
fromPath
- the category path to start with, can benull
or empty to use the rootincludeSubCats
- if to include all categories, or first level child categories onlyrefPath
- the reference path (site-relative path according to which the available category repositories are determined), can benull
to only use the system repositoryshowWithRepositories
- flag, indicating if also the category repositories should be returned as category- Returns:
- the resource categories
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsCoreService.getCategories(java.lang.String, boolean, java.lang.String, boolean)
-
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 interfaceI_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 interfaceI_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 interfaceI_CmsCoreService
- Parameters:
structureId
- the currently requested structure idcontext
- 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 interfaceI_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 interfaceI_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 interfaceI_CmsCoreService
- Parameters:
parentFolder
- the parent folder of the filebaseName
- the proposed file name- Returns:
- the unique file name
- See Also:
I_CmsCoreService.getUniqueFileName(java.lang.String, java.lang.String)
-
getUserInfo
public CmsCoreData.UserInfo getUserInfo()
Description copied from interface:I_CmsCoreService
Returns the user info.- Specified by:
getUserInfo
in interfaceI_CmsCoreService
- Returns:
- the user info
- See Also:
I_CmsCoreService.getUserInfo()
-
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 interfaceI_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)
-
getWorkplaceLinkForPath
public java.lang.String getWorkplaceLinkForPath(java.lang.String path) throws CmsRpcException
Description copied from interface:I_CmsCoreService
Gets the workplace link for the given path.- Specified by:
getWorkplaceLinkForPath
in interfaceI_CmsCoreService
- Parameters:
path
- the path- Returns:
- the workplace link for the path
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsCoreService.getWorkplaceLinkForPath(java.lang.String)
-
loadUserSettings
public CmsUserSettingsBean loadUserSettings() throws CmsRpcException
Description copied from interface:I_CmsCoreService
Loads the user settings for the current user.- Specified by:
loadUserSettings
in interfaceI_CmsCoreService
- Returns:
- the user settings for the current user
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsCoreService.loadUserSettings()
-
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 interfaceI_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)
-
lockIfExists
public java.lang.String lockIfExists(java.lang.String sitePath, long loadTime) 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 interfaceI_CmsCoreService
- Parameters:
sitePath
- the site path of the resource to lockloadTime
- the time when the requested resource was loaded- Returns:
null
if successful, an error message if not- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsCoreService.lockIfExists(java.lang.String, long)
-
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 interfaceI_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)
-
lockTemp
public java.lang.String lockTemp(CmsUUID structureId, long loadTime) throws CmsRpcException
Description copied from interface:I_CmsCoreService
Locks the given resource with a temporary lock.Locking will fail in case the requested resource has been changed since the given load time.
- Specified by:
lockTemp
in interfaceI_CmsCoreService
- Parameters:
structureId
- the resource structure idloadTime
- the time when the requested resource was loaded- Returns:
null
if successful, an error message if not- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsCoreService.lockTemp(org.opencms.util.CmsUUID, long)
-
prefetch
public CmsCoreData prefetch()
Description copied from interface:I_CmsCoreService
Generates core data for prefetching in the host page.- Specified by:
prefetch
in interfaceI_CmsCoreService
- Returns:
- the core data
- See Also:
I_CmsCoreService.prefetch()
-
saveUserSettings
public void saveUserSettings(java.util.Map<java.lang.String,java.lang.String> userSettings, java.util.Set<java.lang.String> edited) throws CmsRpcException
Description copied from interface:I_CmsCoreService
Saves the user settings for the current user.- Specified by:
saveUserSettings
in interfaceI_CmsCoreService
- Parameters:
userSettings
- the new values for the user settingsedited
- the keys of the user settings which were actually edited- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsCoreService.saveUserSettings(java.util.Map, java.util.Set)
-
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 interfaceI_CmsCoreService
- Parameters:
structureId
- the resource structure idcategories
- 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 interfaceI_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 interfaceI_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 interfaceI_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 interfaceI_CmsCoreService
- Parameters:
sitePath
- the root 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 interfaceI_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 interfaceI_CmsCoreService
- Parameters:
formValidatorClass
- the class name of the form validatorvalidationQueries
- a map from field names to validation queriesvalues
- the map of all field valuesconfig
- 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
-
-