Skip navigation links

oracle.idm.util.progress
Class ProgressManager

java.lang.Object
oracle.idm.util.progress.ProgressManager

public class ProgressManager

extends java.lang.Object

The ProgressManager object is the entry point into the progress reporting API. Functions of the ProgressSupport object can be grouped into the following sections:

• ProgressListener management - set of methods to manage registration of progress event listeners
• ProgressEvent management - set of methods to create and send progress events and manage timers that generate progress events
• ProgressMonitor and ProgressReporter factory - a set of methods to create other support objects initialized with the appropriate parameters

A context or connection object should create an instance of the ProgressManager class, and provide a getter for this instance.

Constructor Summary

ProgressManager(java.lang.Object source)
The constructor for this class takes a source input parameter.

Method Summary

void	addProgressListener(ProgressListener listener) Adds an unndamed ProgressListener to the listener list.
void	addProgressListener(java.lang.String name, ProgressListener listener) Adds a named ProgressListener to the listener list.
protected static void	cancelTimer()
ProgressEvent	getProgressEvent(java.lang.String name) ProgressEvent factory method.
ProgressMonitor	getProgressMonitor(java.lang.Runnable runnable) ProgresMonitor factory method.
ProgressReporter	getProgressReporter() ProgresReporter factory method.
java.lang.Object	getSource() Getter for the source property.
protected static java.util.Timer	getTimer() Getter for the timer property object associated with this ProgressManager instance.
boolean	hasProgressListeners() Return true if there are any registered progress listeners.
boolean	hasProgressListeners(java.lang.String name) Return true if there are any registered progress listeners interested in events of the given name.
protected static boolean	hasTimer()
void	removeProgressListener(ProgressListener listener) Removes a ProgressListener from the listener list.
void	removeProgressListeners() Removes all ProgressListeners from the listener list.
void	sendProgressEvent(ProgressEvent event) Sends a progres event to the progres listeners.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressManager

public ProgressManager(java.lang.Object source)

The constructor for this class takes a source input parameter. This source parameter will be used by the factory methods to provide the source parameter to other classes, such as ProgressEvent. This source argument should be the context or connection object itself that created the instance of the ProgressManager object.

Parameters:

source - The object to be given as the source for progress events.

Method Detail

getSource

public java.lang.Object getSource()

Getter for the source property.

addProgressListener

public void addProgressListener(ProgressListener listener)

Adds an unndamed ProgressListener to the listener list. An unnamed progress listener receives all progress events, regardless of the event name.

Parameters:

listener - The ProgressListener to be added.

See Also:

#getProgressEvent(), getProgressEvent(String)

addProgressListener

public void addProgressListener(java.lang.String name,
                                ProgressListener listener)

Adds a named ProgressListener to the listener list. A named progress listener receives only the progress events with the same name.

Parameters:

name - The name of the events to listen for.

listener - The ProgressListener to be added.

See Also:

#getProgressEvent(), getProgressEvent(String)

removeProgressListeners

public void removeProgressListeners()

Removes all ProgressListeners from the listener list.

removeProgressListener

public void removeProgressListener(ProgressListener listener)

Removes a ProgressListener from the listener list.

Parameters:

listener - The ProgressListener to be removed.

hasProgressListeners

public boolean hasProgressListeners()

Return true if there are any registered progress listeners.

Returns:

hasProgressListeners

public boolean hasProgressListeners(java.lang.String name)

Return true if there are any registered progress listeners interested in events of the given name.

Returns:

sendProgressEvent

public void sendProgressEvent(ProgressEvent event)

Sends a progres event to the progres listeners.

Parameters:

event -

getProgressEvent

public ProgressEvent getProgressEvent(java.lang.String name)

ProgressEvent factory method.

Parameters:

name - The name for the ProgressEvent being created. The recommended name is package.Class.method of the API generating the events.

Returns:

New ProgresEvent instance with the given name.

See Also:

ProgressEvent.suggestName()

getProgressReporter

public ProgressReporter getProgressReporter()

ProgresReporter factory method.

Returns:

New ProgressReporter instance.

getProgressMonitor

public ProgressMonitor getProgressMonitor(java.lang.Runnable runnable)

ProgresMonitor factory method.

Parameters:

runnable - Runnable whose progress will to be monitored.

Returns:

New ProgressMonitor instance.

getTimer

protected static java.util.Timer getTimer()

Getter for the timer property object associated with this ProgressManager instance. All instaces of the ProgressManager class share the same timer. The timer is lazy boud, it will not be created untill the first call to this meothd.

Returns:

hasTimer

protected static boolean hasTimer()

cancelTimer

protected static void cancelTimer()

Skip navigation links