echopoint.externalevent
Class ExternalEventMonitor

java.lang.Object
  nextapp.echo.app.Component
      echopoint.externalevent.ExternalEventMonitor

All Implemented Interfaces:

Serializable, RenderIdSupport

public class ExternalEventMonitor
extends Component

A ExternalEventMonitor can be used to monitor external events that come in via web request URIs.

ExternalEventMonitor will inform all attached ExternalEventListeners about those web request events.

ExternalEventMonitor looks for web application requests with the special marker "E_id=ExternalEvent". This allows other web pages (especially non Echo2 based ones) to link to the Echo web application via an URI, say something like :

 /servletcontext/servlet?sid=ExternalEvent&p1=v1&p2=v2..
 

The parameters of the web request are packaged into a Map and placed within the ExternalEvent object.

ExternalEventMonitor is a non visual component.

Version:

$Id$

Author:

Brad Baker

Modified by Mikael Soderman 2009-04-28

See Also:

ExternalEvent, ExternalEventListener, Serialized Form

Field Summary

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

ExternalEventMonitor()
Constructs an ExternalEventMonitor

Method Summary

void	addExternalEventListener(ExternalEventListener l) Adds an ExternalEventListener to the ExternalEventMonitor
void	dispose() When the ExternalEventMonitor is removed from the component hierarchy it is also made removed from the ExternalEventMonitorService
void	fireExternalEvent(ExternalEvent externalEvent) This is called by the support code to inform all ExternalEventListeners that an external event has ocurred.
void	init() When the ExternalEventMonitor is placed in the component hierarchy it is also made known to the ExternalEventMonitorService
void	removeExternalEventListener(ExternalEventListener l) Removes an ExternalEventListener from the ExternalEventMonitor
void	setVisible(boolean newValue) This component can never be made visible.

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isValidParent, isVisible, processInput, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalEventMonitor

public ExternalEventMonitor()

Constructs an ExternalEventMonitor

Method Detail

init

public void init()

When the ExternalEventMonitor is placed in the component hierarchy it is also made known to the ExternalEventMonitorService

Overrides:

init in class Component

See Also:

Component.init()

dispose

public void dispose()

When the ExternalEventMonitor is removed from the component hierarchy it is also made removed from the ExternalEventMonitorService

Overrides:

dispose in class Component

See Also:

Component.dispose()

addExternalEventListener

public void addExternalEventListener(ExternalEventListener l)

Adds an ExternalEventListener to the ExternalEventMonitor

Parameters:

l - the ExternalEventListener to add

removeExternalEventListener

public void removeExternalEventListener(ExternalEventListener l)

Removes an ExternalEventListener from the ExternalEventMonitor

Parameters:

l - the ExternalEventListener to remove

fireExternalEvent

public void fireExternalEvent(ExternalEvent externalEvent)

This is called by the support code to inform all ExternalEventListeners that an external event has ocurred. This is method not designed to be called by Echo2 applications directly.

Parameters:

externalEvent - - the new ExternalEvent

setVisible

public void setVisible(boolean newValue)

This component can never be made visible.

Overrides:

setVisible in class Component

See Also:

Component.setVisible(boolean)