com.day.cq.mcm.api

Interface MCMPlugin

All Known Implementing Classes:

MCMPluginAdapter

public interface MCMPlugin

Plugin to extend MCM with Experiences and Touchpoints. Being registered in the AdapterFactory of the MCM package during bundle installation.

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<Resource>	findReferencedTouchpoints(ResourceResolver rr, java.lang.String pathOrCampaignPath) Finds the touchpoints referenced underneath the given path and/or the touchpoints that might display experience of the given campaign if the path is a campaign.
java.util.Collection<java.lang.String>	getExperienceRootComponents()
java.lang.String	getPluginId() An id string for identification of the plugin - for example for the Javascript plugin part.
java.util.Collection<java.lang.String>	getTouchpointRootComponents()
Experience	makeExperience(Resource adaptable) Should try it's best to make an experience out of the adaptable.
Touchpoint	makeTouchpoint(Resource adaptable) Should try it's best to make an experience out of the adaptable.

Method Detail

getPluginId

java.lang.String getPluginId()

An id string for identification of the plugin - for example for the Javascript plugin part. Should refer to only one plugin.

Returns:

for example twitter

getTouchpointRootComponents

java.util.Collection<java.lang.String> getTouchpointRootComponents()

getExperienceRootComponents

java.util.Collection<java.lang.String> getExperienceRootComponents()

makeExperience

Experience makeExperience(Resource adaptable)

Should try it's best to make an experience out of the adaptable. Should not check for the component type, because component types might be subtyped and AdapterFactory can be configured to deal with that by setting up indirection via setting up a configuration: com.day.cq.mcm.impl.MCMConfiguration-exampleconfig with a property setting of:

Parameters:

adaptable -

Returns:

makeTouchpoint

Touchpoint makeTouchpoint(Resource adaptable)

Should try it's best to make an experience out of the adaptable. Should not check for the component type, because component types might be subtyped and AdapterFactory can be configured to deal with that by setting up indirection via configuration of a

Parameters:

adaptable -

Returns:

findReferencedTouchpoints

java.util.Iterator<Resource> findReferencedTouchpoints(ResourceResolver rr,
                                                       java.lang.String pathOrCampaignPath)

Finds the touchpoints referenced underneath the given path and/or the touchpoints that might display experience of the given campaign if the path is a campaign.

Parameters:

pathOrCampaignPath -

Returns: