org.nuxeo.ecm.user.center.profile

Class UserProfileImporterWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.user.center.profile.UserProfileImporterWork

All Implemented Interfaces:

Serializable, Work

@Experimental(comment="https://jira.nuxeo.com/browse/NXP-12200")
public class UserProfileImporterWork
extends AbstractWork

Since:

7.2

Author:

Tiry

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.work.api.Work

Work.Progress, Work.State

Field Summary

Fields

Modifier and Type	Field and Description
protected UserProfileImporter	importer

Fields inherited from class org.nuxeo.ecm.core.work.AbstractWork

callerThread, completionTime, docId, docIds, id, isTree, loginContext, originatingUsername, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
UserProfileImporterWork()

Method Summary

Modifier and Type	Method and Description
Work.Progress	getProgress() Gets a progress report for this work instance.
String	getTitle() Gets a human-readable name for this work instance.
void	work() This method should implement the actual work done by the Work instance.

Methods inherited from class org.nuxeo.ecm.core.work.AbstractWork

cleanUp, closeSession, commitOrRollbackTransaction, equals, getCategory, getCompletionTime, getDocument, getDocuments, getId, getOriginatingUsername, getRetryCount, getSchedulePath, getSchedulingTime, getStartTime, getState, getStatus, getWorkInstanceResult, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, openSystemSession, openUserSession, run, runWorkWithTransaction, runWorkWithTransactionAndCheckExceptions, setCompletionTime, setDocument, setDocument, setDocuments, setOriginatingUsername, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

importer

protected transient UserProfileImporter importer

Constructor Detail

UserProfileImporterWork

public UserProfileImporterWork()

Method Detail

getTitle

public String getTitle()

Description copied from interface: Work

Gets a human-readable name for this work instance.

Returns:

a human-readable name

getProgress

public Work.Progress getProgress()

Description copied from interface: Work

Gets a progress report for this work instance.

Specified by:

getProgress in interface Work

Overrides:

getProgress in class AbstractWork

Returns:

a progress report, not null

work

public void work()

Description copied from interface: Work

This method should implement the actual work done by the Work instance.

It should periodically update its progress through Work.setProgress(org.nuxeo.ecm.core.work.api.Work.Progress).

To allow for suspension by the WorkManager, it should periodically call Work.isSuspending(), and if true call Work.suspended() return early with saved state data.

Clean up can by implemented by #cleanUp().

Specified by:

work in interface Work

Specified by:

work in class AbstractWork

See Also:

Work.isSuspending(), Work.suspended(), Work.cleanUp(boolean, java.lang.Exception)