01: /*
02: * <copyright>
03: *
04: * Copyright 1997-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26:
27: package org.cougaar.mts.base;
28:
29: import java.util.ArrayList;
30:
31: import org.cougaar.core.component.Service;
32: import org.cougaar.util.UnaryPredicate;
33:
34: /**
35: * Generic service specialized by DestinationQueueProviderService and
36: * SendQueueProviderService. The methods at this level handle queue
37: * "events" registration as well as the removal of messages.
38: */
39: public interface QueueProviderService extends Service {
40: /**
41: * Removes any messages matching the given predicate, in all
42: * relevant queues. Each removed message is added to the given
43: * ArrayList.
44: */
45: void removeMessages(UnaryPredicate predicate, ArrayList removed);
46:
47: /**
48: * Add the given listener to the list of those receiving callbacks
49: * for queue events. Listeners will be notified of queue events
50: * via callback.
51: */
52: void addListener(QueueListener listener);
53:
54: /**
55: * Removes the given listener from the list of those receiving callbacks
56: * for queue events.
57: */
58: void removeListener(QueueListener listener);
59: }
|