Package com.day.cq.mcm.api
Interface MCMPlugin
-
- All Known Implementing Classes:
MCMPluginAdapter
public interface MCMPlugin
Plugin to extend MCM withExperience
s andTouchpoint
s. Being registered in theAdapterFactory
of the MCM package during bundle installation.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Iterator<Resource>
findReferencedTouchpoints(ResourceResolver rr, 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.Collection<String>
getExperienceRootComponents()
String
getPluginId()
An id string for identification of the plugin - for example for the Javascript plugin part.Collection<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
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
Collection<String> getTouchpointRootComponents()
-
getExperienceRootComponents
Collection<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
Iterator<Resource> findReferencedTouchpoints(ResourceResolver rr, 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:
-
-