Package com.e1c.g5.v8.dt.internal.snapshot

Class WorkspaceOrchestratorMock

java.lang.Object

com.e1c.g5.v8.dt.internal.snapshot.WorkspaceOrchestratorMock

All Implemented Interfaces:

IWorkspaceOrchestrator, IManagedService

public class WorkspaceOrchestratorMock
extends Object
implements IWorkspaceOrchestrator

Mock implementation of IWorkspaceOrchestrator.

Constructor Summary

Constructors

Constructor	Description
WorkspaceOrchestratorMock(IDtProjectManager dtProjectManager)	Creates a new WorkspaceOrchestratorMock.

Method Summary

Modifier and Type	Method	Description
void	activate()
void	addListener(IWorkspaceOrchestratorListener listener)	Adds the specified listener.
Object	beginBackgroundOperation(String name, Collection<IDtProject> projects, ProjectPipelineJob afterJob)	Shortcut for the IWorkspaceOrchestrator.enqueueBackgroundOperation(String, Collection, ProjectPipelineJob) followed by waiting until the IWorkspaceOrchestrator.tryStartOperation(Object) is succeed.
Object	beginExclusiveOperation(String name, Collection<IDtProject> projects, ProjectPipelineJob afterJob)	Shortcut for the IWorkspaceOrchestrator.enqueueExclusiveOperation(String, Collection, ProjectPipelineJob) followed by waiting until the IWorkspaceOrchestrator.tryStartOperation(Object) is succeed.
Object	beginHalfExclusiveOperation(String name, Collection<IDtProject> projects, ProjectPipelineJob afterJob)	Shortcut for the IWorkspaceOrchestrator.enqueueHalfExclusiveOperation(String, Collection, ProjectPipelineJob) followed by waiting until the IWorkspaceOrchestrator.tryStartOperation(Object) is succeed.
Object	beginModalOperation(String name, Collection<IDtProject> projects, ProjectPipelineJob afterJob, IModalOperationController modalOperationController)	Shortcut for the #enqueueModalOperation(String, Collection, ProjectPipelineJob) followed by waiting until the IWorkspaceOrchestrator.tryStartOperation(Object) is succeed.
void	cancelOperation(Object handle)	Cancels the operation associated with the specified handle.
void	cleanRestartProject(IDtProject project)	Cleans and restarts the specified project.
void	cleanRestartProjects(Collection<IDtProject> projects)	Cleans and restarts the specified project's.
void	deactivate()
void	endOperation(Object handle)	Ends the operation associated with the specified handle.
Object	enqueueBackgroundOperation(String name, Collection<IDtProject> projects, ProjectPipelineJob afterJob)	Enqueues background operation.
Object	enqueueExclusiveOperation(String name, Collection<IDtProject> projects, ProjectPipelineJob afterJob)	Enqueues the exclusive operation.
Object	enqueueHalfExclusiveOperation(String name, Collection<IDtProject> projects, ProjectPipelineJob afterJob)	Enqueues half exclusive operation.
Object	enqueueHalfExclusiveOperation(String name, Collection<IDtProject> projects, ProjectPipelineJob afterJob, boolean implicitDerivedDataWait)	Enqueues half exclusive operation with optional implicit wait cancelling
Object	enqueueModalOperation(String name, Collection<IDtProject> projects, ProjectPipelineJob afterJob, IModalOperationController modalOperationController)	Enqueues the modal operation.
boolean	isShuttingDown()	Checks if the IWorkspaceOrchestrator is being shut down at the momemnt.
boolean	isStarted(IDtProject project)	Checks whether the specified project is started or not.
boolean	isStarted(org.eclipse.core.resources.IProject project)	Checks whether the specified project is started or not.
void	jobCancelled(IDtProject project, ProjectPipelineJob job)	Notifies orchestrator that the job is cancelled.
void	jobComplete(IDtProject project, ProjectPipelineJob job)	Notifies orchestrator that the job is complete.
void	jobInterrupted(IDtProject project, ProjectPipelineJob job)	Notifies orchestrator that the job is interrupted.
void	removeListener(IWorkspaceOrchestratorListener listener)	Removes the specified listener.
boolean	requestJob(IDtProject project, ProjectPipelineJob job)	Requests execution project pipeline job.
void	setOperationsEnabled(boolean enabled)	Sets whether workspace operations shall be approved.
IDtProject	startProject(String projectType, String projectName, Collection<String> projectNatures, org.eclipse.core.resources.IProject workspaceProject, Object extraData, ProjectStartType startType, Map<String,Object> customProperties, org.eclipse.core.runtime.IProgressMonitor progressMonitor)	Starts the specified project.
IDtProject	startProject(String projectType, String projectName, Collection<String> projectNatures, org.eclipse.core.resources.IProject workspaceProject, Object extraData, ProjectStartType startType, org.eclipse.core.runtime.IProgressMonitor progressMonitor)	Starts the specified project.
void	startWorkspaceProjects(Collection<WorkspaceProjectStartRequest> startRequests, org.eclipse.core.runtime.IProgressMonitor monitor)	Starts the specified project contexts.
void	stopProject(IDtProject project, ProjectStopType stopType)	Stops the specified project.
void	stopWorkspaceProjects(Collection<WorkspaceProjectStopRequest> stopRequests, org.eclipse.core.runtime.IProgressMonitor monitor)	Stops the specified project contexts.
boolean	tryStartOperation(Object handle)	Tries to start operation associated with the specified handle object.
void	waitUntilStarted(IDtProject project, Duration duration)	Wait until the specified project is started.
void	waitUntilStarted(org.eclipse.core.resources.IProject project, Duration duration)	Wait until the specified project is started.
void	waitUntilStopped(IDtProject project, Duration duration)	Wait until the specified project is stopped.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkspaceOrchestratorMock

public WorkspaceOrchestratorMock(IDtProjectManager dtProjectManager)

Creates a new WorkspaceOrchestratorMock.

Parameters:

dtProjectManager - the DT project manager, cannot be null

Method Details

activate

public void activate()

Specified by:

activate in interface IManagedService

deactivate

public void deactivate()

Specified by:

deactivate in interface IManagedService

startProject

public IDtProject startProject(String projectType,
 String projectName,
 Collection<String> projectNatures,
 org.eclipse.core.resources.IProject workspaceProject,
 Object extraData,
 ProjectStartType startType,
 org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Description copied from interface: IWorkspaceOrchestrator

Starts the specified project.

Note: this method is a shortcut for IWorkspaceOrchestrator.startProject(String, String, Collection, IProject, Object, ProjectStartType, Map, IProgressMonitor) with an empty map as the customProperties argument.

Specified by:

startProject in interface IWorkspaceOrchestrator

Parameters:

projectType - the project type, cannot be null.

projectName - the project name, cannot be null.

projectNatures - the project natures, cannot be null.

workspaceProject - the corresponding workspace project, can be null.

extraData - extra data, can be null.

startType - the start type, cannot be null.

progressMonitor - the progress monitor, cannot be null.

See Also:

• #startProject(IDtProject, ProjectStartType, Map)

startProject

public IDtProject startProject(String projectType,
 String projectName,
 Collection<String> projectNatures,
 org.eclipse.core.resources.IProject workspaceProject,
 Object extraData,
 ProjectStartType startType,
 Map<String,Object> customProperties,
 org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Description copied from interface: IWorkspaceOrchestrator

Starts the specified project.

It performs the next sequence of actions:

1. (Optional) Shedules build if the startType is clean-import
2. Collects dependent projects for the specified one
3. Stops the collected projects with an appropriate stop type
4. Starts the specified project
5. Starts the dependent projects with an appropriate start type

If the project is already started it does nothing.

Specified by:

startProject in interface IWorkspaceOrchestrator

Parameters:

projectType - the project type, cannot be null.

projectName - the project name, cannot be null.

projectNatures - the project natures, cannot be null.

workspaceProject - the corresponding workspace project, can be null.

extraData - extra data, can be null.

startType - the start type, cannot be null.

customProperties - the custom properties map is a map where keys are unique properties and values its values. This properties are accesable by lifecycle services within the start process.

progressMonitor - the progress monitor, cannot be null.

stopProject

public void stopProject(IDtProject project,
 ProjectStopType stopType)

Description copied from interface: IWorkspaceOrchestrator

Stops the specified project.

It performs the next sequence of actions:

1. Collects dependent projects for the specified one
2. Stops the collected projects with an appropriate stop type
3. Stops the specified project
4. Starts again the dependent projects with an appropriate start type

If the project is already stopped it does nothing.

Specified by:

stopProject in interface IWorkspaceOrchestrator

Parameters:

project - the project to stop, cannot be null.

stopType - the stop type, cannot be null.

startWorkspaceProjects

public void startWorkspaceProjects(Collection<WorkspaceProjectStartRequest> startRequests,
 org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IWorkspaceOrchestrator

Starts the specified project contexts.

It performs the next sequence of actions:

1. Collects dependent projects for each project of the specified contexts
2. Stops the collected projects with an appropriate stop type
3. Starts the specified project contexts
4. Starts the dependent projects with an appropriate start type

If the project is already started it does nothing.

Specified by:

startWorkspaceProjects in interface IWorkspaceOrchestrator

Parameters:

startRequests - the start requests, cannot be null.

monitor - the progress monitor, can be null. If it's null the NullProgressMonitor will be used.

stopWorkspaceProjects

public void stopWorkspaceProjects(Collection<WorkspaceProjectStopRequest> stopRequests,
 org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IWorkspaceOrchestrator

Stops the specified project contexts.

It performs the next sequence of actions:

1. Collects dependent projects for each project of the specified contexts
2. Stops the collected projects with an appropriate stop type
3. Stops the specified project contexts
4. Starts again the dependent projects with an appropriate start type

If the project is already started it does nothing.

Specified by:

stopWorkspaceProjects in interface IWorkspaceOrchestrator

Parameters:

stopRequests - the stop requests, cannot be null.

monitor - the progress monitor, can be null. If it's null the NullProgressMonitor will be used.

isStarted

public boolean isStarted(IDtProject project)

Description copied from interface: IWorkspaceOrchestrator

Checks whether the specified project is started or not.

Specified by:

isStarted in interface IWorkspaceOrchestrator

Parameters:

project - the project to check, cannot be null.

Returns:

true if the project is started, false - otherwise.

isStarted

public boolean isStarted(org.eclipse.core.resources.IProject project)

Description copied from interface: IWorkspaceOrchestrator

Checks whether the specified project is started or not.

Specified by:

isStarted in interface IWorkspaceOrchestrator

Parameters:

project - the project to check, cannot be null.

Returns:

true if the project is started, false - otherwise.

waitUntilStopped

public void waitUntilStopped(IDtProject project,
 Duration duration)

Description copied from interface: IWorkspaceOrchestrator

Wait until the specified project is stopped.

Specified by:

waitUntilStopped in interface IWorkspaceOrchestrator

Parameters:

project - the project to wait for stop, cannot be null.

duration - the duration to wait, cannot be null.

waitUntilStarted

public void waitUntilStarted(IDtProject project,
 Duration duration)

Description copied from interface: IWorkspaceOrchestrator

Wait until the specified project is started.

Specified by:

waitUntilStarted in interface IWorkspaceOrchestrator

Parameters:

project - the project to wait for start, cannot be null.

duration - the duration to wait, cannot be null.

waitUntilStarted

public void waitUntilStarted(org.eclipse.core.resources.IProject project,
 Duration duration)

Description copied from interface: IWorkspaceOrchestrator

Wait until the specified project is started.

Specified by:

waitUntilStarted in interface IWorkspaceOrchestrator

Parameters:

project - the project to wait for start, cannot be null.

duration - the duration to wait, cannot be null.

enqueueExclusiveOperation

public Object enqueueExclusiveOperation(String name,
 Collection<IDtProject> projects,
 ProjectPipelineJob afterJob)

Description copied from interface: IWorkspaceOrchestrator

Enqueues the exclusive operation.

Specified by:

enqueueExclusiveOperation in interface IWorkspaceOrchestrator

Parameters:

name - the operation name, cannot be null.

projects - the projects the operation affects, cannot be null.

afterJob - the stage the operation executed after, cannot be null.

Returns:

the operation handle, never null.

enqueueHalfExclusiveOperation

public Object enqueueHalfExclusiveOperation(String name,
 Collection<IDtProject> projects,
 ProjectPipelineJob afterJob)

Description copied from interface: IWorkspaceOrchestrator

Enqueues half exclusive operation.

Specified by:

enqueueHalfExclusiveOperation in interface IWorkspaceOrchestrator

Parameters:

name - the operation name, cannot be null.

projects - the projects the operation affects, cannot be null.

afterJob - the stage the operation executed after, cannot be null.

Returns:

the operation handle, never null.

enqueueHalfExclusiveOperation

public Object enqueueHalfExclusiveOperation(String name,
 Collection<IDtProject> projects,
 ProjectPipelineJob afterJob,
 boolean implicitDerivedDataWait)

Description copied from interface: IWorkspaceOrchestrator

Enqueues half exclusive operation with optional implicit wait cancelling

Specified by:

enqueueHalfExclusiveOperation in interface IWorkspaceOrchestrator

Parameters:

name - the operation name, cannot be null.

projects - the projects the operation affects, cannot be null.

afterJob - the stage the operation executed after, cannot be null.

implicitDerivedDataWait - True if the caller is need to wait for DD computation at the end of this operation

Returns:

the operation handle, never null.

enqueueBackgroundOperation

public Object enqueueBackgroundOperation(String name,
 Collection<IDtProject> projects,
 ProjectPipelineJob afterJob)

Description copied from interface: IWorkspaceOrchestrator

Enqueues background operation.

Specified by:

enqueueBackgroundOperation in interface IWorkspaceOrchestrator

Parameters:

name - the operation name, cannot be null.

projects - the projects the operation affects, cannot be null.

afterJob - the stage the operation executed after, cannot be null.

Returns:

the operation handle, never null.

enqueueModalOperation

public Object enqueueModalOperation(String name,
 Collection<IDtProject> projects,
 ProjectPipelineJob afterJob,
 IModalOperationController modalOperationController)

Description copied from interface: IWorkspaceOrchestrator

Enqueues the modal operation.

Specified by:

enqueueModalOperation in interface IWorkspaceOrchestrator

Parameters:

name - the operation name, cannot be null.

projects - the projects the operation affects, cannot be null.

afterJob - the stage the operation executed after, cannot be null.

Returns:

the operation handle, never null.

beginModalOperation

public Object beginModalOperation(String name,
 Collection<IDtProject> projects,
 ProjectPipelineJob afterJob,
 IModalOperationController modalOperationController)

Description copied from interface: IWorkspaceOrchestrator

Shortcut for the #enqueueModalOperation(String, Collection, ProjectPipelineJob) followed by waiting until the IWorkspaceOrchestrator.tryStartOperation(Object) is succeed.

Specified by:

beginModalOperation in interface IWorkspaceOrchestrator

Parameters:

name - the operation name, cannot be null.

projects - the projects the operation affects, cannot be null.

afterJob - the stage the operation executed after, cannot be null.

Returns:

the operation handle, never null.

beginExclusiveOperation

public Object beginExclusiveOperation(String name,
 Collection<IDtProject> projects,
 ProjectPipelineJob afterJob)

Description copied from interface: IWorkspaceOrchestrator

Shortcut for the IWorkspaceOrchestrator.enqueueExclusiveOperation(String, Collection, ProjectPipelineJob) followed by waiting until the IWorkspaceOrchestrator.tryStartOperation(Object) is succeed.

Specified by:

beginExclusiveOperation in interface IWorkspaceOrchestrator

Parameters:

name - the operation name, cannot be null.

projects - the projects the operation affects, cannot be null.

afterJob - the stage the operation executed after, cannot be null.

Returns:

the operation handle, never null.

beginHalfExclusiveOperation

public Object beginHalfExclusiveOperation(String name,
 Collection<IDtProject> projects,
 ProjectPipelineJob afterJob)

Description copied from interface: IWorkspaceOrchestrator

Shortcut for the IWorkspaceOrchestrator.enqueueHalfExclusiveOperation(String, Collection, ProjectPipelineJob) followed by waiting until the IWorkspaceOrchestrator.tryStartOperation(Object) is succeed.

Specified by:

beginHalfExclusiveOperation in interface IWorkspaceOrchestrator

Parameters:

name - the operation name, cannot be null.

projects - the projects the operation affects, cannot be null.

afterJob - the stage the operation executed after, cannot be null.

Returns:

the operation handle, never null.

beginBackgroundOperation

public Object beginBackgroundOperation(String name,
 Collection<IDtProject> projects,
 ProjectPipelineJob afterJob)

Description copied from interface: IWorkspaceOrchestrator

Shortcut for the IWorkspaceOrchestrator.enqueueBackgroundOperation(String, Collection, ProjectPipelineJob) followed by waiting until the IWorkspaceOrchestrator.tryStartOperation(Object) is succeed.

Specified by:

beginBackgroundOperation in interface IWorkspaceOrchestrator

Parameters:

name - the operation name, cannot be null.

projects - the projects the operation affects, cannot be null.

afterJob - the stage the operation executed after, cannot be null.

Returns:

the operation handle, never null.

tryStartOperation

public boolean tryStartOperation(Object handle)

Description copied from interface: IWorkspaceOrchestrator

Tries to start operation associated with the specified handle object.

Specified by:

tryStartOperation in interface IWorkspaceOrchestrator

Parameters:

handle - the operation handle, cannot be null.

Returns:

true if the operation allowed, false otherwise.

endOperation

public void endOperation(Object handle)

Description copied from interface: IWorkspaceOrchestrator

Ends the operation associated with the specified handle.

Specified by:

endOperation in interface IWorkspaceOrchestrator

Parameters:

handle - the operation handle, cannot be null.

cancelOperation

public void cancelOperation(Object handle)

Description copied from interface: IWorkspaceOrchestrator

Cancels the operation associated with the specified handle.

Specified by:

cancelOperation in interface IWorkspaceOrchestrator

Parameters:

handle - the operation handle, cannot be null.

addListener

public void addListener(IWorkspaceOrchestratorListener listener)

Description copied from interface: IWorkspaceOrchestrator

Adds the specified listener.

Specified by:

addListener in interface IWorkspaceOrchestrator

Parameters:

listener - the orchestrator listener to add, cannot be null.

removeListener

public void removeListener(IWorkspaceOrchestratorListener listener)

Description copied from interface: IWorkspaceOrchestrator

Removes the specified listener.

Specified by:

removeListener in interface IWorkspaceOrchestrator

Parameters:

listener - the orchestrator listener to remove, cannot be null.

requestJob

public boolean requestJob(IDtProject project,
 ProjectPipelineJob job)

Description copied from interface: IWorkspaceOrchestrator

Requests execution project pipeline job.

Specified by:

requestJob in interface IWorkspaceOrchestrator

Parameters:

project - the project, cannot be null.

job - the job, cannot be null.

Returns:

true if the execution is allowed, false otherwise.

jobComplete

public void jobComplete(IDtProject project,
 ProjectPipelineJob job)

Description copied from interface: IWorkspaceOrchestrator

Notifies orchestrator that the job is complete.

Specified by:

jobComplete in interface IWorkspaceOrchestrator

Parameters:

project - the project, cannot be null.

job - the job, cannot be null.

jobCancelled

public void jobCancelled(IDtProject project,
 ProjectPipelineJob job)

Description copied from interface: IWorkspaceOrchestrator

Notifies orchestrator that the job is cancelled.

Specified by:

jobCancelled in interface IWorkspaceOrchestrator

Parameters:

project - the project, cannot be null.

job - the job, cannot be null.

jobInterrupted

public void jobInterrupted(IDtProject project,
 ProjectPipelineJob job)

Description copied from interface: IWorkspaceOrchestrator

Notifies orchestrator that the job is interrupted.

Specified by:

jobInterrupted in interface IWorkspaceOrchestrator

Parameters:

project - the project, cannot be null.

job - the job, cannot be null.

cleanRestartProject

public void cleanRestartProject(IDtProject project)

Description copied from interface: IWorkspaceOrchestrator

Cleans and restarts the specified project.

It performs the next sequence of actions:

1. Collects dependent projects for the specified one
2. Stops the collected projects with the CLEAN stop type
3. Stops the specified project
4. Starts the specified project with the CLEAN_IMPORT start type
5. Starts again the dependent projects with the CLEAN_IMPORT start type

If the project is already stopped it does nothing.

Specified by:

cleanRestartProject in interface IWorkspaceOrchestrator

Parameters:

project - the project to stop, cannot be null.

cleanRestartProjects

public void cleanRestartProjects(Collection<IDtProject> projects)

Description copied from interface: IWorkspaceOrchestrator

Cleans and restarts the specified project's.

It performs the next sequence of actions:

1. Collects dependent projects for the specified one
2. Stops the collected projects with the CLEAN stop type
3. Stops the specified project
4. Starts the specified project with the CLEAN_IMPORT start type
5. Starts again the dependent projects with the CLEAN_IMPORT start type

If the project is already stopped it does nothing.

Specified by:

cleanRestartProjects in interface IWorkspaceOrchestrator

Parameters:

projects - the set of project to stop, cannot be null.

setOperationsEnabled

public void setOperationsEnabled(boolean enabled)

Sets whether workspace operations shall be approved. Broadcasts state change events.

Parameters:

enabled - true to enable operations, false to disable

isShuttingDown

public boolean isShuttingDown()

Description copied from interface: IWorkspaceOrchestrator

Checks if the IWorkspaceOrchestrator is being shut down at the momemnt. May be used for emergency interruption of long-running non-orchestrated processes

Specified by:

isShuttingDown in interface IWorkspaceOrchestrator

Returns:

True if the orchestrator is being shut down at the moment