Package com.day.cq.analytics.sitecatalyst

Interface AnalyticsPageNameProvider

@ConsumerType
public interface AnalyticsPageNameProvider

Interface to be implemented by clients who want to provide their own logic for generating s.pageName for Analytics or retrieving Resources from custom pageName's. Registered AnalyticsPageNameProvider will be called based on their Constants.SERVICE_RANKING. If one implementation can provide a value, then this value will be taken and remaining providers are not called anymore.

Method Summary

Modifier and Type	Method	Description
String	getPageName(AnalyticsPageNameContext context)	Called when pageName for a resource is requested.
Resource	getResource(AnalyticsPageNameContext context)	Called when the Resource for a given pageName is requested.

Method Details

getPageName

String getPageName(AnalyticsPageNameContext context)

Called when pageName for a resource is requested.

Parameters:

context - the resolution AnalyticsPageNameContext

Returns:

null or the generated pageName

getResource

Resource getResource(AnalyticsPageNameContext context)

Called when the Resource for a given pageName is requested.

Parameters:

context - the resolution AnalyticsPageNameContext

Returns:

null or the resource that matches the pageName provided via context