org.ametys.cms.content.indexing.solr

Class SolrWorkflowIndexer

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.content.indexing.solr.SolrWorkflowIndexer

All Implemented Interfaces:

SolrFieldNames, LogEnabled, Component, Serviceable

public class SolrWorkflowIndexer
extends AbstractLogEnabled
implements Component, Serviceable, SolrFieldNames

Component indexing the whole workflow of AmetysObjects.

Field Summary

Fields

Modifier and Type	Field and Description
protected SolrClientProvider	_solrClientProvider The Solr client provider
protected WorkflowProvider	_workflowProvider The workflow provider.
static String	ROLE The component role.

Fields inherited from interface org.ametys.cms.content.indexing.solr.SolrFieldNames

ACL_READ_ALLOW_ANONYMOUS, ACL_READ_ALLOW_ANY_CONNECTED_USER, ACL_READ_ALLOWED_GROUPS, ACL_READ_ALLOWED_USERS, ACL_READ_DENIED_GROUPS, ACL_READ_DENIED_USERS, ALL_CONTENT_TYPES, ALL_MIXIN_TYPES, ALL_TAGS, CONTENT_COMMENTS, CONTENT_COMMENTS_NONVALIDATED, CONTENT_COMMENTS_VALIDATED, CONTENT_CREATOR, CONTENT_LANGUAGE, CONTENT_LANGUAGES, CONTENT_LAST_CONTRIBUTOR, CONTENT_NAME, CONTENT_TITLES, CONTENT_TYPE_RESOURCE, CONTENT_TYPES, CREATION_DATE, DATE_FOR_SORTING, DATES_FACET, DC_CONTRIBUTOR, DC_COVERAGE, DC_CREATOR, DC_DATE, DC_DESCRIPTION, DC_FORMAT, DC_IDENTIFIER, DC_LANGUAGE, DC_PUBLISHER, DC_RELATION, DC_RIGHTS, DC_SOURCE, DC_SUBJECT, DC_TITLE, DC_TYPE, DOCUMENT_TYPE, EXCERPT, FILENAME, FULL_EXACT_WS, FULL_GENERAL, FULL_PREFIX, FULL_STEMMED_PREFIX, ID, LAST_MAJOR_VALIDATION, LAST_MODIFIED, LAST_VALIDATION, LENGTH, MIME_TYPES, MIXIN_TYPES, PATH, REPEATER_ENTRY_POSITION, RESOURCE_CREATOR, RESOURCE_DATE, RESOURCE_LAST_MODIFIED, RESOURCE_ROOT_ID, SUB_CONTENT, TAGS, TITLE, TITLE_SORT, TYPE_CONTENT, TYPE_REPEATER, TYPE_RESOURCE, TYPE_WF_ENTRY, TYPE_WF_STEP, WORKFLOW_CURRENT_STEPS, WORKFLOW_CURRENT_STEPS_DV, WORKFLOW_ENTRY_STATE, WORKFLOW_HISTORY_STEPS, WORKFLOW_HISTORY_STEPS_DV, WORKFLOW_NAME, WORKFLOW_REF, WORKFLOW_REF_DV, WORKFLOW_STEP, WORKFLOW_STEP_ACTIONID, WORKFLOW_STEP_CALLER, WORKFLOW_STEP_DUEDATE, WORKFLOW_STEP_FINISHDATE, WORKFLOW_STEP_ID, WORKFLOW_STEP_OWNER, WORKFLOW_STEP_STARTDATE, WORKFLOW_STEP_STATUS

Constructor Summary

Constructors

Constructor and Description
SolrWorkflowIndexer()

Method Summary

Modifier and Type	Method and Description
void	indexAmetysObjectWorkflow(WorkflowAwareAmetysObject object, String workspaceName) Index the workflow history of an Ametys object.
void	indexAmetysObjectWorkflow(WorkflowAwareAmetysObject object, String workspaceName, boolean commit) Index the workflow history of an Ametys object.
private String	indexStep(com.opensymphony.workflow.spi.Step step, String objectId, List<SolrInputDocument> documents)
private List<String>	indexSteps(List<com.opensymphony.workflow.spi.Step> steps, String objectId, List<SolrInputDocument> documents)
private void	indexWorkflowEntry(WorkflowProvider.AmetysObjectWorkflow workflow, long workflowId, String objectId, List<String> historyStepIds, List<String> currentStepIds, List<SolrInputDocument> documents)
void	service(ServiceManager serviceManager)
void	unindexAmetysObjectWorkflow(String objectId, String workspaceName) Unindex the workflow history of an Ametys object.
void	unindexAmetysObjectWorkflow(String objectId, String workspaceName, boolean commit) Unindex the workflow history of an Ametys object.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

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 component role.

_solrClientProvider

protected SolrClientProvider _solrClientProvider

The Solr client provider

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider.

Constructor Detail

SolrWorkflowIndexer

public SolrWorkflowIndexer()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

indexAmetysObjectWorkflow

public void indexAmetysObjectWorkflow(WorkflowAwareAmetysObject object,
                                      String workspaceName)
                               throws SolrServerException,
                                      IOException

Index the workflow history of an Ametys object.

Parameters:

object - The ametys object.

workspaceName - The workspace where to work in

Throws:

SolrServerException - If a solr error occurs.

IOException - If an I/O error occurs while indexing.

indexAmetysObjectWorkflow

public void indexAmetysObjectWorkflow(WorkflowAwareAmetysObject object,
                                      String workspaceName,
                                      boolean commit)
                               throws SolrServerException,
                                      IOException

Index the workflow history of an Ametys object.

Parameters:

object - The ametys object.

workspaceName - The workspace where to work in

commit - Whether to perform a commit after the indexation or not.

Throws:

SolrServerException - If a solr error occurs.

IOException - If an I/O error occurs while indexing.

indexWorkflowEntry

private void indexWorkflowEntry(WorkflowProvider.AmetysObjectWorkflow workflow,
                                long workflowId,
                                String objectId,
                                List<String> historyStepIds,
                                List<String> currentStepIds,
                                List<SolrInputDocument> documents)

indexSteps

private List<String> indexSteps(List<com.opensymphony.workflow.spi.Step> steps,
                                String objectId,
                                List<SolrInputDocument> documents)

indexStep

private String indexStep(com.opensymphony.workflow.spi.Step step,
                         String objectId,
                         List<SolrInputDocument> documents)

unindexAmetysObjectWorkflow

public void unindexAmetysObjectWorkflow(String objectId,
                                        String workspaceName)
                                 throws SolrServerException,
                                        IOException

Unindex the workflow history of an Ametys object.

Parameters:

objectId - The Ametys object ID.

workspaceName - The workspace where to work in

Throws:

SolrServerException - If a solr error occurs.

IOException - If an I/O error occurs while indexing.

unindexAmetysObjectWorkflow

public void unindexAmetysObjectWorkflow(String objectId,
                                        String workspaceName,
                                        boolean commit)
                                 throws SolrServerException,
                                        IOException

Unindex the workflow history of an Ametys object.

Parameters:

objectId - The Ametys object ID.

workspaceName - The workspace where to work in

commit - Whether to perform a commit after the deletion or not.

Throws:

SolrServerException - If a solr error occurs.

IOException - If an I/O error occurs while indexing.