01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.servicemix.jbi.nmr.flow;
18:
19: import javax.jbi.JBIException;
20: import javax.jbi.management.LifeCycleMBean;
21: import javax.jbi.messaging.MessageExchange;
22:
23: import org.apache.servicemix.jbi.nmr.Broker;
24:
25: /**
26: * A Flow provides different dispatch policies within the NMR
27: *
28: * @version $Revision: 564607 $
29: */
30: public interface Flow extends LifeCycleMBean {
31:
32: /**
33: * Initialize the Region
34: * @param broker
35: * @throws JBIException
36: */
37: void init(Broker broker) throws JBIException;
38:
39: /**
40: * The description of Flow
41: * @return the description
42: */
43: String getDescription();
44:
45: /**
46: * The unique name of Flow
47: * @return the name
48: */
49: String getName();
50:
51: /**
52: * Distribute an ExchangePacket
53: * @param packet
54: * @throws JBIException
55: */
56: void send(MessageExchange me) throws JBIException;
57:
58: /**
59: * suspend the flow to prevent any message exchanges
60: */
61: void suspend();
62:
63: /**
64: * resume message exchange processing
65: */
66: void resume();
67:
68: /**
69: * Get the broker associated with this flow
70: *
71: */
72: Broker getBroker();
73:
74: /**
75: * Check if the flow can support the requested QoS for this exchange
76: * @param me the exchange to check
77: * @return true if this flow can handle the given exchange
78: */
79: boolean canHandle(MessageExchange me);
80:
81: }
|