com.tibco.bpm.web.client.model.pagebus.hub
Class ManagedEventBus

java.lang.Object
  com.google.web.bindery.event.shared.EventBus
      com.google.gwt.event.shared.EventBus
          com.google.gwt.event.shared.SimpleEventBus
              com.tibco.bpm.web.client.model.pagebus.hub.ManagedEventBus

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers

public class ManagedEventBus
extends com.google.gwt.event.shared.SimpleEventBus

An EventBus extension that enables the use of the ManagedEvent class to pass events over the PageBus ManagedHub. The the normal GWT Event/Handler model is implemented and events are transparently fired over the ManagedHub.

Static members are used to:

• Set the Hub (InlineHubClient, IframeHubClient, or ManagedHub) used to fire or handle events on.
• Register or unregister ManagedEvents.
• Add or remove handlers.
• Fire events.
• Check for error conditions.

Handlers can be added and events fired just as with any GWT EventBus. In addition any HasHandlers implementation can be added.

This can be used with any normal GwtEvent in addition to the special functionality provided for any ManagedEvent extension class.

©2011 TIBCO Software Inc.

Since:

2.0.0

See Also:

ManagedEvent

Nested Class Summary

class

ManagedEventBus.ManagedHandlerRegistration

Method Summary

<H> com.google.web.bindery.event.shared.HandlerRegistration	addHandler(com.google.web.bindery.event.shared.Event.Type<H> type, H handler)
<H> com.google.web.bindery.event.shared.HandlerRegistration	addHandler(com.google.web.bindery.event.shared.Event.Type<H> type, H handler, java.lang.String handlerName)
<H> com.google.web.bindery.event.shared.HandlerRegistration	addHandlerToSource(com.google.web.bindery.event.shared.Event.Type<H> type, java.lang.Object source, H handler)
void	addManagedHandler(com.google.gwt.event.shared.HasHandlers managedHandler) Adds the given managedHandler.
void	fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)
void	fireEventFromSource(com.google.gwt.event.shared.GwtEvent<?> event, java.lang.Object source)
static ManagedEventBus	getBus()
static java.util.HashSet<ManagedEventBusError>	getManagedEventBusErrors() Gets the managedEventBusErrors field value.
static void	logEvent(java.lang.String regClassName, ManagedEvent<?> event, boolean alert)
static void	logEventAlert(java.lang.String regClassName, ManagedEvent<?> event, boolean alert)
static void	registerManagedEvent(ManagedEvent<?> managedEvent) Registers the given managedEvent.
void	removeManagedHandler(com.google.gwt.event.shared.HasHandlers managedHandler) Removes the given managedHandler.
static void	setHub(Hub hub) Sets the Hub instance used to publish and subscribe to the PageBus ManagedHub.
static void	setHub(Hub hub, OnManagedEventBusErrorCallback onManagedEventBusErrorCallback) Sets the Hub instance used to publish and subscribe to the PageBus ManagedHub.
static void	unRegisterManagedEvent(ManagedEvent<?> managedEvent) Unregisters the given managedEvent.

Methods inherited from class com.google.gwt.event.shared.SimpleEventBus

addHandler, addHandlerToSource, fireEvent, fireEventFromSource

Methods inherited from class com.google.gwt.event.shared.EventBus

castFireEvent, castFireEventFromSource, wrap

Methods inherited from class com.google.web.bindery.event.shared.EventBus

dispatchEvent, setSourceOfEvent

Methods inherited from class java.lang.Object

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

Method Detail

logEvent

public static void logEvent(java.lang.String regClassName,
                            ManagedEvent<?> event,
                            boolean alert)

logEventAlert

public static void logEventAlert(java.lang.String regClassName,
                                 ManagedEvent<?> event,
                                 boolean alert)

getBus

public static ManagedEventBus getBus()

registerManagedEvent

public static void registerManagedEvent(ManagedEvent<?> managedEvent)

Registers the given managedEvent. A subscription is created on the PageBus ManagedHub using the topic value for this ManagedEvent class. Note that the currently set eventSourceId value of the ManagedEvent is used to determine the topic. See ManagedEvent.getTopic()

This can be called before or after calling setHub.

Parameters:

managedEvent - The ManagedEvent instance being registered.

Throws:

ManagedEventDuplicateException

unRegisterManagedEvent

public static void unRegisterManagedEvent(ManagedEvent<?> managedEvent)

Unregisters the given managedEvent. The subscription that was created when registerManagedEvent was called is unsubscribed.

This method throws ManagedEventNotRegisteredException if the ManagedEvent is not registered.

This can be called before or after calling setHub.

Parameters:

managedEvent - The ManagedEvent instance being unregistered.

Throws:

ManagedEventNotRegisteredException

setHub

public static void setHub(Hub hub)

Sets the Hub instance used to publish and subscribe to the PageBus ManagedHub.

The Hub instance must be connected prior to making this call.

A null value is passed for OnManagedEventBusErrorCallback.

Parameters:

hub - The ManagedHub instance.

See Also:

setHub(Hub, OnManagedEventBusErrorCallback)

setHub

public static void setHub(Hub hub,
                          OnManagedEventBusErrorCallback onManagedEventBusErrorCallback)

Sets the Hub instance used to publish and subscribe to the PageBus ManagedHub.

The Hub instance must be connected prior to making this call.

The given #OnManagedEventBusErrorCallback is invoked if any error is returned on subscribing to a ManagedEvent topic. This value may be null. The getManagedEventBusErrors() method can also be used to check for subscription errors.

Parameters:

hub - The connected Hub instance.

onManagedEventBusErrorCallback - The handler for subscribe errors. This value may be null.

getManagedEventBusErrors

public static java.util.HashSet<ManagedEventBusError> getManagedEventBusErrors()

Gets the managedEventBusErrors field value. This is a set of any errors that occurred when subscribe or unsubscribe is called for a ManagedEvent topic.

These errors can occur when calling one of the following ManagedEventBus methods:

• setHub
• registerManagedEvent
• unRegisterManagedEvent

More than one error may be added for a given failure. For example, if a subscription fails for an InlineHubClient the subscription will have a null handle. This will generate a "Null Subscription Handle" error in addition to the subscription failure error.

addHandler

public <H> com.google.web.bindery.event.shared.HandlerRegistration addHandler(com.google.web.bindery.event.shared.Event.Type<H> type,
                                                                              H handler)

Overrides:

addHandler in class com.google.gwt.event.shared.SimpleEventBus

addHandler

public <H> com.google.web.bindery.event.shared.HandlerRegistration addHandler(com.google.web.bindery.event.shared.Event.Type<H> type,
                                                                              H handler,
                                                                              java.lang.String handlerName)

addHandlerToSource

public <H> com.google.web.bindery.event.shared.HandlerRegistration addHandlerToSource(com.google.web.bindery.event.shared.Event.Type<H> type,
                                                                                      java.lang.Object source,
                                                                                      H handler)

Overrides:

addHandlerToSource in class com.google.gwt.event.shared.SimpleEventBus

addManagedHandler

public void addManagedHandler(com.google.gwt.event.shared.HasHandlers managedHandler)

Adds the given managedHandler. Events fired on this ManagedEventBus will also be fired to the managedHandler.

Parameters:

managedHandler - A HasHandlers implementation to be added.

removeManagedHandler

public void removeManagedHandler(com.google.gwt.event.shared.HasHandlers managedHandler)

Removes the given managedHandler. Events fired on this ManagedEventBus will not be fired to the managedHandler after being removed.

Parameters:

managedHandler - A HasHandlers implementation to be removed.

fireEvent

public void fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)

Specified by:

fireEvent in interface com.google.gwt.event.shared.HasHandlers

Overrides:

fireEvent in class com.google.gwt.event.shared.SimpleEventBus

fireEventFromSource

public void fireEventFromSource(com.google.gwt.event.shared.GwtEvent<?> event,
                                java.lang.Object source)

Overrides:

fireEventFromSource in class com.google.gwt.event.shared.SimpleEventBus