org.nuxeo.ecm.core.api

Class UnrestrictedSessionRunner

java.lang.Object

org.nuxeo.ecm.core.api.UnrestrictedSessionRunner

Direct Known Subclasses:

AbstractDashboardSpaceCreator, AddRightUnrestricted, CaseDistributionServiceImpl.SendPostUnrestricted, CaseManagementAbstractPersister.GetParentPathUnrestricted, CaseProcessedListener.RemoveWritePermissionUnrestricted, ChangePermissionUnrestricted, CommentActions.FollowTransitionUnrestricted, CreateCaseItemUnrestricted, CreateCaseUnrestricted, CreateDraftCaseLinkUnrestricted, CreateEmptyCaseUnrestricted, CreateMailboxFilingRootUnrestricted, CreateMailboxFilingRootUnrestricted, CreateMailboxRouteRootUnrestricted, CreateNewRouteInstanceUnrestricted, CreateTaskUnrestricted, DeleteDocumentUnrestricted, DistributionListener.SetEnvelopeAclUnrestricted, DocumentStoreSessionRunner, DomainsFinder, FollowTransitionUnrestricted, GetMailboxesUnrestricted, GetMailboxInformationUnrestricted, PublishActionsBean.ApproverWithoutRestriction, PublishUnrestricted, QueryRepositoryProbe.Runner, RemoveACLUnrestricted, RemoveRightsUnrestricted, RenditionPublicationFactory.RemoveACP, RenditionServiceImpl.RenditionCreator, ReportActions.UnrestrictedReportModelsContainerCreator, RootSectionsFinder, SearchMailboxesUnrestricted, SetMailboxAclUnrestricted, StatsTaskRunner, TaskMigrationRunner, TaskServiceImpl.GetTaskRootParentPathUnrestricted, UnrestrictedExporter, UpdateCaseLinkUnrestricted, UserDashboardSpaceProvider.DefaultDashboardSpaceCopy, ValidateDueCaseLinkUnrestricted

public abstract class UnrestrictedSessionRunner
extends Object

Helper class to run code with an unrestricted session.

The caller must implement the run() method, and call runUnrestricted().

Author:

Florent Guillaume

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isUnrestricted True if a call to runUnrestricted() is in progress.

Method Summary

Methods

Modifier and Type	Method and Description
String	getOriginatingUsername()
abstract void	run() This method will be called by runUnrestricted() with session available as an unrestricted session.
void	runUnrestricted() Calls the run() method with an unrestricted session.
void	setOriginatingUsername(String originatingUsername)

Methods inherited from class java.lang.Object

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

Field Detail

isUnrestricted

public boolean isUnrestricted

True if a call to runUnrestricted() is in progress.

Method Detail

getOriginatingUsername

public String getOriginatingUsername()

setOriginatingUsername

public void setOriginatingUsername(String originatingUsername)

runUnrestricted

public void runUnrestricted()
                     throws ClientException

Calls the run() method with an unrestricted session. During this call, isUnrestricted is set to true.

Throws:

ClientException

run

public abstract void run()
                  throws ClientException

This method will be called by runUnrestricted() with session available as an unrestricted session.

It can also be called directly in which case the session available will be the one passed to #UnrestrictedSessionRunner(CoreSession).

Throws:

ClientException