Package com.adobe.aem.modernize.structure

Interface StructureRewriteRuleService

All Superinterfaces:

RewriteRuleService

@ProviderType
public interface StructureRewriteRuleService
extends RewriteRuleService

Provides a mechanism for listing all the configured rules either via Nodes or custom implementations.

Method Summary

Modifier and Type	Method	Description
void	apply(@NotNull com.day.cq.wcm.api.Page page, @NotNull Set<String> rules)	Deprecated.
boolean	apply(@NotNull org.apache.sling.api.resource.Resource resource, @NotNull Set<String> rules)	Applies the indicated rules to the provided resource.

Methods inherited from interface com.adobe.aem.modernize.rule.RewriteRuleService

find, getRule, listRules, listRules

Method Detail

apply

@Deprecated(since="2.1.0")
void apply(@NotNull
           @NotNull com.day.cq.wcm.api.Page page,
           @NotNull
           @NotNull Set<String> rules)
    throws RewriteException

Deprecated.

Applies the indicated rules to the provided page.

Transformations are performed but not saved.

Parameters:

page - page to process

rules - the ids of the rules to apply

Throws:

RewriteException - if any errors occur while updating the page.

apply

boolean apply(@NotNull
              @NotNull org.apache.sling.api.resource.Resource resource,
              @NotNull
              @NotNull Set<String> rules)
       throws RewriteException

Applies the indicated rules to the provided resource.

Transformations are performed but not saved.

Parameters:

resource - resource of the page to process

rules - the ids of the rules to apply

Returns:

true if one of the specified rules was successfully applied, false otherwise

Throws:

RewriteException - if any errors occur while updating the page.