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:
31: /**
32: * Required service requestor API for the {@link PersistenceService}.
33: */
34: public interface PersistenceClient {
35: /**
36: * Get the PersistenceIdentity of the client. A PersistenceIdentity
37: * uniquely identifies a PersistenceClient regardless of restarts.
38: * It is used as the key to retrieving the persisted state of the
39: * client after rehydration.
40: * @return the PersistenceIdentity of the client.
41: */
42: PersistenceIdentity getPersistenceIdentity();
43:
44: /**
45: * Get a list of things to persist. If an object in the list is an
46: * Envelope, the objects in the EnvelopeTuples in the Envelope are
47: * persisted. If an object in the list is an EnvelopeTuple, the
48: * object(s) in the EnvelopeTuple are persisted. In either case,
49: * rehydration will return all such objects inside a
50: * PersistenceEnvelope. Persisted Envelopes and EnvelopeTuples obey
51: * add/remove semantics across incremental snapshots. If a remove
52: * tuple appears, the rehydrated state will not include the object.
53: * All other types of objects are simple persisted with no
54: * add/remove semantics.
55: */
56: List getPersistenceData();
57: }
|