com.day.cq.analytics.testandtarget.util

Class MboxHelper

java.lang.Object

com.day.cq.analytics.testandtarget.util.MboxHelper

public class MboxHelper
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.List<java.lang.String>	getClientContextParameterNames(Resource resource, InheritanceValueMap pageProperties, ConfigurationManager configurationManager) Returns the names of the ClientContext parameters which should be sent as part of mbox calls
static java.lang.String	getCustomMboxJsPath(Resource resource, Page currentPage, ConfigurationManager cfgMgr) Returns the repository path to a custom mbox.js file for the current specified resource and currentPage
static java.lang.String	getMboxId(Resource rsrc) Generates an mbox ID.
static java.lang.String	getMboxId(java.lang.String path) Generates an mbox ID from a path
static java.lang.String	getMboxName(Resource rsrc) Returns a name for the Resource.
static java.util.Map<java.lang.String,java.lang.String>	getStaticParameters(Resource resource)
static boolean	isAccurateRendering(Resource resource) Returns true if the mbox represented by the resource has accurateTargeting enabled.
static java.lang.String	qualifyMboxNameOrId(java.lang.String mboxNameOrId, WCMMode wcmMode)
static Resource	searchStartElement(Resource resource) Search the start element for the current element type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMboxName

public static java.lang.String getMboxName(Resource rsrc)

Returns a name for the Resource. As name the jcr:title with removed whitespaces is used if available. If no jcr:title is specified, a name is generated by getMboxId(Resource).

Parameters:

rsrc -

Returns:

getMboxId

public static java.lang.String getMboxId(Resource rsrc)

Generates an mbox ID. The ID is generated by replacing slashes and removing jcr:content from the resource path of the start element. If the corresponding start element can not be found the provided element is used.

Parameters:

rsrc - Resource of start/end element

Returns:

qualifyMboxNameOrId

public static java.lang.String qualifyMboxNameOrId(java.lang.String mboxNameOrId,
                                   WCMMode wcmMode)

getMboxId

public static java.lang.String getMboxId(java.lang.String path)

Generates an mbox ID from a path

Parameters:

path - the path of the resource containing the mbox

Returns:

the mbox id

See Also:

getMboxId(Resource)

searchStartElement

public static Resource searchStartElement(Resource resource)

Search the start element for the current element type.

getCustomMboxJsPath

public static java.lang.String getCustomMboxJsPath(Resource resource,
                                   Page currentPage,
                                   ConfigurationManager cfgMgr)
                                            throws RepositoryException

Returns the repository path to a custom mbox.js file for the current specified resource and currentPage

Parameters:

resource -

currentPage -

cfgMgr -

Returns:

the path to the custom mbox.js file or null if the default one should be used

Throws:

RepositoryException

isAccurateRendering

public static boolean isAccurateRendering(Resource resource)
                                   throws RepositoryException

Returns true if the mbox represented by the resource has accurateTargeting enabled.

Parameters:

resource -

Returns:

true if the mbox represented by the resource has accurateTargeting enabled.

Throws:

RepositoryException

getClientContextParameterNames

public static java.util.List<java.lang.String> getClientContextParameterNames(Resource resource,
                                                              InheritanceValueMap pageProperties,
                                                              ConfigurationManager configurationManager)
                                                                       throws RepositoryException

Returns the names of the ClientContext parameters which should be sent as part of mbox calls

This method merges the directly defined parameter names with the parameters names inherited from a Test&Target framework.

Parameters:

resource - the target resource

configurationManager -

Returns:

a list of parameter names, never null

Throws:

RepositoryException

getStaticParameters

public static java.util.Map<java.lang.String,java.lang.String> getStaticParameters(Resource resource)
                                                                            throws java.lang.Exception

Throws:

java.lang.Exception