org.glassfish.api.admin

Interface AdminCommandEventBroker<T>

public interface AdminCommandEventBroker<T>

Events broker for AdminCommands. It can be used to inform everybody who listen. Any object can be event. If ReST Provider is registered for particular type, it is also transfered to remote client.

Author:

mmares

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AdminCommandEventBroker.AdminCommandListener<T> Listener for AdminCommand events.
static class	AdminCommandEventBroker.BrokerListenerRegEvent
static interface	AdminCommandEventBroker.EventBrokerUtils Place relevant for utility methods

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCAL_EVENT_PREFIX Local events are not transfered to remote listener using SSE

Method Summary

Methods

Modifier and Type	Method and Description
void	fireEvent(Object event) Fire event under name of event.getClass.getName().
void	fireEvent(String name, Object event) Fire event under defined name.
AdminCommandEventBroker.EventBrokerUtils	getUtils() Pack of utility methods related to this instance of event broker.
boolean	listening(String eventName) Returns true if exist exists registered listener for given eventName
void	registerListener(String regexpForName, AdminCommandEventBroker.AdminCommandListener<T> listener) Register Listener for admin command events.
void	unregisterListener(AdminCommandEventBroker.AdminCommandListener listener) Remove registered listener.

Field Detail

LOCAL_EVENT_PREFIX

static final String LOCAL_EVENT_PREFIX

Local events are not transfered to remote listener using SSE

See Also:

Constant Field Values

Method Detail

fireEvent

void fireEvent(String name,
             Object event)

Fire event under defined name. Any object can be event.

Parameters:

name - Event name. Listener is registered to some name.

event - Any object can be event

fireEvent

void fireEvent(Object event)

Fire event under name of event.getClass.getName().

Parameters:

event - Any object can be event.

registerListener

void registerListener(String regexpForName,
                    AdminCommandEventBroker.AdminCommandListener<T> listener)

Register Listener for admin command events.

Parameters:

regexpForName - listen to events with name valid to this regular expression.

listener - Listener will be called

unregisterListener

void unregisterListener(AdminCommandEventBroker.AdminCommandListener listener)

Remove registered listener.

Parameters:

listener - Listener to remove

listening

boolean listening(String eventName)

Returns true if exist exists registered listener for given eventName

getUtils

AdminCommandEventBroker.EventBrokerUtils getUtils()

Pack of utility methods related to this instance of event broker.