com.adobe.aem.spa.project.core.internal.impl.utils

Class HierarchyUtils

java.lang.Object

com.adobe.aem.spa.project.core.internal.impl.utils.HierarchyUtils

public class HierarchyUtils
extends Object

Method Summary

Modifier and Type	Method and Description
static void	addEntryPointPage(org.apache.sling.api.SlingHttpServletRequest request, com.day.cq.wcm.api.Page currentPage, @NotNull List<com.day.cq.wcm.api.Page> descendedPages) Optionally adds a page that is the entry point of a site model request, even when was not added because of the root structure configuration
static org.apache.sling.api.SlingHttpServletRequest	createHierarchyServletRequest(@NotNull org.apache.sling.api.SlingHttpServletRequest request, com.day.cq.wcm.api.Page page, com.day.cq.wcm.api.Page entryPage) Creates a new request wrapping the request from the parameters.
protected static @Nullable Page	getDescendantModel(com.day.cq.wcm.api.Page childPage, org.apache.sling.api.SlingHttpServletRequest slingRequestWrapper, org.apache.sling.models.factory.ModelFactory modelFactory)
static @NotNull List<com.day.cq.wcm.api.Page>	getDescendants(com.day.cq.wcm.api.Page page, org.apache.sling.api.SlingHttpServletRequest slingRequest, List<Pattern> structurePatterns, int depth) Traverses the tree of descendants of the page.
static @NotNull Map<String,Page>	getDescendantsModels(org.apache.sling.api.SlingHttpServletRequest request, com.day.cq.wcm.api.Page currentPage, com.day.cq.wcm.api.designer.Style currentStyle, org.apache.sling.models.factory.ModelFactory modelFactory) Returns all descended page models of the currentPage plus the entryPoint page (even if was excluded based on rules enforced by filterPatterns or traversalDepth)
static com.day.cq.wcm.api.Page	getEntryPoint(@NotNull org.apache.sling.api.SlingHttpServletRequest request) Returns the request's entry point attribute value
static com.day.cq.wcm.api.Page	getRootPage(org.apache.sling.api.resource.Resource resource, com.day.cq.wcm.api.Page currentPage) Returns the root page which the current page is part of
static @NotNull List<Pattern>	getStructurePatterns(@NotNull org.apache.sling.api.SlingHttpServletRequest request, com.day.cq.wcm.api.designer.Style currentStyle) Returns the page structure patterns to filter the descendants to be exported.

Methods inherited from class java.lang.Object

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

Method Detail

createHierarchyServletRequest

public static org.apache.sling.api.SlingHttpServletRequest createHierarchyServletRequest(@NotNull
                                                                                         @NotNull org.apache.sling.api.SlingHttpServletRequest request,
                                                                                         @NotNull
                                                                                         com.day.cq.wcm.api.Page page,
                                                                                         @Nullable
                                                                                         com.day.cq.wcm.api.Page entryPage)

Creates a new request wrapping the request from the parameters.
The new request is created to set the

• componentcontext - includes the Page from the page parameter and the context from request
• currentPage - Page from page parameter
• entryPointPage - Page from entryPage parameter

attributes in order to ensure that the references to the page are accurate for the hierarchical structure.

Parameters:

request - Request to be wrapped

page - Page to be referenced as statically containing the current page content

entryPage - Page that is the entry point of the request

Returns:

A SlingHttpServletRequestWrapper containing the given page and request

getEntryPoint

public static com.day.cq.wcm.api.Page getEntryPoint(@NotNull
                                                    @NotNull org.apache.sling.api.SlingHttpServletRequest request)

Returns the request's entry point attribute value

Parameters:

request - Request to get the entry point attribute from

Returns:

Entry point attribute value

addEntryPointPage

public static void addEntryPointPage(org.apache.sling.api.SlingHttpServletRequest request,
                                     com.day.cq.wcm.api.Page currentPage,
                                     @NotNull
                                     @NotNull List<com.day.cq.wcm.api.Page> descendedPages)

Optionally adds a page that is the entry point of a site model request, even when was not added because of the root structure configuration

Parameters:

request - Request

currentPage - Current style

descendedPages - List of descendants

getStructurePatterns

@NotNull
public static @NotNull List<Pattern> getStructurePatterns(@NotNull
                                                                   @NotNull org.apache.sling.api.SlingHttpServletRequest request,
                                                                   com.day.cq.wcm.api.designer.Style currentStyle)

Returns the page structure patterns to filter the descendants to be exported. The patterns can either be stored on the template policy of the page or provided as a request parameter

Parameters:

request - Request

currentStyle - Current style

Returns:

List of page structure patterns

getRootPage

public static com.day.cq.wcm.api.Page getRootPage(org.apache.sling.api.resource.Resource resource,
                                                  com.day.cq.wcm.api.Page currentPage)

Returns the root page which the current page is part of

Parameters:

resource - Resource

currentPage - Current page

Returns:

Root page

getDescendants

@NotNull
public static @NotNull List<com.day.cq.wcm.api.Page> getDescendants(com.day.cq.wcm.api.Page page,
                                                                             org.apache.sling.api.SlingHttpServletRequest slingRequest,
                                                                             List<Pattern> structurePatterns,
                                                                             int depth)

Traverses the tree of descendants of the page. Descendants that…

• Are not deeper than the defined depth
• Have a path that matches one of defined structurePattern

…will be returned in a flat list

Parameters:

page - Page from which to extract descended pages

slingRequest - Request

structurePatterns - Patterns to filter descended pages

depth - Depth of the traversal

Returns:

Flat list of matching descendants

getDescendantModel

@Nullable
protected static @Nullable Page getDescendantModel(com.day.cq.wcm.api.Page childPage,
                                                             org.apache.sling.api.SlingHttpServletRequest slingRequestWrapper,
                                                             org.apache.sling.models.factory.ModelFactory modelFactory)

getDescendantsModels

@NotNull
public static @NotNull Map<String,Page> getDescendantsModels(org.apache.sling.api.SlingHttpServletRequest request,
                                                                      com.day.cq.wcm.api.Page currentPage,
                                                                      com.day.cq.wcm.api.designer.Style currentStyle,
                                                                      org.apache.sling.models.factory.ModelFactory modelFactory)

Returns all descended page models of the currentPage plus the entryPoint page (even if was excluded based on rules enforced by filterPatterns or traversalDepth)

Parameters:

request - Request

currentPage - Current page

currentStyle - Current style

modelFactory - Model factory

Returns:

Map containing the page models with their corresponding paths (as keys)