org.ametys.web.workflow

Class WorkflowTasksComponent

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.workflow.WorkflowTasksComponent

org.ametys.web.workflow.WorkflowTasksComponent

All Implemented Interfaces:

Component, Configurable, Contextualizable, LogEnabled, Serviceable, ThreadSafe

public class WorkflowTasksComponent
extends WorkflowTasksComponent
implements Contextualizable

Component for saxing tasks specific to an user.
The algorithm is the following :

• First, we get all granted sites for the user with the right manager.
• If there is at least one site allowed, we get all workflows associated with the granted sites.
• Then for each step of each task from the configuration, we get all workflows where this step is in current steps and where the workflow is contains in the previous list.
• For each workflow matching the previous conditions we test if the user has all the rights associated with the step (from the configuration) and then we get the content from this workflow.
• Finally, for each content, we sax its first page in order to access it directly from an URL.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.cms.workflow.WorkflowTasksComponent

WorkflowTasksComponent.LastModifiedDateComparator, WorkflowTasksComponent.Task, WorkflowTasksComponent.TaskStep

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	_context The avalon context.
protected ContentTypesAssignmentHandler	_cTypeHandler The content types assignment handler
protected SiteManager	_siteManager The site manager.
static String	ROLE The avalon role.

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

_allowUserQuery, _contentHelper, _contentTypesHelper, _cTypeEP, _languagesManager, _objectResolver, _rightManager, _tasks, _userManager, _workflowProvider

Constructor Summary

Constructors

Constructor and Description
WorkflowTasksComponent()

Method Summary

Modifier and Type	Method and Description
protected AmetysObjectIterable<Content>	_getContents(WorkflowTasksComponent.TaskStep step, User user) Get the contents for a step.
protected Expression	_getContentTypeExpression(String siteName) The content type expression
protected void	_saxAdditionalAttributes(Content content, AttributesImpl attrs) SAX additional attributes
void	contextualize(Context context)
Collection<Content>	getContents(User user, String taskId, String siteName, String language, int limit) Get the list of contents for a given user, task and site.
void	service(ServiceManager serviceManager)
void	toSAX(ContentHandler ch, User user) SAX the contents for given user
void	toSAX(ContentHandler ch, User user, String taskId) SAX the contents for given user and task
void	toSAX(ContentHandler ch, User user, String siteName, String language, String taskId) SAX the contents for given user, site and task

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

_configureStepIds, _configureTasks, _getCorrespondingWorkflows, _getTaskContents, _getTaskContents, _saxAdditionalAttributes, _saxContent, _saxContentCurrentState, _saxTask, _testContent, allowUserQuery, configure, getContents, getTasks

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The avalon role.

_siteManager

protected SiteManager _siteManager

The site manager.

_context

protected Context _context

The avalon context.

_cTypeHandler

protected ContentTypesAssignmentHandler _cTypeHandler

The content types assignment handler

Constructor Detail

WorkflowTasksComponent

public WorkflowTasksComponent()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class WorkflowTasksComponent

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

toSAX

public void toSAX(ContentHandler ch,
                  User user)
           throws SAXException

Description copied from class: WorkflowTasksComponent

SAX the contents for given user

Overrides:

toSAX in class WorkflowTasksComponent

Parameters:

ch - the content handler to SAX into

user - the user

Throws:

SAXException - If an error occurred

toSAX

public void toSAX(ContentHandler ch,
                  User user,
                  String taskId)
           throws SAXException

Description copied from class: WorkflowTasksComponent

SAX the contents for given user and task

Overrides:

toSAX in class WorkflowTasksComponent

Parameters:

ch - the content handler to SAX into

user - the user

taskId - the task id

Throws:

SAXException - If an error occurred

toSAX

public void toSAX(ContentHandler ch,
                  User user,
                  String siteName,
                  String language,
                  String taskId)
           throws SAXException

SAX the contents for given user, site and task

Parameters:

ch - the content handler to SAX into

user - the user

siteName - the site name

language - the language.

taskId - the task id

Throws:

SAXException - if an error occurred while saxing

getContents

public Collection<Content> getContents(User user,
                                       String taskId,
                                       String siteName,
                                       String language,
                                       int limit)
                                throws AmetysRepositoryException

Get the list of contents for a given user, task and site.

Parameters:

user - the user.

taskId - the task ID.

siteName - the site name.

language - the language.

limit - the maximum number of results, 0 for all.

Returns:

the contents as an iterable collection of contents.

Throws:

AmetysRepositoryException - if an error occurred

_getContents

protected AmetysObjectIterable<Content> _getContents(WorkflowTasksComponent.TaskStep step,
                                                     User user)

Description copied from class: WorkflowTasksComponent

Get the contents for a step.

Overrides:

_getContents in class WorkflowTasksComponent

Parameters:

step - the step.

user - the user.

Returns:

an iterable collection of contents.

_getContentTypeExpression

protected Expression _getContentTypeExpression(String siteName)

The content type expression

Parameters:

siteName - the site name

Returns:

The content type expression

_saxAdditionalAttributes

protected void _saxAdditionalAttributes(Content content,
                                        AttributesImpl attrs)
                                 throws SAXException

Description copied from class: WorkflowTasksComponent

SAX additional attributes

Overrides:

_saxAdditionalAttributes in class WorkflowTasksComponent

Parameters:

content - the content

attrs - the attributes

Throws:

SAXException - If an error occurred