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.core.domain;
28:
29: import org.cougaar.core.mts.MessageAddress;
30:
31: /**
32: * A {@link LogicProvider} that handles agent restart reconciliation.
33: */
34: public interface RestartLogicProvider extends LogicProvider {
35:
36: /**
37: * Called by the Blackboard whenever this agent or a remote agent
38: * restarts.
39: * <p>
40: * The primary function of this API is to allow a logic providers
41: * to reconcile the state of restarted agents.
42: * <p>
43: * If the given "cid" is null then <i>this</i> agent has
44: * restarted. This logic provider should resend/confirm its
45: * state with all (remote) agents that it has communicated
46: * with.
47: * <p>
48: * If the given "cid" is non-null then the "cid" is
49: * for a remote agent that has been restarted. This
50: * logic provider should resend/confirm its state
51: * <i>with regards to that one remote agent</i>.
52: *
53: * @param cid null if this agent restarted, otherwise the
54: * MessageAddress of a remote agent that restarted
55: *
56: * @see RestartLogicProviderHelper utility method to test the
57: * given "cid"
58: */
59: void restart(MessageAddress cid);
60: }
|