org.oddjob.beanbus.bus

Class BasicBusService

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.framework.extend.StructuralJob<java.lang.Object>

org.oddjob.beanbus.bus.BasicBusService

All Implemented Interfaces:

java.io.Flushable, java.io.Serializable, java.lang.Runnable, java.util.function.Consumer<java.lang.Object>, ArooaContextAware, ArooaSessionAware, ServiceProvider, ConductorServiceProvider, Forceable, PropertyChangeNotifier, Iconic, LogEnabled, Resettable, Stateful, Stoppable, Structural

public class BasicBusService
extends StructuralJob<java.lang.Object>
implements ConductorServiceProvider, java.util.function.Consumer<java.lang.Object>, java.io.Flushable

Description

Links components in a data pipeline. Components provide data by accepting an Consumer either by being an Outbound or by marking a setter with the Destination annotation. Components accept data by being a Consumer. Components can be both.

This component parent provides the following features over other component parents such as SequentialJob:

• Components will be automatically linked to the next component unless this is disabled.
• Any plain Consumer will appear in the bus as a service with appropriate icons and state.
• Components will be run (or started) in reverse order so destinations are ready to receive data before it is sent by the previous components.
• Components will be stopped in order so components that send data are stopped before the destinations that receive the data.
• If a component has a property setter of type AutoCloseable then one will be set automatically allowing the component to stop the bus.
• If a component has a property setter of type Flushable then one will be set automatically allowing the component to flush the bus.
• Any component that is Flushable will be flushed when a component flushes the bus. Flush will be called in component order. Flush will always be called when the bus stops, unless it crashes.
• If a component wishes to both stop and flush the bus, and doesn't mind a dependency on this framework it can provide a property setter of type BusConductor and one will be set automatically
• If a component enters an Exception state the bus will crash. Other components will be stopped in order.

Example

A simple bus of 3 components.

<oddjob>
    <job>
        <bus:bus id="bean-bus" xmlns:bus="oddjob:beanbus">
            <of>
                <bus:driver>
                    <values>
                        <list>
                            <values>
                                <bean class="org.oddjob.beanbus.example.Fruit" quantity="42" type="Apple" price="25.5"/>
                                <bean class="org.oddjob.beanbus.example.Fruit" quantity="24" type="Banana" price="36.2"/>
                                <bean class="org.oddjob.beanbus.example.Fruit" quantity="15" type="Pear" price="40.4"/>
                            </values>
                        </list>
                    </values>
                </bus:driver>
                <bus:map>
                    <function>
                        <bean class="org.oddjob.beanbus.example.DoublePrice"/>
                    </function>
                </bus:map>
                <bus:collect id="results"/>
            </of>
        </bus:bus>
    </job>
</oddjob>

See Also:

Serialized Form

Author:

Rob Gordon

Field Summary

Fields inherited from class org.oddjob.framework.extend.StructuralJob

childHelper, destroy, stop, structuralState

Constructor Summary

Constructors

Constructor and Description
BasicBusService() Only constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(java.lang.Object bean)
protected void	execute() Execute this job.
void	flush()
BusConductor	getBusConductor()
protected StateOperator	getInitialStateOp() Subclasses must provide the StateOperator that will decide how to evaluate the children's state.
ConductorService	getServices() Provider the services.
java.util.function.Consumer<java.lang.Object>	getTo()
boolean	isNoAutoLink()
protected void	maybeSetConsumerOnOutbound(java.lang.Object maybeOutbound, java.util.function.Consumer<?> consumer)
protected void	onReset() Allow sub classes to do something on reset.
protected void	onStop() Allow sub classes to do something on stop.
void	setBusConductor(BusConductor busConductor)
void	setNoAutoLink(boolean noAutoLink)
void	setOf(int index, java.lang.Object child) Add a child.
void	setTo(java.util.function.Consumer<java.lang.Object> to)

Methods inherited from class org.oddjob.framework.extend.StructuralJob

addStructuralListener, fireDestroyedState, force, getStateChanger, hardReset, iconHelper, isStop, onDestroy, onHardReset, onSoftReset, postStop, removeStructuralListener, run, softReset, startChildStateReflector, stateHandler, stop, stopChildStateReflector, waitForChildrenOnStop

Methods inherited from class org.oddjob.framework.extend.BasePrimary

configure, getName, logger, logger, loggerName, save, setName, toString

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, setArooaContext, setArooaSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Constructor Detail

BasicBusService

public BasicBusService()

Only constructor.

Method Detail

getInitialStateOp

protected StateOperator getInitialStateOp()

Description copied from class: StructuralJob

Subclasses must provide the StateOperator that will decide how to evaluate the children's state.

Specified by:

getInitialStateOp in class StructuralJob<java.lang.Object>

Returns:

A State Operator. Must not be null.

setOf

public void setOf(int index,
                  java.lang.Object child)

Add a child.

Property: of

Description: The components of a Bus.

Required: No, but pointless if missing.

Parameters:

child - A child

execute

protected void execute()
                throws java.lang.Exception

Description copied from class: StructuralJob

Execute this job.

Specified by:

execute in class StructuralJob<java.lang.Object>

Throws:

java.lang.Exception - If the unexpected occurs.

maybeSetConsumerOnOutbound

protected void maybeSetConsumerOnOutbound(java.lang.Object maybeOutbound,
                                          java.util.function.Consumer<?> consumer)

accept

public void accept(java.lang.Object bean)

Specified by:

accept in interface java.util.function.Consumer<java.lang.Object>

onReset

protected void onReset()

Description copied from class: StructuralJob

Allow sub classes to do something on reset.

Overrides:

onReset in class StructuralJob<java.lang.Object>

onStop

protected void onStop()
               throws FailedToStopException

Description copied from class: StructuralJob

Allow sub classes to do something on stop.

Overrides:

onStop in class StructuralJob<java.lang.Object>

Throws:

FailedToStopException

flush

public void flush()

Specified by:

flush in interface java.io.Flushable

getServices

public ConductorService getServices()

Description copied from interface: ServiceProvider

Provider the services.

Specified by:

getServices in interface ServiceProvider

Specified by:

getServices in interface ConductorServiceProvider

Property: services

Description: Provides services to other components of a bus. Exposed for advance use only.

Required: Read Only.

Returns:

The services. May be null.

getBusConductor

public BusConductor getBusConductor()

setBusConductor

public void setBusConductor(BusConductor busConductor)

isNoAutoLink

public boolean isNoAutoLink()

setNoAutoLink

public void setNoAutoLink(boolean noAutoLink)

getTo

public java.util.function.Consumer<java.lang.Object> getTo()

setTo

public void setTo(java.util.function.Consumer<java.lang.Object> to)