Package org.ametys.plugins.newsletter.workflow

Class CreateNewsletterFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.CreateContentFunction

org.ametys.web.workflow.CreateContentFunction

org.ametys.plugins.newsletter.workflow.CreateNewsletterFunction

All Implemented Interfaces:

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

public class CreateNewsletterFunction
extends CreateContentFunction
implements Initializable, Contextualizable

OSWorkflow function for creating a content.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	CreateNewsletterFunction.IgnoreRootTagHandler	Ignore the root tag.
protected class	CreateNewsletterFunction.LocalImageHandler	Local image handler: injects attributes so that the image will be properly handled.
protected class	CreateNewsletterFunction.NewsletterFilter	Automatic newsletter filter.

Field Summary

Fields

Modifier and Type	Field	Description
private CategoryProviderExtensionPoint	_categoryProviderEP
protected Context	_context	The Avalon context
private ContentTypeExtensionPoint	_cTypeExtPt
protected static String	_DEFAULT_LEVEL	The defaut content insertion level.
protected static Set<String>	_IGNORE_ATTRS	The list of attributes to ignore.
private SAXParserFactory	_saxParserFactory
private SourceResolver	_sourceResolver
private TransformerFactory	_transformerFactory
private Properties	_transformerProperties
static String	NEWSLETTER_CATEGORY_KEY	Newsletter category key.
static String	NEWSLETTER_CONTENT_ID_MAP_KEY	Key for content ID map when processing auto sections.
static DateFormat	NEWSLETTER_DATE_FORMAT	The date format.
static String	NEWSLETTER_DATE_KEY	Newsletter date key.
static String	NEWSLETTER_IS_AUTOMATIC_KEY	Newsletter automatic property key.
static String	NEWSLETTER_NUMBER_KEY	Newsletter number key.
static String	NEWSLETTER_PROCESS_AUTO_SECTIONS_KEY	Key for "process auto sections".

Fields inherited from class org.ametys.web.workflow.CreateContentFunction

_currentUserProvider, _siteManager, PAGE_KEY, PAGE_ZONE_KEY, SITE_KEY

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

_contentTypeEP, _contentTypeHelper, _observationManager, _resolver, CONTENT_LANGUAGE_KEY, CONTENT_MIXINS_KEY, CONTENT_NAME_KEY, CONTENT_TITLE_KEY, CONTENT_TITLE_VARIANTS_KEY, CONTENT_TYPES_KEY, PARENT_CONTENT_ID_KEY, PARENT_CONTENT_METADATA_PATH_KEY

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

_contentHelper, 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	Description
CreateNewsletterFunction()

Method Summary

Modifier and Type	Method	Description
private String	_getContent(String skinId, String templateId)
private void	_initContentRichText(ModifiableContent content, String skinId, String categoryID, boolean processAutoSections, Map<String,AutomaticNewsletterFilterResult> filterResults)
protected void	_populateContent(Map transientVars, ModifiableContent content)	Populate the content.
private String	_processAutoTags(String text, boolean processAutoSections, Map<String,AutomaticNewsletterFilterResult> filterResults, String contentId)
void	contextualize(Context context)
void	initialize()
void	service(ServiceManager manager)

Methods inherited from class org.ametys.web.workflow.CreateContentFunction

_createContent, _getContentRoot, _notifyContentAdded, _populateAdditionalData

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

_eventParamsForContentAdded, _getNonNullVar, _getObjectType, _getSubContentRoot, _initWorkflow, _isMultilingual, _setTitle, execute, getSystemUser

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

NEWSLETTER_CATEGORY_KEY

public static final String NEWSLETTER_CATEGORY_KEY

Newsletter category key.

NEWSLETTER_NUMBER_KEY

public static final String NEWSLETTER_NUMBER_KEY

Newsletter number key.

NEWSLETTER_DATE_KEY

public static final String NEWSLETTER_DATE_KEY

Newsletter date key.

NEWSLETTER_IS_AUTOMATIC_KEY

public static final String NEWSLETTER_IS_AUTOMATIC_KEY

Newsletter automatic property key.

NEWSLETTER_PROCESS_AUTO_SECTIONS_KEY

public static final String NEWSLETTER_PROCESS_AUTO_SECTIONS_KEY

Key for "process auto sections".

NEWSLETTER_CONTENT_ID_MAP_KEY

public static final String NEWSLETTER_CONTENT_ID_MAP_KEY

Key for content ID map when processing auto sections.

NEWSLETTER_DATE_FORMAT

public static final DateFormat NEWSLETTER_DATE_FORMAT

The date format.

_IGNORE_ATTRS

protected static final Set<String> _IGNORE_ATTRS

The list of attributes to ignore.

_DEFAULT_LEVEL

protected static final String _DEFAULT_LEVEL

The defaut content insertion level.

See Also:

Constant Field Values

_context

protected Context _context

The Avalon context

_sourceResolver

private SourceResolver _sourceResolver

_cTypeExtPt

private ContentTypeExtensionPoint _cTypeExtPt

_categoryProviderEP

private CategoryProviderExtensionPoint _categoryProviderEP

_transformerFactory

private TransformerFactory _transformerFactory

_transformerProperties

private Properties _transformerProperties

_saxParserFactory

private SAXParserFactory _saxParserFactory

Constructor Detail

CreateNewsletterFunction

public CreateNewsletterFunction()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class CreateContentFunction

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

_populateContent

protected void _populateContent(Map transientVars,
                                ModifiableContent content)
                         throws com.opensymphony.workflow.WorkflowException

Description copied from class: CreateContentFunction

Populate the content.

Overrides:

_populateContent in class CreateContentFunction

Parameters:

transientVars - the transient variables.

content - the content.

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs.

_initContentRichText

private void _initContentRichText(ModifiableContent content,
                                  String skinId,
                                  String categoryID,
                                  boolean processAutoSections,
                                  Map<String,AutomaticNewsletterFilterResult> filterResults)
                           throws com.opensymphony.workflow.WorkflowException

Throws:

com.opensymphony.workflow.WorkflowException

_processAutoTags

private String _processAutoTags(String text,
                                boolean processAutoSections,
                                Map<String,AutomaticNewsletterFilterResult> filterResults,
                                String contentId)
                         throws com.opensymphony.workflow.WorkflowException

Throws:

com.opensymphony.workflow.WorkflowException

_getContent

private String _getContent(String skinId,
                           String templateId)
                    throws IOException,
                           com.opensymphony.workflow.WorkflowException

Throws:

IOException

com.opensymphony.workflow.WorkflowException