Package com.day.cq.wcm.api.policies

Interface ContentPolicyManager

public interface ContentPolicyManager

Content Policy Manager API.

Method Summary

Modifier and Type	Method	Description
ContentPolicy	copyPolicy(ContentPolicy originalPolicy, java.lang.String newTitle, java.lang.String newDescription)
java.util.List<ContentPolicy>	getPolicies(java.lang.String path)	Returns the list of policies for the given path
java.util.List<ContentPolicy>	getPolicies(java.lang.String path, java.lang.String policyResourceType)	Returns the list of policies for the given path.
ContentPolicy	getPolicy(ComponentContext componentContext)	Get the ContentPolicy for the given ComponentContext.
ContentPolicy	getPolicy(Resource contentResource)	Get the ContentPolicy for the given Resource.
ContentPolicy	getPolicy(Resource contentResource, SlingHttpServletRequest request)	Get the ContentPolicy for the given Resource.
java.lang.String	getPolicyLocation(Resource resource)	Returns the policy location for the given resource Policies are located following their respective component path location under the settings/wcm/policies directory The returned string is an absolute path to the directory that should contain policies for the given resource This function only returns a path if the given resource is contained in a page making use of the editable template If this requirement is not meet the returned string is null
ContentPolicyMapping	getPolicyMapping(Resource resource)
java.util.List<ContentPolicyMapping>	getPolicyMappings(ContentPolicy contentPolicy)
java.util.List<Template>	getTemplates(java.lang.String policyAbsolutePath)	Get the templates a policy is used in
java.util.List<Template>	getTemplates(java.lang.String policyAbsolutePath, Predicate filter)	Get a filtered list of templates a policy is used in

Method Detail

getPolicy

@Nullable
ContentPolicy getPolicy(@Nonnull
                        ComponentContext componentContext)

Get the ContentPolicy for the given ComponentContext.

Parameters:

componentContext - The mandatory component context to get the content policy for.

Returns:

The content policy for the given component context or null if none is configured.

Throws:

java.lang.IllegalArgumentException - This exception is thrown, if the given component context is null.

getPolicy

@Nullable
ContentPolicy getPolicy(@Nonnull
                        Resource contentResource)

Get the ContentPolicy for the given Resource.

Parameters:

contentResource - The mandatory resource to get the content policy for.

Returns:

The content policy for the given resource or null if none is configured.

Throws:

java.lang.IllegalArgumentException - This exception is thrown, if the given resource is null.

getPolicy

@Nullable
ContentPolicy getPolicy(@Nonnull
                        Resource contentResource,
                        @Nullable
                        SlingHttpServletRequest request)

Get the ContentPolicy for the given Resource.

Parameters:

contentResource - The mandatory resource to get the content policy for.

request - Request from which to read specific attributes and parameters. Allows to resolve delegated policy resources

Returns:

The content policy for the given resource or null if none is configured.

Throws:

java.lang.IllegalArgumentException - This exception is thrown, if the given resource is null.

getPolicies

java.util.List<ContentPolicy> getPolicies(java.lang.String path)

Returns the list of policies for the given path

Parameters:

path - Path from where to start searching for policies

Returns:

getPolicies

java.util.List<ContentPolicy> getPolicies(java.lang.String path,
                                          java.lang.String policyResourceType)

Returns the list of policies for the given path. Here you can limit search to the given policy resource type Policy Resource Types are relative {ResourceResolver}

Parameters:

path - Path from where to start searching for policies

policyResourceType - Sling resource type associated with the policies

Returns:

copyPolicy

ContentPolicy copyPolicy(ContentPolicy originalPolicy,
                         java.lang.String newTitle,
                         java.lang.String newDescription)

Parameters:

originalPolicy -

newTitle -

newDescription -

Returns:

getPolicyMapping

ContentPolicyMapping getPolicyMapping(Resource resource)

Parameters:

resource -

Returns:

getPolicyMappings

java.util.List<ContentPolicyMapping> getPolicyMappings(ContentPolicy contentPolicy)

Parameters:

contentPolicy -

Returns:

getPolicyLocation

java.lang.String getPolicyLocation(Resource resource)

Returns the policy location for the given resource Policies are located following their respective component path location under the settings/wcm/policies directory The returned string is an absolute path to the directory that should contain policies for the given resource This function only returns a path if the given resource is contained in a page making use of the editable template If this requirement is not meet the returned string is null

Parameters:

resource - Resource contained in a page making use of an editable template

Returns:

The path to the directory that contains the policies for the given resource

getTemplates

java.util.List<Template> getTemplates(java.lang.String policyAbsolutePath)

Get the templates a policy is used in

Parameters:

policyAbsolutePath - absolute path to policy

Returns:

list of templates where the policy is used in

getTemplates

java.util.List<Template> getTemplates(java.lang.String policyAbsolutePath,
                                      Predicate filter)

Get a filtered list of templates a policy is used in

Parameters:

policyAbsolutePath - absolute path to policy

filter - for the templates

Returns:

list of templates where the policy is used in