org.apache.servicemix.jbi.nmr.flow
Interface Flow

All Superinterfaces:

javax.jbi.management.LifeCycleMBean

All Known Implementing Classes:

AbstractFlow, AbstractJMSFlow, JCAFlow, JMSFlow, JMSFlowTibco, SedaFlow, STFlow

public interface Flow
extends javax.jbi.management.LifeCycleMBean

A Flow provides different dispatch policies within the NMR

Version:

$Revision: 564607 $

Field Summary

Fields inherited from interface javax.jbi.management.LifeCycleMBean

SHUTDOWN, STARTED, STOPPED, UNKNOWN

Method Summary

boolean	canHandle(javax.jbi.messaging.MessageExchange me) Check if the flow can support the requested QoS for this exchange
Broker	getBroker() Get the broker associated with this flow
String	getDescription() The description of Flow
String	getName() The unique name of Flow
void	init(Broker broker) Initialize the Region
void	resume() resume message exchange processing
void	send(javax.jbi.messaging.MessageExchange me) Distribute an ExchangePacket
void	suspend() suspend the flow to prevent any message exchanges

Methods inherited from interface javax.jbi.management.LifeCycleMBean

getCurrentState, shutDown, start, stop

Method Detail

init

void init(Broker broker)
          throws javax.jbi.JBIException

Initialize the Region

Parameters:

broker -

Throws:

javax.jbi.JBIException

getDescription

String getDescription()

The description of Flow

Returns:

the description

getName

String getName()

The unique name of Flow

Returns:

the name

send

void send(javax.jbi.messaging.MessageExchange me)
          throws javax.jbi.JBIException

Distribute an ExchangePacket

Parameters:

packet -

Throws:

javax.jbi.JBIException

suspend

void suspend()

suspend the flow to prevent any message exchanges

resume

void resume()

resume message exchange processing

getBroker

Broker getBroker()

Get the broker associated with this flow

canHandle

boolean canHandle(javax.jbi.messaging.MessageExchange me)

Check if the flow can support the requested QoS for this exchange

Parameters:

me - the exchange to check

Returns:

true if this flow can handle the given exchange