com.adobe.cq.wcm.ui.components.container.service

Interface AllowedComponents

public interface AllowedComponents

The service provides access to the allowed components of a given resource

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AllowedComponents.InstantiationDelegate<T> This functional interface allows you to instantiate and return an object of type T

Method Summary

Modifier and Type	Method and Description
java.util.List<Component>	getAllowedComponents(Resource resource) Returns the list of all the allowed components of a container.
<T> java.util.List<T>	getAllowedComponents(Resource resource, AllowedComponents.InstantiationDelegate<T> delegatedInstantiation) Returns a list of object of type T associated with each allowed component associated with the provided resource.

Method Detail

getAllowedComponents

java.util.List<Component> getAllowedComponents(Resource resource)

Returns the list of all the allowed components of a container. If none set, an empty List would be returned. The Components are selected based on container's policy and Components from ComponentManager.

Parameters:

resource - the resource for which to list allowed components

Returns:

the list of allowed components

Throws:

java.lang.IllegalStateException - if ComponentManager or ContentPolicyManager unavailable

getAllowedComponents

<T> java.util.List<T> getAllowedComponents(Resource resource,
                                           AllowedComponents.InstantiationDelegate<T> delegatedInstantiation)

Returns a list of object of type T associated with each allowed component associated with the provided resource. The list will be empty when the context of the resource doesn't allow accessing the allowed components. The Components are selected based on container's policy and Components from ComponentManager.

Parameters:

resource - the resource for which to list allowed components

delegatedInstantiation - lambda function that returns an instance of type T

Returns:

the list of allowed component resources

Throws:

java.lang.IllegalStateException - if ComponentManager or ContentPolicyManager unavailable