Package io.wcm.wcm.parsys.componentinfo

Interface AllowedComponentsProvider

  • @ProviderType
public interface AllowedComponentsProvider
    Detects allowed components for authoring for a given page/resource context.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @NotNull java.util.Set<java.lang.String> getAllowedComponents​(@NotNull com.day.cq.wcm.api.Page page, @NotNull java.lang.String relativeResourcePath, @Nullable java.lang.String resourceType, @NotNull org.apache.sling.api.resource.ResourceResolver resolver)
      Get allowed components for a specific resource path inside a page.
      @NotNull java.util.Set<java.lang.String> getAllowedComponents​(@NotNull java.lang.String resourcePath, @NotNull org.apache.sling.api.resource.ResourceResolver resolver)
      Get allowed components for a specific resource path inside a page.
      @NotNull java.util.Set<java.lang.String> getAllowedComponentsForTemplate​(@NotNull java.lang.String pageComponentPath, @NotNull org.apache.sling.api.resource.ResourceResolver resolver)
      Get allowed components anywhere inside a page.

    • Method Detail

      • getAllowedComponents

        @NotNull
@NotNull java.util.Set<java.lang.String> getAllowedComponents​(@NotNull
                                                              @NotNull java.lang.String resourcePath,
                                                              @NotNull
                                                              @NotNull org.apache.sling.api.resource.ResourceResolver resolver)
        Get allowed components for a specific resource path inside a page.
        Parameters:
        resourcePath - Resource path inside a page
        resolver - Resource resolver
        Returns:
        Component paths

      • getAllowedComponents

        @NotNull
@NotNull java.util.Set<java.lang.String> getAllowedComponents​(@NotNull
                                                              @NotNull com.day.cq.wcm.api.Page page,
                                                              @NotNull
                                                              @NotNull java.lang.String relativeResourcePath,
                                                              @Nullable
                                                              @Nullable java.lang.String resourceType,
                                                              @NotNull
                                                              @NotNull org.apache.sling.api.resource.ResourceResolver resolver)
        Get allowed components for a specific resource path inside a page.
        Parameters:
        page - Page
        relativeResourcePath - Relative resource path inside the page
        resourceType - Resource type of the paragraph system
        resolver - Resource resolver
        Returns:
        Component paths

      • getAllowedComponentsForTemplate

        @NotNull
@NotNull java.util.Set<java.lang.String> getAllowedComponentsForTemplate​(@NotNull
                                                                         @NotNull java.lang.String pageComponentPath,
                                                                         @NotNull
                                                                         @NotNull org.apache.sling.api.resource.ResourceResolver resolver)
        Get allowed components anywhere inside a page.
        Parameters:
        pageComponentPath - Page component path of page
        resolver - Resource resolver
        Returns:
        Component paths