oracle.dacf.util.errormanager
Class ErrorManager

java.lang.Object
  oracle.dacf.util.errormanager.ErrorManager

public class ErrorManager

extends java.lang.Object

The ErrorManager is a singleton object that manages the storage and flow of ErrorMessage objects. The ErrorManager is invoked when:

• adding error messages

OR

• removing error messages

When adding or removing an error message, the ErrorManager notifies all registerted error listeners by calling ErrorListener.addingErrorMessage(ErrorMessage) or ErrorListener.removingErrorMessage(ErrorMessage) respectively.

Each of the notified error listeners has the option of vetoing the addition or the removal of the error. If the action is vetoed, the error will rolledback; the loggers will not be notified of the error. If the action is not vetoed, the error will be delivered to the error loggers.

The ErrorManager additionally administers the addition and removal of registered error loggers and error listeners.

See Also:

ErrorManagerListener, ErrorLogger, ErrorMessage, ErrorMessageVetoException, DacfErrorPopupLogger

Constructor Summary

ErrorManager()

Method Summary

static void	addErrorLogger(ErrorLogger el) Registers an ErrorLogger given its unique name.
static void	addErrorManagerListener(ErrorManagerListener eml) Registers an ErrorListener; registered listeners are eligible to be notified by the ErrorManager of error events.
static boolean	addErrorMessage(ErrorMessage em) Adds an ErrorMessage to the logging facility.
static ErrorManagerListener	findListenerByName(java.lang.String name) Returns the ErrorListener registered with the specified name.
static ErrorLogger	findLoggerByName(java.lang.String name) Returns an ErrorLogger, given its unique name.
static ErrorLogger[]	getBufferedErrorLoggers(boolean buffered) Returns the list of all registered buffered or non-buffered ErrorLoggers.
static ErrorLogger[]	getErrorLoggers() Returns the list of all registered ErrorLoggers.
static ErrorManagerListener[]	getErrorManagerListeners() Returns the list of all registered ErrorListeners.
static void	removeErrorLogger(ErrorLogger el) Unregisters an ErrorLogger; unregistered loggers will not be eligible to receive notification of errors or to be consulted by error listeners.
static void	removeErrorLogger(java.lang.String name) Unregisters an ErrorLogger, given its unique name.
static void	removeErrorManagerListener(ErrorManagerListener eml) Unregisters an error listener; unregistered listeners are not notified by the ErrorManager.
static void	removeErrorManagerListener(java.lang.String name) Unregisters an ErrorListener given its unique name.
static boolean	removeErrorMessage(ErrorMessage em) Removes an ErrorMessage from the logging facility.

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorManager

public ErrorManager()

Method Detail

addErrorManagerListener

public static void addErrorManagerListener(ErrorManagerListener eml)
                                    throws NameAlreadyRegisteredException

Registers an ErrorListener; registered listeners are eligible to be notified by the ErrorManager of error events.

ErrorListeners are registered by name. This method uses the ErrorListener's getName() method to uniquely register it.

Parameters:

eml - an error listener.

Throws:

NameAlreadyRegisteredException - if the listener's name is already registered.

See Also:

ErrorManagerListener

removeErrorManagerListener

public static void removeErrorManagerListener(ErrorManagerListener eml)

Unregisters an error listener; unregistered listeners are not notified by the ErrorManager.

Parameters:

eml - an error listener.

See Also:

ErrorManagerListener

removeErrorManagerListener

public static void removeErrorManagerListener(java.lang.String name)

Unregisters an ErrorListener given its unique name. The ErrorListener will no longer be eligible to receive notification of events or to veto errors.

Parameters:

name - the ErrorListener's unique name.

See Also:

ErrorManagerListener

findListenerByName

public static ErrorManagerListener findListenerByName(java.lang.String name)

Returns the ErrorListener registered with the specified name. The method uses getErrorManagerListeners() to obtain an array of listener names and iterates through them until the specified name is found.

Returns:

the requested ErrorManagerListener

addErrorLogger

public static void addErrorLogger(ErrorLogger el)
                           throws NameAlreadyRegisteredException

Registers an ErrorLogger given its unique name. Since ErrorLoggers are registered by name, this method uses the ErrorLoggers's getName() method to uniquely register it.

Parameters:

el - an ErrorLogger.

Throws:

NameAlreadyRegisteredException - if the logger's name is already registered.

See Also:

ErrorLogger

removeErrorLogger

public static void removeErrorLogger(ErrorLogger el)

Unregisters an ErrorLogger; unregistered loggers will not be eligible to receive notification of errors or to be consulted by error listeners.

Parameters:

el - an ErrorLogger.

See Also:

ErrorLogger

removeErrorLogger

public static void removeErrorLogger(java.lang.String name)

Unregisters an ErrorLogger, given its unique name. This method uses the findLoggerByName() method to obtain the logger before removing it.

Parameters:

name - the ErrorLogger's unique name.

See Also:

ErrorLogger

findLoggerByName

public static ErrorLogger findLoggerByName(java.lang.String name)

Returns an ErrorLogger, given its unique name. The method obtains an array of the names of the ErrorLoggers associated with the source and iterates through it until a match with the specified name is found.

Parameters:

name - the ErrorLogger's unique name.

Returns:

the requested ErrorLogger.

addErrorMessage

public static boolean addErrorMessage(ErrorMessage em)

Adds an ErrorMessage to the logging facility. This operation is vetoable by ErrorListeners. Therefore, the ErrorMessage object will not actually be added to any ErrorLogger until all listeners approve.

Parameters:

em - the ErrorMessage to be added.

Returns:

true if the ErrorMessage was successfully added to the ErrorLoggers; false if the "add ErrorMessage" event was vetoed.

See Also:

ErrorMessage, ErrorLogger, ErrorManagerListener

removeErrorMessage

public static boolean removeErrorMessage(ErrorMessage em)

Removes an ErrorMessage from the logging facility. This operation is vetoable by ErrorListeners. Therefore, the ErrorMessage object will not actually be removed from any ErrorLogger until all listeners approve.

Parameters:

em - the ErrorMessage to be removed.

Returns:

true if the ErrorMessage was successfully removed from the ErrorLoggers; false if the "remove ErrorMessage" event was vetoed.

See Also:

ErrorMessage, ErrorLogger, ErrorManagerListener

getErrorLoggers

public static ErrorLogger[] getErrorLoggers()

Returns the list of all registered ErrorLoggers.

Returns:

the list of all registered ErrorLoggers.

getBufferedErrorLoggers

public static ErrorLogger[] getBufferedErrorLoggers(boolean buffered)

Returns the list of all registered buffered or non-buffered ErrorLoggers.

Parameters:

buffered - true returns list of buffered loggers; false returns list of non-buffered loggers.

Returns:

the list of all registered buffered or non-buffered ErrorLoggers.

getErrorManagerListeners

public static ErrorManagerListener[] getErrorManagerListeners()

Returns the list of all registered ErrorListeners.

Returns:

the list of all registered ErrorListeners.