org.nuxeo.ecm.platform.groups.audit.service.acl.job

Class AclAuditWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.platform.groups.audit.service.acl.job.AclAuditWork

All Implemented Interfaces:

Serializable, Work

public class AclAuditWork
extends AbstractWork

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
static int	DEFAULT_TIMEOUT
protected String	name
protected File	out
static String	PROPERTY_ACL_AUDIT_TIMEOUT
protected IResultPublisher	publisher
protected int	timeout
static int	UNDEFINED_TIMEOUT

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

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

Constructor Summary

Constructors

Constructor and Description
AclAuditWork(String name, String repositoryName, String rootId, File out, IResultPublisher publisher) Initialize a runnable Acl Audit process, and register this process in the Work instance that will execute it.
AclAuditWork(String name, String repositoryName, String rootId, File out, IResultPublisher publisher, int timeout) Initialize a runnable Acl Audit process, and register this process in the Work instance that will execute it.

Method Summary

Modifier and Type	Method and Description
void	doAudit()
static int	getAclAuditTimeoutFromProperties()
File	getOutputFile()
String	getTitle() Gets a human-readable name for this work instance.
void	onAuditDone()
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, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getStartTime, getState, getStatus, getUserId, getWorkInstanceResult, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, run, runWorkWithTransaction, runWorkWithTransactionAndCheckExceptions, setCompletionTime, setDocument, setDocument, setDocuments, 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

PROPERTY_ACL_AUDIT_TIMEOUT

public static final String PROPERTY_ACL_AUDIT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

UNDEFINED_TIMEOUT

public static final int UNDEFINED_TIMEOUT

See Also:

Constant Field Values

name

protected String name

timeout

protected int timeout

publisher

protected IResultPublisher publisher

out

protected File out

Constructor Detail

AclAuditWork

public AclAuditWork(String name,
                    String repositoryName,
                    String rootId,
                    File out,
                    IResultPublisher publisher)

Initialize a runnable Acl Audit process, and register this process in the Work instance that will execute it.

AclAuditWork

public AclAuditWork(String name,
                    String repositoryName,
                    String rootId,
                    File out,
                    IResultPublisher publisher,
                    int timeout)

Initialize a runnable Acl Audit process, and register this process in the Work instance that will execute it.

Method Detail

getAclAuditTimeoutFromProperties

public static int getAclAuditTimeoutFromProperties()

getTitle

public String getTitle()

Description copied from interface: Work

Gets a human-readable name for this work instance.

Returns:

a human-readable name

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)

doAudit

public void doAudit()

onAuditDone

public void onAuditDone()

getOutputFile

public File getOutputFile()