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.lib.filter;
28:
29: import org.cougaar.lib.callback.UTILFilterCallback;
30: import org.cougaar.lib.param.ParamMap;
31:
32: /**
33: * Plugins listen for organization changes.
34: *
35: * Plugins have parameters.
36: * Plugins set up filterCallbacks.
37: *
38: * Plugins dispatch filter changes
39: * to the appropriate filter. This is the heart of the plugin.
40: */
41:
42: public interface UTILPlugin {
43: /**
44: * The idea is to add subscriptions, and when they change, to
45: * invoke the subscription's callback.
46: */
47: void setupFilters();
48:
49: /**
50: * Place to put any local plugin startup initiallization.
51: * This is a good place to read local data from files.
52: */
53: void localSetup();
54:
55: /** Add a filter callback */
56: void addFilter(UTILFilterCallback callbackObj);
57:
58: /** Allows child classes to read additional data from environment files. */
59: void getEnvData();
60:
61: /** params for this plugin */
62: ParamMap getMyParams();
63:
64: /**
65: * turns on infoging debug if a failed pe is encountered
66: *
67: */
68: // void showDebugIfFailure ();
69: }
|