Package org.opencms.ade.sitemap
Class CmsAliasBulkEditHelper
- java.lang.Object
-
- org.opencms.ade.sitemap.CmsAliasBulkEditHelper
-
public class CmsAliasBulkEditHelper extends java.lang.Object
Helper class used by a service to edit or import aliases for a whole site.
-
-
Constructor Summary
Constructors Constructor Description CmsAliasBulkEditHelper(CmsObject cms)
Creates a new helper object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.util.Set<CmsAlias>
filterStructureId(java.util.Set<CmsAlias> aliases, java.util.Set<CmsUUID> structureIds)
Filters all aliases from a set whose structure id is in a given set of structure ids.void
importAliases(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Imports uploaded aliases from a request.CmsAliasEditValidationReply
saveAliases(CmsAliasSaveValidationRequest saveRequest)
Saves alias changes to the database.CmsAliasEditValidationReply
validateAliases(CmsAliasEditValidationRequest validationRequest)
Validates the alias data.
-
-
-
Constructor Detail
-
CmsAliasBulkEditHelper
public CmsAliasBulkEditHelper(CmsObject cms)
Creates a new helper object.- Parameters:
cms
- the current CMS context
-
-
Method Detail
-
importAliases
public void importAliases(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
Imports uploaded aliases from a request.- Parameters:
request
- the request containing the uploaded aliasesresponse
- the response- Throws:
java.lang.Exception
- if something goes wrong
-
saveAliases
public CmsAliasEditValidationReply saveAliases(CmsAliasSaveValidationRequest saveRequest) throws CmsException
Saves alias changes to the database.- Parameters:
saveRequest
- an object containing the alias changes to save- Returns:
- a validation error if the alias data is invalid, or null otherwise
- Throws:
CmsException
- if something goes wrong
-
validateAliases
public CmsAliasEditValidationReply validateAliases(CmsAliasEditValidationRequest validationRequest)
Validates the alias data.- Parameters:
validationRequest
- an object containing the alias data to validate- Returns:
- the validation result
-
filterStructureId
protected java.util.Set<CmsAlias> filterStructureId(java.util.Set<CmsAlias> aliases, java.util.Set<CmsUUID> structureIds)
Filters all aliases from a set whose structure id is in a given set of structure ids.- Parameters:
aliases
- the aliases to filterstructureIds
- the structure ids for which we want the aliases- Returns:
- the filtered structure ids
-
-