org.ametys.plugins.newsletter.workflow

Class SendNewsletterFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.plugins.newsletter.workflow.SendNewsletterFunction

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider, Contextualizable, LogEnabled, Serviceable

public class SendNewsletterFunction
extends AbstractContentWorkflowComponent
implements com.opensymphony.workflow.FunctionProvider, Contextualizable

OSWorkflow function for creating a content.

Field Summary

Fields

Modifier and Type	Field and Description
private CategoryProviderExtensionPoint	_categoryProviderEP
private Context	_context
private RenderingContextHandler	_renderingContextHandler
private SiteConfigurationExtensionPoint	_siteConfiguration
private SourceResolver	_sourceResolver
private SubscribersDAO	_subscribersDAO

Fields inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent

CONTENT_KEY

Fields inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

_logger, _manager, CONTEXT_PARAMETERS_KEY, FAIL_CONDITIONS_KEY, RESULT_MAP_KEY, WORKFLOW_ERRORS_KEY, WORKFLOW_WARNS_KEY

Constructor Summary

Constructors

Constructor and Description
SendNewsletterFunction()

Method Summary

Modifier and Type	Method and Description
protected String	_getBodyAsHtml(DefaultWebContent content) Get the newsletter HTML body
protected String	_getBodyAsText(DefaultWebContent content) Get the newsletter text body
protected Category	_getCategory(String categoryID) Get a category
protected CategoryProvider	_getProvider(String categoryID) Get the category provider
protected Request	_getRequest() Retrieve the request from which this component is called.
protected String	_getSubject(DefaultWebContent content) Get the newsletter mail subject
protected List<Subscriber>	_getSubscribersOfChildCategories(String categoryID, String siteName) Get the subscribers of child categories
protected List<Subscriber>	_getSubscribersOfParentCategories(String categoryID, String siteName) Get the subscribers of parent categories
void	contextualize(Context context)
void	execute(Map transientVars, Map args, com.opensymphony.module.propertyset.PropertySet ps)
void	service(ServiceManager manager)

Methods inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent

getContent

Methods inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

addWorkflowError, addWorkflowWarning, enableLogging, getConditionFailures, getContextParameters, getResultsMap, getUser

Methods inherited from class java.lang.Object

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

Field Detail

_sourceResolver

private SourceResolver _sourceResolver

_subscribersDAO

private SubscribersDAO _subscribersDAO

_categoryProviderEP

private CategoryProviderExtensionPoint _categoryProviderEP

_siteConfiguration

private SiteConfigurationExtensionPoint _siteConfiguration

_renderingContextHandler

private RenderingContextHandler _renderingContextHandler

_context

private Context _context

Constructor Detail

SendNewsletterFunction

public SendNewsletterFunction()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkflowComponent

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

execute

public void execute(Map transientVars,
                    Map args,
                    com.opensymphony.module.propertyset.PropertySet ps)
             throws com.opensymphony.workflow.WorkflowException

Specified by:

execute in interface com.opensymphony.workflow.FunctionProvider

Throws:

com.opensymphony.workflow.WorkflowException

_getSubscribersOfParentCategories

protected List<Subscriber> _getSubscribersOfParentCategories(String categoryID,
                                                             String siteName)

Get the subscribers of parent categories

Parameters:

categoryID - The category id

siteName - The site name

Returns:

the subscribers of parent categories

_getSubscribersOfChildCategories

protected List<Subscriber> _getSubscribersOfChildCategories(String categoryID,
                                                            String siteName)

Get the subscribers of child categories

Parameters:

categoryID - The category id

siteName - The site name

Returns:

The subscribers of child categories

_getSubject

protected String _getSubject(DefaultWebContent content)

Get the newsletter mail subject

Parameters:

content - The content

Returns:

The subject

_getBodyAsHtml

protected String _getBodyAsHtml(DefaultWebContent content)
                         throws IOException

Get the newsletter HTML body

Parameters:

content - The content

Returns:

The body

Throws:

IOException - if an I/O error occurred

_getRequest

protected Request _getRequest()

Retrieve the request from which this component is called.

Returns:

the request

_getBodyAsText

protected String _getBodyAsText(DefaultWebContent content)
                         throws IOException

Get the newsletter text body

Parameters:

content - The content

Returns:

The body

Throws:

IOException - if an I/O error occurred

_getCategory

protected Category _getCategory(String categoryID)

Get a category

Parameters:

categoryID - The category id

Returns:

The category

_getProvider

protected CategoryProvider _getProvider(String categoryID)

Get the category provider

Parameters:

categoryID - The category id

Returns:

The category