Package org.opencms.ade.sitemap

Class CmsVfsSitemapService

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.ade.sitemap.CmsVfsSitemapService

All Implemented Interfaces:

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

public class CmsVfsSitemapService
extends CmsGwtService
implements I_CmsSitemapService

Handles all RPC services related to the vfs sitemap.

Since:

8.0.0

See Also:

• I_CmsSitemapService
• I_CmsSitemapServiceAsync
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	CmsVfsSitemapService.LockInfo	Helper class for representing information about a lock.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALIAS_DOWNLOAD_PATH	The path of the JSP used to download aliases.
static final String	ALIAS_IMPORT_PATH	The path to the JSP used to upload aliases.
static final String	ATTR_SHOW_MODEL_EDIT_CONFIRM	The show model edit confirm dialog attribute name.
static final List<String>	FILTER_PROPERTIES	Properties to remove from the copied template when creating a new sitemap entry.
static final String	GALLERIES_FOLDER_NAME	The galleries folder name.
static final String	KEY_FUNCTION_DETAIL	The configuration key for the functionDetail attribute in the container.info property.

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

perThreadRequest, perThreadResponse

Constructor Summary

Constructors

Constructor	Description
CmsVfsSitemapService()

Method Summary

Modifier and Type	Method	Description
static String	addAliasImportResult(List<CmsAliasImportResult> results)	Adds an alias import result.
void	changeCategory(String entryPoint, CmsUUID id, String title, String name)	Sets the name and title of the given category.
void	checkPermissions(CmsObject cms)	Checks the permissions of the current user to match the required security level.
void	createCategory(String entryPoint, CmsUUID id, String title, String name)	Creates a new category.
static CmsClientProperty	createClientProperty(CmsProperty prop, boolean preserveOrigin)	Creates a client property bean from a server-side property.
CmsGalleryFolderEntry	createNewGalleryFolder(String parentFolder, String title, int folderTypeId)	Creates a new gallery folder.
CmsModelPageEntry	createNewModelPage(String entryPointUri, String title, String description, CmsUUID copyId, boolean isModelGroup)	Creates a new model page.
CmsSitemapChange	createSubSitemap(CmsUUID entryId)	Creates a sub-sitemap of the given sitemap starting from the given entry.
void	disableModelPage(String baseUri, CmsUUID modelPageId, boolean disabled)	Sets the disabled flag of a model page within the current sitemap configuration.
CmsSitemapAttributeData	editAttributeData(CmsUUID rootId)	Loads the data for the attribute editor dialog and locks the sitemap configuration.
protected CmsVfsSitemapService.LockInfo	ensureLockAndGetInfo(CmsResource resource)	Locks the given resource with a temporary, if not already locked by the current user.
List<CmsAliasImportResult>	getAliasImportResult(String resultKey)	Gets the alias import results from the server.
CmsAliasInitialFetchResult	getAliasTable()	Gets the initial data for the bulk alias editor.
CmsSitemapCategoryData	getCategoryData(String entryPoint)	Gets the category data for the given entry point.
CmsClientSitemapEntry	getChildren(String entryPointUri, CmsUUID entryId, int levels)	Returns the sitemap children for the given path.
Map<CmsGalleryType,List<CmsGalleryFolderEntry>>	getGalleryData(String entryPointUri)	Returns the gallery data to this sub site.
CmsModelInfo	getModelInfos(CmsUUID rootId)	Gets the model pages for the given structure id of the sitemap root folder.
List<CmsNewResourceInfo>	getNewElementInfo(String entryPointUri)	Loads the model page data for the "add" menu.
String	getResourceLink(CmsUUID baseId, String sitePath)	Fetches the link for a resource selected in the sitemap editor.
CmsLocaleComparePropertyData	loadPropertyDataForLocaleCompareView(CmsUUID id, CmsUUID rootId)	Loads the data needed by the property editor in the locale comparison view.
CmsSitemapChange	mergeSubSitemap(String entryPoint, CmsUUID subSitemapId)	Merges a sub-sitemap into it's parent sitemap.
CmsSitemapData	prefetch(String sitemapUri)	Returns the initialization data for the given sitemap.
static CmsSitemapData	prefetch(javax.servlet.http.HttpServletRequest request, String sitemapUri)	Fetches the sitemap data.
String	prepareReloadSitemap(CmsUUID rootId, CmsSitemapData.EditorMode mode)	Prepares sitemap reloading for the given sitemap root.
void	removeModelPage(String entryPointUri, CmsUUID id)	Removes a model page from the current sitemap configuration.
CmsSitemapChange	save(String entryPoint, CmsSitemapChange change)	Saves the change to the given sitemap.
CmsAliasEditValidationReply	saveAliases(CmsAliasSaveValidationRequest saveRequest)	Saves the aliases for the bulk alias editor.
protected CmsSitemapChange	saveInternal(String entryPoint, CmsSitemapChange change)	Internal method for saving a sitemap.
void	savePropertiesForLocaleCompareMode(CmsUUID id, String newUrlName, List<CmsPropertyModification> propertyChanges, boolean editedName)	Saves the changed properties in locale comparison mode.
void	saveSitemapAttributes(CmsUUID rootId, Map<String,String> attributes)	Saves the data from the sitemap attribute editor dialog to the sitemap configuration.
CmsModelInfo	setDefaultModel(CmsUUID rootId, CmsUUID modelId)	Sets the default model page for the given sub-sitemap, returns the updated model info.
void	setEditorMode(CmsSitemapData.EditorMode editorMode)	Sets the editor mode in the current user session.
void	updateAliasEditorStatus(boolean editing)	Updates the alias editor status.
CmsAliasEditValidationReply	validateAliases(CmsAliasEditValidationRequest validationRequest)	Validates the aliases for the bulk alias editor.
CmsRewriteAliasValidationReply	validateRewriteAliases(CmsRewriteAliasValidationRequest validationRequest)	Validates rewrite aliases.

Methods inherited from class org.opencms.gwt.CmsGwtService

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

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Details

ALIAS_DOWNLOAD_PATH

public static final String ALIAS_DOWNLOAD_PATH

The path of the JSP used to download aliases.

See Also:

• Constant Field Values

ALIAS_IMPORT_PATH

public static final String ALIAS_IMPORT_PATH

The path to the JSP used to upload aliases.

See Also:

• Constant Field Values

ATTR_SHOW_MODEL_EDIT_CONFIRM

public static final String ATTR_SHOW_MODEL_EDIT_CONFIRM

The show model edit confirm dialog attribute name.

See Also:

• Constant Field Values

FILTER_PROPERTIES

public static final List<String> FILTER_PROPERTIES

Properties to remove from the copied template when creating a new sitemap entry.

GALLERIES_FOLDER_NAME

public static final String GALLERIES_FOLDER_NAME

The galleries folder name.

See Also:

• Constant Field Values

KEY_FUNCTION_DETAIL

public static final String KEY_FUNCTION_DETAIL

The configuration key for the functionDetail attribute in the container.info property.

See Also:

• Constant Field Values

Constructor Details

CmsVfsSitemapService

public CmsVfsSitemapService()

Method Details

addAliasImportResult

public static String addAliasImportResult(List<CmsAliasImportResult> results)

Adds an alias import result.

Parameters:

results - the list of alias import results to add

Returns:

the key to retrieve the alias import results

createClientProperty

public static CmsClientProperty createClientProperty(CmsProperty prop,
 boolean preserveOrigin)

Creates a client property bean from a server-side property.

Parameters:

prop - the property from which to create the client property

preserveOrigin - if true, the origin will be copied into the new object

Returns:

the new client property

prefetch

public static CmsSitemapData prefetch(javax.servlet.http.HttpServletRequest request,
 String sitemapUri)
                               throws CmsRpcException

Fetches the sitemap data.

Parameters:

request - the current request

sitemapUri - the site relative path

Returns:

the sitemap data

Throws:

CmsRpcException - if something goes wrong

changeCategory

public void changeCategory(String entryPoint,
 CmsUUID id,
 String title,
 String name)
                    throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Sets the name and title of the given category.

Specified by:

changeCategory in interface I_CmsSitemapService

Parameters:

entryPoint - the current entry point

id - the category id

title - the new title

name - the new name

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.changeCategory(java.lang.String, org.opencms.util.CmsUUID, java.lang.String, java.lang.String)

checkPermissions

public void checkPermissions(CmsObject cms)
                      throws CmsRoleViolationException

Description copied from class: CmsGwtService

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.

Overrides:

checkPermissions in class CmsGwtService

Parameters:

cms - the current cms object

Throws:

CmsRoleViolationException - if the security level can not be satisfied

See Also:

• CmsGwtService.checkPermissions(org.opencms.file.CmsObject)

createCategory

public void createCategory(String entryPoint,
 CmsUUID id,
 String title,
 String name)
                    throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Creates a new category.

Specified by:

createCategory in interface I_CmsSitemapService

Parameters:

entryPoint - the entry point

id - the parent category id

title - the title

name - the category name

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.createCategory(java.lang.String, org.opencms.util.CmsUUID, java.lang.String, java.lang.String)

createNewGalleryFolder

public CmsGalleryFolderEntry createNewGalleryFolder(String parentFolder,
 String title,
 int folderTypeId)
                                             throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Creates a new gallery folder.

Specified by:

createNewGalleryFolder in interface I_CmsSitemapService

Parameters:

parentFolder - the parent folder path

title - the title property

folderTypeId - the resource type id

Returns:

the new gallery folder data

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.createNewGalleryFolder(java.lang.String, java.lang.String, int)

createNewModelPage

public CmsModelPageEntry createNewModelPage(String entryPointUri,
 String title,
 String description,
 CmsUUID copyId,
 boolean isModelGroup)
                                     throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Creates a new model page.

Specified by:

createNewModelPage in interface I_CmsSitemapService

Parameters:

entryPointUri - the uri of the entry point

title - the title for the model page

description - the description for the model page

copyId - the structure id of the resource to copy to create a new model page; if null, the model page is created as an empty container page

isModelGroup - true to create a new model group page

Returns:

a bean representing the created model page

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.createNewModelPage(java.lang.String, java.lang.String, java.lang.String, org.opencms.util.CmsUUID, boolean)

createSubSitemap

public CmsSitemapChange createSubSitemap(CmsUUID entryId)
                                  throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Creates a sub-sitemap of the given sitemap starting from the given entry.

Specified by:

createSubSitemap in interface I_CmsSitemapService

Parameters:

entryId - the structure id of the sitemap entry to create a sub sitemap of

Returns:

the sub-sitemap creation result

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.createSubSitemap(org.opencms.util.CmsUUID)

disableModelPage

public void disableModelPage(String baseUri,
 CmsUUID modelPageId,
 boolean disabled)
                      throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Sets the disabled flag of a model page within the current sitemap configuration.

Specified by:

disableModelPage in interface I_CmsSitemapService

Parameters:

baseUri - the base uri for the current sitemap

modelPageId - structure id of the model page to remove

disabled - the disabled flag

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.disableModelPage(java.lang.String, org.opencms.util.CmsUUID, boolean)

editAttributeData

public CmsSitemapAttributeData editAttributeData(CmsUUID rootId)
                                          throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Loads the data for the attribute editor dialog and locks the sitemap configuration.

Specified by:

editAttributeData in interface I_CmsSitemapService

Parameters:

rootId - the root ID of the current sitemap

Returns:

the data for the attribute editor dialog

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.editAttributeData(org.opencms.util.CmsUUID)

getAliasImportResult

public List<CmsAliasImportResult> getAliasImportResult(String resultKey)

Description copied from interface: I_CmsSitemapService

Gets the alias import results from the server.

Specified by:

getAliasImportResult in interface I_CmsSitemapService

Parameters:

resultKey - the key which identifies the alias import results to get

Returns:

the list of alias import results

See Also:

• I_CmsSitemapService.getAliasImportResult(java.lang.String)

getAliasTable

public CmsAliasInitialFetchResult getAliasTable()
                                         throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Gets the initial data for the bulk alias editor.

Specified by:

getAliasTable in interface I_CmsSitemapService

Returns:

the initial data for the alias editor

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.getAliasTable()

getCategoryData

public CmsSitemapCategoryData getCategoryData(String entryPoint)
                                       throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Gets the category data for the given entry point.

Specified by:

getCategoryData in interface I_CmsSitemapService

Parameters:

entryPoint - the entry point

Returns:

the category data

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.getCategoryData(java.lang.String)

getChildren

public CmsClientSitemapEntry getChildren(String entryPointUri,
 CmsUUID entryId,
 int levels)
                                  throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Returns the sitemap children for the given path.

Specified by:

getChildren in interface I_CmsSitemapService

Parameters:

entryPointUri - the URI of the sitemap entry point

entryId - the entry id

levels - the count of child levels to read

Returns:

the sitemap children

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.getChildren(java.lang.String, org.opencms.util.CmsUUID, int)

getGalleryData

public Map<CmsGalleryType,List<CmsGalleryFolderEntry>> getGalleryData(String entryPointUri)

Description copied from interface: I_CmsSitemapService

Returns the gallery data to this sub site.

Specified by:

getGalleryData in interface I_CmsSitemapService

Parameters:

entryPointUri - the sub site folder

Returns:

the gallery data to this sub site

See Also:

• I_CmsSitemapService.getGalleryData(java.lang.String)

getModelInfos

public CmsModelInfo getModelInfos(CmsUUID rootId)
                           throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Gets the model pages for the given structure id of the sitemap root folder.

Specified by:

getModelInfos in interface I_CmsSitemapService

Parameters:

rootId - structure id of a folder

Returns:

the model pages available in the given folder

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.getModelInfos(org.opencms.util.CmsUUID)

getNewElementInfo

public List<CmsNewResourceInfo> getNewElementInfo(String entryPointUri)
                                           throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Loads the model page data for the "add" menu.

Specified by:

getNewElementInfo in interface I_CmsSitemapService

Parameters:

entryPointUri - the entry point uri

Returns:

the list of resource info beans for the model pages

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.getNewElementInfo(java.lang.String)

getResourceLink

public String getResourceLink(CmsUUID baseId,
 String sitePath)
                       throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Fetches the link for a resource selected in the sitemap editor.

Specified by:

getResourceLink in interface I_CmsSitemapService

Parameters:

baseId - the structure id of the current sitemap root entry

sitePath - the site path of a resource

Returns:

the link to the resource

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.getResourceLink(org.opencms.util.CmsUUID, java.lang.String)

loadPropertyDataForLocaleCompareView

public CmsLocaleComparePropertyData loadPropertyDataForLocaleCompareView(CmsUUID id,
 CmsUUID rootId)
                                                                  throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Loads the data needed by the property editor in the locale comparison view.

Specified by:

loadPropertyDataForLocaleCompareView in interface I_CmsSitemapService

Parameters:

id - the id of the resource for which the property editor should be opened

rootId - the structure id of the resource which corresponds to the tree root in locale compare mode

Returns:

the property data for locale comparison mode

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.loadPropertyDataForLocaleCompareView(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)

mergeSubSitemap

public CmsSitemapChange mergeSubSitemap(String entryPoint,
 CmsUUID subSitemapId)
                                 throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Merges a sub-sitemap into it's parent sitemap.

Specified by:

mergeSubSitemap in interface I_CmsSitemapService

Parameters:

entryPoint - the sitemap entry point

subSitemapId - the structure id of the sub sitemap folder

Returns:

the result of the merge operation

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.mergeSubSitemap(java.lang.String, org.opencms.util.CmsUUID)

prefetch

public CmsSitemapData prefetch(String sitemapUri)
                        throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Returns the initialization data for the given sitemap.

Specified by:

prefetch in interface I_CmsSitemapService

Parameters:

sitemapUri - the site relative path

Returns:

the initialization data

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.prefetch(java.lang.String)

prepareReloadSitemap

public String prepareReloadSitemap(CmsUUID rootId,
 CmsSitemapData.EditorMode mode)
                            throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Prepares sitemap reloading for the given sitemap root.

This method may change the currently set site root. If the given root id is not in a valid site, null will be returned, otherwise the URL which the client should use to reload the sitemap will be returned.

Specified by:

prepareReloadSitemap in interface I_CmsSitemapService

Parameters:

rootId - the structure id of the new sitemap root

mode - the new editor mode

Returns:

the URL which should be used to reload the sitemap

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.prepareReloadSitemap(org.opencms.util.CmsUUID, org.opencms.ade.sitemap.shared.CmsSitemapData.EditorMode)

removeModelPage

public void removeModelPage(String entryPointUri,
 CmsUUID id)
                     throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Removes a model page from the current sitemap configuration.

Specified by:

removeModelPage in interface I_CmsSitemapService

Parameters:

entryPointUri - the base uri for the current sitemap

id - structure id of the model page to remove

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.removeModelPage(java.lang.String, org.opencms.util.CmsUUID)

save

public CmsSitemapChange save(String entryPoint,
 CmsSitemapChange change)
                      throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Saves the change to the given sitemap.

Specified by:

save in interface I_CmsSitemapService

Parameters:

entryPoint - the sitemap URI

change - the change to save

Returns:

the updated change

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.save(java.lang.String, org.opencms.ade.sitemap.shared.CmsSitemapChange)

saveAliases

public CmsAliasEditValidationReply saveAliases(CmsAliasSaveValidationRequest saveRequest)
                                        throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Saves the aliases for the bulk alias editor.

Specified by:

saveAliases in interface I_CmsSitemapService

Parameters:

saveRequest - the object containing the data to save

Returns:

the result of saving the aliases

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.saveAliases(org.opencms.gwt.shared.alias.CmsAliasSaveValidationRequest)

savePropertiesForLocaleCompareMode

public void savePropertiesForLocaleCompareMode(CmsUUID id,
 String newUrlName,
 List<CmsPropertyModification> propertyChanges,
 boolean editedName)
                                        throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Saves the changed properties in locale comparison mode.

Specified by:

savePropertiesForLocaleCompareMode in interface I_CmsSitemapService

Parameters:

id - the structure id

newUrlName - the new URL name

propertyChanges - the property changes

editedName - true if the name was edited

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.savePropertiesForLocaleCompareMode(org.opencms.util.CmsUUID, java.lang.String, java.util.List, boolean)

saveSitemapAttributes

public void saveSitemapAttributes(CmsUUID rootId,
 Map<String,String> attributes)
                           throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Saves the data from the sitemap attribute editor dialog to the sitemap configuration.

Specified by:

saveSitemapAttributes in interface I_CmsSitemapService

Parameters:

rootId - the root ID

attributes - the sitemap attributes

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.saveSitemapAttributes(org.opencms.util.CmsUUID, java.util.Map)

setDefaultModel

public CmsModelInfo setDefaultModel(CmsUUID rootId,
 CmsUUID modelId)
                             throws CmsRpcException

Description copied from interface: I_CmsSitemapService

Sets the default model page for the given sub-sitemap, returns the updated model info.

Specified by:

setDefaultModel in interface I_CmsSitemapService

Parameters:

rootId - structure id of the sub-sitemap root folder

modelId - the id of the model page to set as default

Returns:

the updated model info

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsSitemapService.setDefaultModel(org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)

setEditorMode

public void setEditorMode(CmsSitemapData.EditorMode editorMode)

Description copied from interface: I_CmsSitemapService

Sets the editor mode in the current user session.

Specified by:

setEditorMode in interface I_CmsSitemapService

Parameters:

editorMode - the editor mode to set

See Also:

• I_CmsSitemapService.setEditorMode(org.opencms.ade.sitemap.shared.CmsSitemapData.EditorMode)

updateAliasEditorStatus

public void updateAliasEditorStatus(boolean editing)

Description copied from interface: I_CmsSitemapService

Updates the alias editor status.

This is used to keep two users from editing the alias table for a site root concurrently.

Specified by:

updateAliasEditorStatus in interface I_CmsSitemapService

Parameters:

editing - true to indicate that the table is still being edited, false to indicate that the table isn't being edited anymore

See Also:

• I_CmsSitemapService.updateAliasEditorStatus(boolean)

validateAliases

public CmsAliasEditValidationReply validateAliases(CmsAliasEditValidationRequest validationRequest)

Description copied from interface: I_CmsSitemapService

Validates the aliases for the bulk alias editor.

Specified by:

validateAliases in interface I_CmsSitemapService

Parameters:

validationRequest - an object indicating the type of validation to perform

Returns:

the validation result

See Also:

• I_CmsSitemapService.validateAliases(org.opencms.gwt.shared.alias.CmsAliasEditValidationRequest)

validateRewriteAliases

public CmsRewriteAliasValidationReply validateRewriteAliases(CmsRewriteAliasValidationRequest validationRequest)

Description copied from interface: I_CmsSitemapService

Validates rewrite aliases.

Specified by:

validateRewriteAliases in interface I_CmsSitemapService

Parameters:

validationRequest - the rewrite alias data to validate

Returns:

the validation result

See Also:

• I_CmsSitemapService.validateRewriteAliases(org.opencms.gwt.shared.alias.CmsRewriteAliasValidationRequest)

ensureLockAndGetInfo

protected CmsVfsSitemapService.LockInfo ensureLockAndGetInfo(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.

Parameters:

resource - the resource to lock

Returns:

the assigned lock

Throws:

CmsException - if the resource could not be locked

saveInternal

protected CmsSitemapChange saveInternal(String entryPoint,
 CmsSitemapChange change)
                                 throws CmsException

Internal method for saving a sitemap.

Parameters:

entryPoint - the URI of the sitemap to save

change - the change to save

Returns:

list of changed sitemap entries

Throws:

CmsException - if something goes wrong