org.ametys.cms.workflow.archive

Class ArchiveContentsEngine

java.lang.Object

org.ametys.cms.workflow.archive.ArchiveContentsEngine

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

ArchiveContentsEngine

public class ArchiveContentsEngine
extends Object
implements Runnable

Runnable engine that archive the contents that have an scheduled archiving date set before the current date.

Field Summary

Fields

Modifier and Type	Field and Description
protected AmetysObjectResolver	_ametysResolver The ametys object resolver.
protected Set<String>	_archiveRights The user e-mail notification will be sent to users that have this at least one of this rights.
protected String	_baseUrl The server base URL.
protected Context	_context The avalon context.
protected Context	_environmentContext The cocoon environment context.
protected I18nUtils	_i18nUtils The i18n utils.
protected boolean	_initialized Is the engine initialized ?
protected Logger	_logger The logger.
protected String	_mailFrom The content of "from" field in emails.
protected ServiceManager	_manager The service manager.
protected RightManager	_rightManager The rights manager
protected SourceResolver	_sourceResolver The avalon source resolver.
protected String	_sysadminMail The sysadmin mail address, to which will be sent the report e-mail.
protected String	_userErrorMailBody The user notification error mail body i18n key.
protected String	_userErrorMailSubject The user notification error mail subject i18n key.
protected String	_userMailBody The user notification mail body i18n key.
protected String	_userMailSubject The user notification mail subject i18n key.
protected UserManager	_userManager The users manager.

Constructor Summary

Constructors

Constructor and Description
ArchiveContentsEngine()

Method Summary

Modifier and Type	Method and Description
protected Set<UserIdentity>	_getAuthorizedContributors(Content content) Get the authorized contributors to receive mail notification
protected String	_getContentsListAsString(List<Content> contents) Get the contents list as String
protected String	_getRequestURI(Content content) Get the request URI to set in mail
protected void	_sendMailsToUsers(String subject, String body, Set<UserIdentity> users, String from) Send the emails to users (contributors)
protected void	archiveContents(Request request) Get the contents that need to be archived, and archive them.
protected void	checkInitialization() Check the initialization and throw an exception if not initialized.
void	configure(Configuration configuration) Configure the engine (called by the scheduler).
protected void	dispose() Dispose of the resources and looked-up components.
protected List<String>	getAdminEmailParams(List<Content> archivedContents, List<Content> contentsWithError) Get the report e-mail parameters.
protected String	getArchiveActionUri(String contentId) Get the pipeline uri for the archive action
protected List<String>	getBodyParamsForContributors(Content content, boolean archived) Get email body parameters
void	initialize(ServiceManager manager, Context context) Initialize the archive engine.
void	run()
protected void	sendErrorMailToContributors(Content content, Set<UserIdentity> users) Send the mail to alert users that an error has occurred while trying to archive the content.
protected void	sendMailToAdministrator(List<Content> archivedContents, List<Content> contentsWithError) Send the archive report e-mail.
protected void	sendMailToContributors(Content content, Set<UserIdentity> users) Send the mail to alert users that the content has been archived.
protected void	setRequestAttributes(Request request, Content content) Set the necessary request attributes

Methods inherited from class java.lang.Object

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

Field Detail

_logger

protected Logger _logger

The logger.

_context

protected Context _context

The avalon context.

_manager

protected ServiceManager _manager

The service manager.

_baseUrl

protected String _baseUrl

The server base URL.

_initialized

protected boolean _initialized

Is the engine initialized ?

_environmentContext

protected Context _environmentContext

The cocoon environment context.

_ametysResolver

protected AmetysObjectResolver _ametysResolver

The ametys object resolver.

_sourceResolver

protected SourceResolver _sourceResolver

The avalon source resolver.

_rightManager

protected RightManager _rightManager

The rights manager

_userManager

protected UserManager _userManager

The users manager.

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils.

_mailFrom

protected String _mailFrom

The content of "from" field in emails.

_sysadminMail

protected String _sysadminMail

The sysadmin mail address, to which will be sent the report e-mail.

_archiveRights

protected Set<String> _archiveRights

The user e-mail notification will be sent to users that have this at least one of this rights.

_userMailBody

protected String _userMailBody

The user notification mail body i18n key.

_userMailSubject

protected String _userMailSubject

The user notification mail subject i18n key.

_userErrorMailBody

protected String _userErrorMailBody

The user notification error mail body i18n key.

_userErrorMailSubject

protected String _userErrorMailSubject

The user notification error mail subject i18n key.

Constructor Detail

ArchiveContentsEngine

public ArchiveContentsEngine()

Method Detail

initialize

public void initialize(ServiceManager manager,
                       Context context)
                throws ContextException,
                       ServiceException

Initialize the archive engine.

Parameters:

manager - the avalon service manager.

context - the avalon context.

Throws:

ContextException - If an error occurred

ServiceException - If an error occurred

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Configure the engine (called by the scheduler).

Parameters:

configuration - the component configuration.

Throws:

ConfigurationException - If an error occurred

checkInitialization

protected void checkInitialization()

Check the initialization and throw an exception if not initialized.

run

public void run()

Specified by:

run in interface Runnable

dispose

protected void dispose()

Dispose of the resources and looked-up components.

archiveContents

protected void archiveContents(Request request)
                        throws AmetysRepositoryException,
                               MalformedURLException,
                               IOException

Get the contents that need to be archived, and archive them.

Parameters:

request - The current request object

Throws:

AmetysRepositoryException - if an error occurs.

IOException - If an error occurred

MalformedURLException - If an error occurred

setRequestAttributes

protected void setRequestAttributes(Request request,
                                    Content content)

Set the necessary request attributes

Parameters:

request - The request

content - The content

getArchiveActionUri

protected String getArchiveActionUri(String contentId)

Get the pipeline uri for the archive action

Parameters:

contentId - the current contend id

Returns:

a pipeline uri

sendMailToAdministrator

protected void sendMailToAdministrator(List<Content> archivedContents,
                                       List<Content> contentsWithError)

Send the archive report e-mail.

Parameters:

archivedContents - The list of archived contents

contentsWithError - The list of contents with error

getAdminEmailParams

protected List<String> getAdminEmailParams(List<Content> archivedContents,
                                           List<Content> contentsWithError)

Get the report e-mail parameters.

Parameters:

archivedContents - The list of archived contents

contentsWithError - The list of contents with error

Returns:

the e-mail parameters.

_getContentsListAsString

protected String _getContentsListAsString(List<Content> contents)

Get the contents list as String

Parameters:

contents - The contents

Returns:

the list of contents as String

_getAuthorizedContributors

protected Set<UserIdentity> _getAuthorizedContributors(Content content)

Get the authorized contributors to receive mail notification

Parameters:

content - The content to be archived

Returns:

The user logins

sendMailToContributors

protected void sendMailToContributors(Content content,
                                      Set<UserIdentity> users)

Send the mail to alert users that the content has been archived.

Parameters:

content - The archived content

users - The users

getBodyParamsForContributors

protected List<String> getBodyParamsForContributors(Content content,
                                                    boolean archived)

Get email body parameters

Parameters:

content - the archived content

archived - true if the content has archived

Returns:

The mail parameters

sendErrorMailToContributors

protected void sendErrorMailToContributors(Content content,
                                           Set<UserIdentity> users)

Send the mail to alert users that an error has occurred while trying to archive the content.

Parameters:

content - The content

users - The users

_getRequestURI

protected String _getRequestURI(Content content)

Get the request URI to set in mail

Parameters:

content - The content. Can be null

Returns:

the request URI

_sendMailsToUsers

protected void _sendMailsToUsers(String subject,
                                 String body,
                                 Set<UserIdentity> users,
                                 String from)

Send the emails to users (contributors)

Parameters:

subject - the e-mail subject.

body - the e-mail body.

users - users to send the mail to.

from - the address sending the e-mail.