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.persist;
28:
29: import java.util.List;
30: import java.util.Set;
31:
32: import org.cougaar.core.blackboard.MessageManager;
33: import org.cougaar.core.blackboard.PersistenceEnvelope;
34: import org.cougaar.core.blackboard.Subscriber;
35:
36: /**
37: * An extended persistence interface for {@link
38: * BlackboardPersistence}.
39: * <p>
40: * The {@link BlackboardPersistence} implementation recasts these
41: * methods into the new {@link PersistenceService} interface.
42: */
43: public interface Persistence {
44: /**
45: * End a persistence epoch by generating a persistence delta
46: * @param undistributedEnvelopes Envelopes that the distribute is about to distribute
47: * @param allEpochEnvelopes All envelopes from this epoch
48: * @param subscriberStates The subscriber states to record
49: */
50: PersistenceObject persist(List undistributedEnvelopes,
51: List allEpochEnvelopes, List subscriberStates,
52: boolean returnBytes, boolean full,
53: MessageManager messageManager, Object quiescenceMonitorState);
54:
55: /**
56: * Get the rehydration envelope from the most recent persisted state.
57: * @return null if there is no persisted state.
58: */
59: RehydrationResult rehydrate(PersistenceEnvelope oldObjects,
60: Object state);
61:
62: PersistenceSubscriberState getSubscriberState(Subscriber subscriber);
63:
64: boolean hasSubscriberStates();
65:
66: void discardSubscriberState(Subscriber subscriber);
67:
68: /**
69: * Get a set of the Keys of the SubscriberStates in the rehydration info.
70: * Used by the Distributor to track which subscribers have not
71: * rehydrated.
72: */
73: public Set getSubscriberStateKeys();
74:
75: java.sql.Connection getDatabaseConnection(Object locker);
76:
77: void releaseDatabaseConnection(Object locker);
78:
79: boolean isDummyPersistence();
80:
81: long getPersistenceTime();
82: }
|