oracle.dacf.dataset
Class IBItemProducer

java.lang.Object
  oracle.dacf.dataset.IBItemProducer

All Implemented Interfaces:

java.util.EventListener, javax.infobus.InfoBusDataProducer, javax.infobus.InfoBusEventListener, javax.infobus.InfoBusMember, oracle.dacf.rp.Participant, oracle.dacf.rp.Producer, java.beans.PropertyChangeListener

public class IBItemProducer

extends java.lang.Object

implements javax.infobus.InfoBusMember, javax.infobus.InfoBusDataProducer, javax.infobus.InfoBusEventListener, oracle.dacf.rp.Producer

This class is the DataProducer on the InfoBus and responds to all subscription requests for DataItems. This class also serves as the root object for all of the InfoObjects that within the application. It also serves as the collection point for those errors that do not specifically belong on another object, yet contain information concerning the application as a whole.

The application is not responsible for instantiating this class. It is instantiated by the DAC framework.

Version:

SDK; since JDeveloper 3.0

Method Summary

void	addInfoBusPropertyListener(java.beans.PropertyChangeListener cl) Adds a PropertyChangeListener that will be alerted whenever the InfoBusMember's setInfoBus method is called and not vetoed.
void	addInfoBusVetoableListener(java.beans.VetoableChangeListener vcl) Adds a VetoableChangeListener to the list of listeners that will be alerted whenever the InfoBusMember's setInfoBus method is called.
void	dataItemRequested(javax.infobus.InfoBusItemRequestedEvent e) Responds to the InfoBusItemRequestedEvent event.
protected void	finalize() Called by the garbage collector on a DataProducer when garbage collection determines that there are no more references to the object.
javax.infobus.InfoBus	getInfoBus() Returns the InfoBus which is currently assigned to the InfoBusMember's InfoBus property.
java.lang.String	getInfoBusName() Returns the name of the active InfoBus.
protected java.lang.String	getName() Returns the fully qualified InfoBus name of this producer.
static java.lang.String	getURIScheme() Returns the prefix of the URI name format for a data item.
void	propertyChange(java.beans.PropertyChangeEvent e) The event listener that responds to all PropertyChangeEvent events.
void	released(java.lang.String objectName)
void	removeInfoBusPropertyListener(java.beans.PropertyChangeListener cl) Removes a PropertyChangeListener from the list of listeners requesting notification of an InfoBus change.
void	removeInfoBusVetoableListener(java.beans.VetoableChangeListener vcl) Removes a VetoableChangeListener from the list of listeners that will be alerted whenever the InfoBusMember's setInfoBus method is called.
java.lang.Object	requested(java.lang.String objectName)
void	setInfoBus(javax.infobus.InfoBus ib) When an InfoBusMember joins an InfoBus (via InfoBus.join), the responding InfoBus will use this method to set the member's InfoBus property to itself.
void	setInfoBusName(java.lang.String infoBusName) Sets the name of the active InfoBus.

Methods inherited from class java.lang.Object

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

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Called by the garbage collector on a DataProducer when garbage collection determines that there are no more references to the object.

Throws:

java.lang.Throwable - passes on any thrown exceptions.

getInfoBusName

public java.lang.String getInfoBusName()

Returns the name of the active InfoBus.

setInfoBusName

public void setInfoBusName(java.lang.String infoBusName)

Sets the name of the active InfoBus.

If there is an InfoBus already specified, it will first revoke all published DataItems before dropping off the bus. Next, it will reattach to the new bus and republish all available DataItems.

Parameters:

infoBusName - the name of the bus to use.

setInfoBus

public void setInfoBus(javax.infobus.InfoBus ib)
                throws java.beans.PropertyVetoException

When an InfoBusMember joins an InfoBus (via InfoBus.join), the responding InfoBus will use this method to set the member's InfoBus property to itself.

Specified by:

setInfoBus in interface javax.infobus.InfoBusMember

Throws:

java.beans.PropertyVetoException - if the InfoBusMember refuses to join.

getInfoBus

public javax.infobus.InfoBus getInfoBus()

Returns the InfoBus which is currently assigned to the InfoBusMember's InfoBus property.

Specified by:

getInfoBus in interface javax.infobus.InfoBusMember

Returns:

the InfoBus currently assigned to the InfoBusMember's InfoBus property.

addInfoBusPropertyListener

public void addInfoBusPropertyListener(java.beans.PropertyChangeListener cl)

Adds a PropertyChangeListener that will be alerted whenever the InfoBusMember's setInfoBus method is called and not vetoed.

Specified by:

addInfoBusPropertyListener in interface javax.infobus.InfoBusMember

Parameters:

cl - a PropertyChangeListener.

See Also:

setInfoBus(javax.infobus.InfoBus ib)

addInfoBusVetoableListener

public void addInfoBusVetoableListener(java.beans.VetoableChangeListener vcl)

Adds a VetoableChangeListener to the list of listeners that will be alerted whenever the InfoBusMember's setInfoBus method is called.

Specified by:

addInfoBusVetoableListener in interface javax.infobus.InfoBusMember

Parameters:

vcl - a VetoableChangeListener.

removeInfoBusPropertyListener

public void removeInfoBusPropertyListener(java.beans.PropertyChangeListener cl)

Removes a PropertyChangeListener from the list of listeners requesting notification of an InfoBus change.

Specified by:

removeInfoBusPropertyListener in interface javax.infobus.InfoBusMember

Parameters:

cl - the PropertyChangeListener to be removed.

removeInfoBusVetoableListener

public void removeInfoBusVetoableListener(java.beans.VetoableChangeListener vcl)

Removes a VetoableChangeListener from the list of listeners that will be alerted whenever the InfoBusMember's setInfoBus method is called.

Specified by:

removeInfoBusVetoableListener in interface javax.infobus.InfoBusMember

Parameters:

vcl - the VetoableChangeListener to be removed.

getURIScheme

public static java.lang.String getURIScheme()

Returns the prefix of the URI name format for a data item. By default, the prefix is infobus:/oracle.

getName

protected java.lang.String getName()

Returns the fully qualified InfoBus name of this producer. This is the InfoBus name preceded by the URI prefix. By default the prefix is infobus:/oracle

Returns:

an InfoBus name preceded by the URI prefix.

requested

public java.lang.Object requested(java.lang.String objectName)

Specified by:

requested in interface oracle.dacf.rp.Producer

released

public void released(java.lang.String objectName)

Specified by:

released in interface oracle.dacf.rp.Producer

dataItemRequested

public void dataItemRequested(javax.infobus.InfoBusItemRequestedEvent e)

Responds to the InfoBusItemRequestedEvent event.

This method is called by the InfoBus class on behalf of a data consumer that is requesting a data item by name. Name format is: infobus:/oracle/IBItemProducer/Session/Iterator[/column]

Specified by:

dataItemRequested in interface javax.infobus.InfoBusDataProducer

Parameters:

e - InfoBusItemRequestedEvent sent when an DataItem is requested.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

The event listener that responds to all PropertyChangeEvent events.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

e - the PropertyChangeEvent carrying information regarding what has changed.