KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > servicemix > jbi > nmr > flow > Flow


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * 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 org.apache.servicemix.jbi.nmr.Broker;
20
21 import javax.jbi.JBIException;
22 import javax.jbi.management.LifeCycleMBean;
23 import javax.jbi.messaging.MessageExchange;
24
25 /**
26  * A Flow provides different dispatch policies within the NMR
27  *
28  * @version $Revision: 426415 $
29  */
30 public interface Flow extends LifeCycleMBean {
31    
32     /**
33      * Initialize the Region
34      * @param broker
35      * @throws JBIException
36      */
37     public void init(Broker broker) throws JBIException;
38     
39     /**
40      * The description of Flow
41      * @return the description
42      */
43     public String JavaDoc getDescription();
44     
45     /**
46      * The unique name of Flow
47      * @return the name
48      */
49     public String JavaDoc getName();
50     
51     /**
52      * Distribute an ExchangePacket
53      * @param packet
54      * @throws JBIException
55      */
56     public void send(MessageExchange me) throws JBIException;
57     
58     /**
59      * suspend the flow to prevent any message exchanges
60      */
61     public void suspend();
62     
63     
64     /**
65      * resume message exchange processing
66      */
67     public void resume();
68     
69     /**
70      * Get the broker associated with this flow
71      *
72      */
73     public Broker getBroker();
74     
75     /**
76      * Check if the flow can support the requested QoS for this exchange
77      * @param me the exchange to check
78      * @return true if this flow can handle the given exchange
79      */
80     public boolean canHandle(MessageExchange me);
81         
82 }
Popular Tags