public class CmsCoreService extends CmsGwtService implements I_CmsCoreService
CmsCoreService
,
I_CmsCoreService
,
I_CmsCoreServiceAsync
,
Serialized FormConstructor and Description |
---|
CmsCoreService() |
Modifier and Type | Method and 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.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.
|
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.
|
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 java.lang.String |
getVaadinWorkplaceLink(CmsObject cms,
CmsUUID structureId) |
static java.lang.String |
getVaadinWorkplaceLink(CmsObject cms,
java.lang.String resourceRootFolder) |
static I_CmsValidationService |
getValidationService(java.lang.String name)
Internal helper method for getting a validation service.
|
java.lang.String |
getWorkplaceLink(CmsUUID structureId,
CmsWorkplaceLinkMode linkMode)
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.
|
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 |
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 |
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 |
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.
|
checkPermissions, clearThreadStorage, doGetSerializationPolicy, doUnexpectedFailure, ensureLock, ensureLock, ensureLock, ensureSession, error, getCmsObject, getPropertiesByName, getRequest, getResponse, log, log, logError, service, setCms, setContext, setRequest, setResponse, tryUnlock
checkPermutationStrongName, getCodeServerPolicyUrl, getRequestModuleBasePath, getSerializationPolicy, init, loadPolicyFromCodeServer, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processCall, processPost, shouldCompressResponse
doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent
doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service
public CmsCoreService()
public static java.util.List<CmsCategoryTreeEntry> buildCategoryTree(CmsObject cms, java.util.List<CmsCategory> categories)
cms
- the current cms contextcategories
- the categoriespublic static java.util.List<CmsCategoryTreeEntry> getCategoriesForSitePathStatic(CmsObject cms, java.lang.String sitePath) throws CmsException
cms
- the CMS context to usesitePath
- the site pathCmsException
- if something goes wrongpublic static java.util.List<CmsCategoryTreeEntry> getCategoriesForSitePathStatic(CmsObject cms, java.lang.String sitePath, java.lang.String localCategoryRepositoryPath) throws CmsException
cms
- the CMS context to usesitePath
- the site pathlocalCategoryRepositoryPath
- the categories for this repository are added separatelyCmsException
- if something goes wrongpublic static java.util.List<CmsContextMenuEntryBean> getContextMenuEntries(CmsObject cms, CmsUUID structureId, CmsCoreData.AdeContext context)
cms
- the cms contextstructureId
- the currently requested structure idcontext
- the ade context (sitemap or containerpage)public static java.lang.String getVaadinWorkplaceLink(CmsObject cms, CmsUUID structureId) throws CmsException
CmsException
public static java.lang.String getVaadinWorkplaceLink(CmsObject cms, java.lang.String resourceRootFolder) throws CmsException
CmsException
public static I_CmsValidationService getValidationService(java.lang.String name) throws CmsException
name
- the class name of the validation serviceCmsException
- if something goes wrongpublic static <T> T instantiate(java.lang.Class<T> anInterface, java.lang.String className) throws CmsException
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 parameteranInterface
- the interface or class against which the class should be checkedclassName
- the name of the classCmsException
- if the instantiation failspublic static CmsReturnLinkInfo internalGetLinkForReturnCode(CmsObject cms, java.lang.String returnCode) throws CmsException
cms
- the CMS contextreturnCode
- the return codeCmsException
- if something goes wrongpublic static CmsCoreData prefetch(javax.servlet.http.HttpServletRequest request)
request
- the current requestpublic java.lang.String changePassword(java.lang.String oldPassword, java.lang.String newPassword, java.lang.String newPasswordConfirm) throws CmsRpcException
I_CmsCoreService
changePassword
in interface I_CmsCoreService
oldPassword
- the old passwordnewPassword
- the value entered for the new passwordnewPasswordConfirm
- the value entered for the confirmation of the new passwordCmsRpcException
- if something goes wrongI_CmsCoreService.changePassword(java.lang.String, java.lang.String, java.lang.String)
public CmsUUID createUUID()
I_CmsCoreService
createUUID
in interface I_CmsCoreService
I_CmsCoreService.createUUID()
public java.util.List<CmsBroadcastMessage> getBroadcast()
I_CmsCoreService
getBroadcast
in interface I_CmsCoreService
I_CmsCoreService.getBroadcast()
public java.util.List<CmsCategoryTreeEntry> getCategories(java.lang.String fromPath, boolean includeSubCats, java.util.List<java.lang.String> refPaths) throws CmsRpcException
I_CmsCoreService
getCategories
in interface I_CmsCoreService
fromPath
- the category path to start with, can be null
or empty to use the rootincludeSubCats
- if to include all categories, or first level child categories onlyrefPaths
- the reference paths, can be null
to only use the system repositoryCmsRpcException
- if something goes wrongI_CmsCoreService.getCategories(java.lang.String, boolean, java.util.List)
public java.util.List<CmsCategoryTreeEntry> getCategoriesForSitePath(java.lang.String sitePath) throws CmsRpcException
I_CmsCoreService
getCategoriesForSitePath
in interface I_CmsCoreService
sitePath
- the reference site-pathCmsRpcException
- if something goes wrongI_CmsCoreService.getCategoriesForSitePath(java.lang.String)
public CmsResourceCategoryInfo getCategoryInfo(CmsUUID structureId) throws CmsRpcException
I_CmsCoreService
getCategoryInfo
in interface I_CmsCoreService
structureId
- the resource structure idCmsRpcException
- if something goes wrongI_CmsCoreService.getCategoryInfo(org.opencms.util.CmsUUID)
public java.util.List<CmsContextMenuEntryBean> getContextMenuEntries(CmsUUID structureId, CmsCoreData.AdeContext context) throws CmsRpcException
I_CmsCoreService
getContextMenuEntries
in interface I_CmsCoreService
structureId
- the currently requested structure idcontext
- the ade context (sitemap or containerpage)CmsRpcException
- if something goes wrongI_CmsCoreService.getContextMenuEntries(org.opencms.util.CmsUUID, org.opencms.gwt.shared.CmsCoreData.AdeContext)
public CmsReturnLinkInfo getLinkForReturnCode(java.lang.String returnCode) throws CmsRpcException
I_CmsCoreService
getLinkForReturnCode
in interface I_CmsCoreService
returnCode
- the return codeCmsRpcException
- if something goes wrongI_CmsCoreService.getLinkForReturnCode(java.lang.String)
public CmsResourceState getResourceState(CmsUUID structureId) throws CmsRpcException
I_CmsCoreService
getResourceState
in interface I_CmsCoreService
structureId
- the resource structure idCmsRpcException
- if something goes wrongI_CmsCoreService.getResourceState(org.opencms.util.CmsUUID)
public java.lang.String getUniqueFileName(java.lang.String parentFolder, java.lang.String baseName)
I_CmsCoreService
getUniqueFileName
in interface I_CmsCoreService
parentFolder
- the parent folder of the filebaseName
- the proposed file nameI_CmsCoreService.getUniqueFileName(java.lang.String, java.lang.String)
public java.lang.String getWorkplaceLink(CmsUUID structureId, CmsWorkplaceLinkMode linkMode) throws CmsRpcException
I_CmsCoreService
getWorkplaceLink
in interface I_CmsCoreService
structureId
- the structure id of the resource for which to open the workplacelinkMode
- the workplace link modeCmsRpcException
- if something goes wrongI_CmsCoreService.getWorkplaceLink(org.opencms.util.CmsUUID, org.opencms.gwt.shared.CmsWorkplaceLinkMode)
public CmsUserSettingsBean loadUserSettings() throws CmsRpcException
I_CmsCoreService
loadUserSettings
in interface I_CmsCoreService
CmsRpcException
- if something goes wrongI_CmsCoreService.loadUserSettings()
public java.lang.String lockIfExists(java.lang.String sitePath) throws CmsRpcException
I_CmsCoreService
If the resource does not exist yet, the closest existing ancestor folder will check if it is lockable.
lockIfExists
in interface I_CmsCoreService
sitePath
- the site path of the resource to locknull
if successful, an error message if notCmsRpcException
- if something goes wrongI_CmsCoreService.lockIfExists(java.lang.String)
public java.lang.String lockTemp(CmsUUID structureId) throws CmsRpcException
I_CmsCoreService
lockTemp
in interface I_CmsCoreService
structureId
- the structure id of the resource to locknull
if successful, an error message if notCmsRpcException
- if something goes wrongI_CmsCoreService.lockTemp(org.opencms.util.CmsUUID)
public CmsLockInfo lockTempAndCheckModification(CmsUUID structureId, long modification) throws CmsRpcException
I_CmsCoreService
lockTempAndCheckModification
in interface I_CmsCoreService
structureId
- the structure id of the resource to lockmodification
- the timestamp to checknull
if successful, an error message if notCmsRpcException
- if something goes wrongI_CmsCoreService.lockTempAndCheckModification(org.opencms.util.CmsUUID, long)
public void ping()
I_CmsCoreService
ping
in interface I_CmsCoreService
I_CmsCoreService.ping()
public CmsCoreData prefetch()
I_CmsCoreService
prefetch
in interface I_CmsCoreService
I_CmsCoreService.prefetch()
public void saveUserSettings(java.util.Map<java.lang.String,java.lang.String> userSettings, java.util.Set<java.lang.String> edited) throws CmsRpcException
I_CmsCoreService
saveUserSettings
in interface I_CmsCoreService
userSettings
- the new values for the user settingsedited
- the keys of the user settings which were actually editedCmsRpcException
- if something goes wrongI_CmsCoreService.saveUserSettings(java.util.Map, java.util.Set)
public void setAvailabilityInfo(CmsUUID structureId, CmsAvailabilityInfoBean bean) throws CmsRpcException
I_CmsCoreService
setAvailabilityInfo
in interface I_CmsCoreService
structureId
- the structure id of the modified resourcebean
- the bean with the information of the dialogCmsRpcException
- if the RPC call goes wrongI_CmsCoreService.setAvailabilityInfo(org.opencms.util.CmsUUID, org.opencms.gwt.shared.CmsAvailabilityInfoBean)
public void setAvailabilityInfo(java.lang.String uri, CmsAvailabilityInfoBean bean) throws CmsRpcException
I_CmsCoreService
setAvailabilityInfo
in interface I_CmsCoreService
uri
- the vfs path of the modified resourcebean
- the bean with the information of the dialogCmsRpcException
- if the RPC call goes wrongI_CmsCoreService.setAvailabilityInfo(java.lang.String, org.opencms.gwt.shared.CmsAvailabilityInfoBean)
public void setResourceCategories(CmsUUID structureId, java.util.List<java.lang.String> categories) throws CmsRpcException
I_CmsCoreService
setResourceCategories
in interface I_CmsCoreService
structureId
- the resource structure idcategories
- the categories to setCmsRpcException
- if something goes wrongI_CmsCoreService.setResourceCategories(org.opencms.util.CmsUUID, java.util.List)
public void setShowEditorHelp(boolean visible) throws CmsRpcException
I_CmsCoreService
setShowEditorHelp
in interface I_CmsCoreService
visible
- the show help flagCmsRpcException
- if something goes wrongI_CmsCoreService.setShowEditorHelp(boolean)
public void setToolbarVisible(boolean visible) throws CmsRpcException
I_CmsCoreService
setToolbarVisible
in interface I_CmsCoreService
visible
- true
if the tool-bar is visibleCmsRpcException
- if something goes wrongI_CmsCoreService.setToolbarVisible(boolean)
public java.lang.String unlock(CmsUUID structureId) throws CmsRpcException
I_CmsCoreService
unlock
in interface I_CmsCoreService
structureId
- the structure id of the resource to unlocknull
if successful, an error message if notCmsRpcException
- if something goes wrongI_CmsCoreService.unlock(org.opencms.util.CmsUUID)
public java.lang.String unlock(java.lang.String sitePath) throws CmsRpcException
I_CmsCoreService
unlock
in interface I_CmsCoreService
sitePath
- the root path of the resource to unlocknull
if successful, an error message if notCmsRpcException
- if something goes wrongI_CmsCoreService.unlock(java.lang.String)
public java.util.Map<java.lang.String,CmsValidationResult> validate(java.util.Map<java.lang.String,CmsValidationQuery> validationQueries) throws CmsRpcException
I_CmsCoreService
validate
in interface I_CmsCoreService
validationQueries
- a map from field names to validation queriesCmsRpcException
- if something goes wrongI_CmsCoreService.validate(java.util.Map)
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
validate
in interface I_CmsCoreService
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 stringCmsRpcException
- if the RPC call goes wrongI_CmsCoreService.validate(java.lang.String, java.util.Map, java.util.Map, java.lang.String)
protected java.util.Map<java.lang.String,java.lang.String> getBuildIds()
protected CmsLockInfo getLock(CmsUUID structureId) throws CmsException
structureId
- the structure id of the resourceCmsException
- if something went wrongprotected CmsLockInfo getLock(java.lang.String sitepath) throws CmsException
sitepath
- the site path of the resource to lockCmsException
- if something went wrong