Package org.opencms.ade.sitemap

Class CmsAliasBulkEditHelper

java.lang.Object

org.opencms.ade.sitemap.CmsAliasBulkEditHelper

public class CmsAliasBulkEditHelper
extends 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

Modifier and Type	Method	Description
protected Set<CmsAlias>	filterStructureId(Set<CmsAlias> aliases, 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.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsAliasBulkEditHelper

public CmsAliasBulkEditHelper(CmsObject cms)

Creates a new helper object.

Parameters:

cms - the current CMS context

Method Details

importAliases

public void importAliases(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
                   throws Exception

Imports uploaded aliases from a request.

Parameters:

request - the request containing the uploaded aliases

response - the response

Throws:

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 Set<CmsAlias> filterStructureId(Set<CmsAlias> aliases,
 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 filter

structureIds - the structure ids for which we want the aliases

Returns:

the filtered structure ids