com.day.cq.mcm.core

Class NewsletterHelper

java.lang.Object

com.day.cq.mcm.core.NewsletterHelper

public class NewsletterHelper
extends java.lang.Object

Tool for UI to build, test and send Newsletters.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_NEWSLETTER Parameter Name for the Path to a newsletter
static java.lang.String	PARAM_RECIPIENTS Parameter Name for the MailingList the Newsletter should be sent to
static java.lang.String	PARAM_TEST_PROFILE Parameter Name for the an User-ID used to personlize a Newsletter for testing
static java.lang.String	PARAM_TEST_TO Parameter Name for the an User-ID used to send a Newsletter for testing

Constructor Summary

Constructors

Constructor and Description
NewsletterHelper()

Method Summary

Modifier and Type	Method and Description
static NewsLetter	fromRequest(SlingHttpServletRequest request, NewsletterEmailService service) Reads the request parameter and tries to build a Newsletter from.
static java.lang.String	getParameter(RequestParameterMap map, java.lang.String key) Utility to trim existing Parameter Values
static java.util.Collection<Resource>	getUnpublishedResources(NewsLetter letter, ResourceResolver resolver) Collect the Resources referenced by the Newsletter and the Newsletters Resource and check if they have been modified since last publish or if they are not published at all
static boolean	isPublishUptodate(NewsLetter letter, ResourceResolver resolver) Checks that no outdated resources, see getUnpublishedResources, are referenced by the NewsLetter and that the Newsletter is 'delivered' (see ReplicationStatus).

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_NEWSLETTER

public static final java.lang.String PARAM_NEWSLETTER

Parameter Name for the Path to a newsletter

See Also:

Constant Field Values

PARAM_RECIPIENTS

public static final java.lang.String PARAM_RECIPIENTS

Parameter Name for the MailingList the Newsletter should be sent to

See Also:

Constant Field Values

PARAM_TEST_TO

public static final java.lang.String PARAM_TEST_TO

Parameter Name for the an User-ID used to send a Newsletter for testing

See Also:

Constant Field Values

PARAM_TEST_PROFILE

public static final java.lang.String PARAM_TEST_PROFILE

Parameter Name for the an User-ID used to personlize a Newsletter for testing

See Also:

Constant Field Values

Constructor Detail

NewsletterHelper

public NewsletterHelper()

Method Detail

fromRequest

public static NewsLetter fromRequest(SlingHttpServletRequest request,
                                     NewsletterEmailService service)
                              throws RepositoryException

Reads the request parameter and tries to build a Newsletter from. A path and a Resource given by PARAM_NEWSLETTER, falls back to the Request's Resource Helper tries to access a Page if the Resource found is part of a Page Subject and from are set, if present in Request

Parameters:

request - to access parameter from

service - to build Newsletter with

Returns:

the letter or null if could not be build.

Throws:

RepositoryException - in case of error accessing the Repository

getUnpublishedResources

public static java.util.Collection<Resource> getUnpublishedResources(NewsLetter letter,
                                                                     ResourceResolver resolver)
                                                              throws RepositoryException

Collect the Resources referenced by the Newsletter and the Newsletters Resource and check if they have been modified since last publish or if they are not published at all

Parameters:

letter - to inspect

resolver - to use for access to the Resources

Returns:

all Resources that are outdated

Throws:

RepositoryException - in case of error accessing the Repository

isPublishUptodate

public static boolean isPublishUptodate(NewsLetter letter,
                                        ResourceResolver resolver)

Checks that no outdated resources, see getUnpublishedResources, are referenced by the NewsLetter and that the Newsletter is 'delivered' (see ReplicationStatus).

Parameters:

letter - to inspect

resolver - to use for access to the Resources

Returns:

true if no resources are outdated and letter is 'delivered'. Otherwise and in case of exception false.

Throws:

RepositoryException - in case of error accessing the Repository

getParameter

public static java.lang.String getParameter(RequestParameterMap map,
                                            java.lang.String key)

Utility to trim existing Parameter Values

Parameters:

map - to access

key - to return

Returns:

the trimmed value or null