Package com.adobe.acs.commons.wcm.properties.shared

Interface SharedComponentProperties

@ProviderType
public interface SharedComponentProperties

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SharedComponentProperties.ValueTypes

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GLOBAL_PROPERTIES
static final String	GLOBAL_PROPERTIES_RESOURCE
static final String	MERGED_PROPERTIES
static final String	MERGED_PROPERTIES_PATH	Bindings key for the resource path evaluated for merged properties
static final String	NN_GLOBAL_COMPONENT_PROPERTIES
static final String	NN_SHARED_COMPONENT_PROPERTIES
static final String	SHARED_PROPERTIES
static final String	SHARED_PROPERTIES_PAGE_PATH	Bindings key for the root page path containing the shared and global properties resources
static final String	SHARED_PROPERTIES_PATH	Bindings key for the resource path evaluated for shared properties
static final String	SHARED_PROPERTIES_RESOURCE

Method Summary

Modifier and Type	Method	Description
org.apache.sling.api.resource.ValueMap	getGlobalProperties(org.apache.sling.api.resource.Resource resource)	Get the global properties of the current resource, or an empty map.
String	getGlobalPropertiesPath(org.apache.sling.api.resource.Resource resource)	Construct an absolute resource path for retrieval of a global component properties value map.
org.apache.sling.api.resource.ValueMap	getSharedProperties(org.apache.sling.api.resource.Resource resource)	Get the shared component properties of the current resource, or an empty map.
String	getSharedPropertiesPagePath(org.apache.sling.api.resource.Resource resource)	Construct an absolute root page path containing the shared and global properties resources appropriate for the given component resource.
String	getSharedPropertiesPath(org.apache.sling.api.resource.Resource resource)	Construct an absolute resource path for retrieval of a shared component properties value map.
org.apache.sling.api.resource.ValueMap	mergeProperties(org.apache.sling.api.resource.ValueMap globalProperties, org.apache.sling.api.resource.ValueMap sharedProperties, org.apache.sling.api.resource.Resource resource)	Merge global and shared properties into the valuemap retrieved from the provided resource.

Field Details

SHARED_PROPERTIES_PAGE_PATH

static final String SHARED_PROPERTIES_PAGE_PATH

Bindings key for the root page path containing the shared and global properties resources

See Also:

• Constant Field Values

SHARED_PROPERTIES_PATH

static final String SHARED_PROPERTIES_PATH

Bindings key for the resource path evaluated for shared properties

See Also:

• Constant Field Values

MERGED_PROPERTIES_PATH

static final String MERGED_PROPERTIES_PATH

Bindings key for the resource path evaluated for merged properties

See Also:

• Constant Field Values

SHARED_PROPERTIES

static final String SHARED_PROPERTIES

See Also:

• Constant Field Values

GLOBAL_PROPERTIES

static final String GLOBAL_PROPERTIES

See Also:

• Constant Field Values

MERGED_PROPERTIES

static final String MERGED_PROPERTIES

See Also:

• Constant Field Values

SHARED_PROPERTIES_RESOURCE

static final String SHARED_PROPERTIES_RESOURCE

See Also:

• Constant Field Values

GLOBAL_PROPERTIES_RESOURCE

static final String GLOBAL_PROPERTIES_RESOURCE

See Also:

• Constant Field Values

NN_GLOBAL_COMPONENT_PROPERTIES

static final String NN_GLOBAL_COMPONENT_PROPERTIES

See Also:

• Constant Field Values

NN_SHARED_COMPONENT_PROPERTIES

static final String NN_SHARED_COMPONENT_PROPERTIES

See Also:

• Constant Field Values

Method Details

getSharedPropertiesPagePath

String getSharedPropertiesPagePath(org.apache.sling.api.resource.Resource resource)

Construct an absolute root page path containing the shared and global properties resources appropriate for the given component resource.

Parameters:

resource - the component resource to evaluate

Returns:

an absolute path to a parent resource for shared and global properties

getGlobalPropertiesPath

String getGlobalPropertiesPath(org.apache.sling.api.resource.Resource resource)

Construct an absolute resource path for retrieval of a global component properties value map.

Parameters:

resource - the resource to evaluate

Returns:

an absolute path to a possible global component properties resource or null

getGlobalProperties

org.apache.sling.api.resource.ValueMap getGlobalProperties(org.apache.sling.api.resource.Resource resource)

Get the global properties of the current resource, or an empty map.

Parameters:

resource - the current resource

Returns:

global properties or empty

getSharedPropertiesPath

String getSharedPropertiesPath(org.apache.sling.api.resource.Resource resource)

Construct an absolute resource path for retrieval of a shared component properties value map.

Parameters:

resource - the resource to evaluate

Returns:

an absolute path to a possible shared component properties resource or null

getSharedProperties

org.apache.sling.api.resource.ValueMap getSharedProperties(org.apache.sling.api.resource.Resource resource)

Get the shared component properties of the current resource, or an empty map.

Parameters:

resource - the current resource

Returns:

shared component properties or empty

mergeProperties

org.apache.sling.api.resource.ValueMap mergeProperties(org.apache.sling.api.resource.ValueMap globalProperties,
 org.apache.sling.api.resource.ValueMap sharedProperties,
 org.apache.sling.api.resource.Resource resource)

Merge global and shared properties into the valuemap retrieved from the provided resource.

Parameters:

globalProperties - global properties or null

sharedProperties - shared component properties or null

resource - the component resource

Returns:

merged properties