org.springframework.roo.process.manager.event

Interface ProcessManagerStatusProvider

All Known Subinterfaces:

ProcessManager

All Known Implementing Classes:

AbstractProcessManagerStatusPublisher, DefaultProcessManager

public interface ProcessManagerStatusProvider

Implemented by ProcessManagers that support the publication of shell status changes.

Implementations are not required to provide any guarantees with respect to the order in which notifications are delivered to listeners.

Implementations must permit modification of the listener list, even while delivering event notifications to listeners. However, listeners do not receive any guarantee that their addition or removal from the listener list will be effective or not for any event notification that is currently proceeding.

Implementations must ensure that status notifications are only delivered when an actual change has taken place.

Since:

1.0

Author:

Ben Alex

Method Summary

Methods

Modifier and Type	Method and Description
void	addProcessManagerStatusListener(ProcessManagerStatusListener processManagerStatusListener) Registers a new status listener.
ProcessManagerStatus	getProcessManagerStatus() Returns the current ProcessManager.
void	removeProcessManagerStatusListener(ProcessManagerStatusListener processManagerStatusListener) Removes an existing status listener.

Method Detail

addProcessManagerStatusListener

void addProcessManagerStatusListener(ProcessManagerStatusListener processManagerStatusListener)

Registers a new status listener.

Parameters:

processManagerStatusListener - to register (cannot be null)

getProcessManagerStatus

ProcessManagerStatus getProcessManagerStatus()

Returns the current ProcessManager.

Returns:

the current status (never null)

removeProcessManagerStatusListener

void removeProcessManagerStatusListener(ProcessManagerStatusListener processManagerStatusListener)

Removes an existing status listener.

If the presented status listener is not found, the method returns without exception.

Parameters:

processManagerStatusListener - to remove (cannot be null)