org.pfsw.tools.cda.core.init

Class WorksetInitializer

java.lang.Object

org.pfsw.tools.cda.core.init.WorksetInitializer

All Implemented Interfaces:

IRunnableTerminationListener

public class WorksetInitializer
extends java.lang.Object
implements IRunnableTerminationListener

This is a controller that is responsible to initialize a particular workset.

Constructor Summary

Constructors

Constructor and Description
WorksetInitializer(Workset ws) Initialize the new instance with a workset.

Method Summary

Modifier and Type	Method and Description
void	addCallback(AWorksetInitializationEventCallback callback) Adds a callback that gets invoked about a specific event during the initialization progress.
void	addListener(IWorksetInitializationListener listener) Adds a listener that gets informed about the initialization progress.
void	cancel() Cancel all initialization immediately.
protected org.pfsw.tools.cda.core.init.DependencyResolverTask	getClassFileLoading()
protected org.pfsw.tools.cda.core.init.ReleasableThread	getCurrentInitThread()
protected java.util.List<AWorksetInitializationEventCallback>	getEventCallbacks()
protected java.util.List<IWorksetInitializationListener>	getInitListeners()
protected IProgressMonitor	getProgressMonitor()
Workset	getWorkset()
void	initializeWorkset(IProgressMonitor monitor) Initializes the underlying workset using background threads.
boolean	initializeWorksetAndWait(IProgressMonitor monitor) Initializes the underlying workset using background threads, but then waits until the initialization has been completed or cancelled.
static boolean	initWorksetAndWait(Workset aWorkset) This convenience method allows to initialize the given workset using background threads, but waiting until the initialization has been completed or cancelled.
protected void	notifyCallbacksAndListeners(IWorksetInitializationListener.EventType type) Notifies all registered callbacks and listeners about the given event.
void	release()
void	runnableFinished(java.lang.Runnable runnable, boolean aborted) Gets called when a runnable ends its run() method.
protected void	setClassFileLoading(org.pfsw.tools.cda.core.init.DependencyResolverTask newValue)
protected void	setCurrentInitThread(org.pfsw.tools.cda.core.init.ReleasableThread currentInitThread)
protected void	setProgressMonitor(IProgressMonitor newValue)
protected void	startBackgroundContainerLookup() Resolves all containers from the specified workset "classpath" definitions.
protected void	startBackgroundContainersScanner() Collects all packages and classes for each found container.
protected void	startClassFileLoadingAndAnalyzingThread() Loads each detected class file (i.e.
protected void	startSpringBeansAnalyzingThread() Loads each detected class file (i.e.
protected void	stopAllBackgroundTasks()
protected void	waitUntilDone(java.util.concurrent.atomic.AtomicBoolean done)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorksetInitializer

public WorksetInitializer(Workset ws)

Initialize the new instance with a workset.

Method Detail

initWorksetAndWait

public static boolean initWorksetAndWait(Workset aWorkset)

This convenience method allows to initialize the given workset using background threads, but waiting until the initialization has been completed or cancelled.

Parameters:

aWorkset - The workset to be initialized (must not be null).

Returns:

true if the initialization has been completed successfully.

getWorkset

public Workset getWorkset()

addListener

public void addListener(IWorksetInitializationListener listener)

Adds a listener that gets informed about the initialization progress. If the given listener is null it will be ignored.

addCallback

public void addCallback(AWorksetInitializationEventCallback callback)

Adds a callback that gets invoked about a specific event during the initialization progress. If the given callback is null it will be ignored.

initializeWorkset

public void initializeWorkset(IProgressMonitor monitor)

Initializes the underlying workset using background threads. That is, this method returns before the initialization has been completed!

initializeWorksetAndWait

public boolean initializeWorksetAndWait(IProgressMonitor monitor)

Initializes the underlying workset using background threads, but then waits until the initialization has been completed or cancelled.

Returns:

true if the initialization has been completed successfully.

cancel

public void cancel()

Cancel all initialization immediately.

release

public void release()

runnableFinished

public void runnableFinished(java.lang.Runnable runnable,
                             boolean aborted)

Gets called when a runnable ends its run() method.

Specified by:

runnableFinished in interface IRunnableTerminationListener

Parameters:

runnable - The runnable that is calling this method.

aborted - If true the runnable was stopped somehow before completing its task.

startBackgroundContainerLookup

protected void startBackgroundContainerLookup()

Resolves all containers from the specified workset "classpath" definitions. This will create a GenericClassContainer for each found container. During this process bundles like OSGi JARs, WARs, EARs etc. will be unpacked to temporary folders.

The actual contents of the containers will be processed by a later initialization step.

startBackgroundContainersScanner

protected void startBackgroundContainersScanner()

Collects all packages and classes for each found container. That is, it creates a ClassPackage object for each package and a ClassInformation for each found class. However, the ClassInformation objects created here, are not yet analyzed at all. That is, reading the and determine their dependencies will happen in a later initialization step.

So, after this step, all ClassPackage and ClassInformation objects are in the underlying ClassSpace.

startClassFileLoadingAndAnalyzingThread

protected void startClassFileLoadingAndAnalyzingThread()

Loads each detected class file (i.e. ClassInformation object in the ClassSpace) and analyzes it for its dependencies. The found dependencies will be added to a list inside the ClassInformation.

startSpringBeansAnalyzingThread

protected void startSpringBeansAnalyzingThread()

Loads each detected class file (i.e. ClassInformation object in the ClassSpace) and analyzes it for its dependencies. The found dependencies will be added to a list inside the ClassInformation.

notifyCallbacksAndListeners

protected void notifyCallbacksAndListeners(IWorksetInitializationListener.EventType type)

Notifies all registered callbacks and listeners about the given event.

stopAllBackgroundTasks

protected void stopAllBackgroundTasks()

waitUntilDone

protected void waitUntilDone(java.util.concurrent.atomic.AtomicBoolean done)

getProgressMonitor

protected IProgressMonitor getProgressMonitor()

setProgressMonitor

protected void setProgressMonitor(IProgressMonitor newValue)

getClassFileLoading

protected org.pfsw.tools.cda.core.init.DependencyResolverTask getClassFileLoading()

setClassFileLoading

protected void setClassFileLoading(org.pfsw.tools.cda.core.init.DependencyResolverTask newValue)

getCurrentInitThread

protected org.pfsw.tools.cda.core.init.ReleasableThread getCurrentInitThread()

setCurrentInitThread

protected void setCurrentInitThread(org.pfsw.tools.cda.core.init.ReleasableThread currentInitThread)

getInitListeners

protected java.util.List<IWorksetInitializationListener> getInitListeners()

getEventCallbacks

protected java.util.List<AWorksetInitializationEventCallback> getEventCallbacks()