01: /*
02: * <copyright>
03: *
04: * Copyright 2002-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.wp.resolver;
28:
29: import java.util.Map;
30: import org.cougaar.core.component.Service;
31:
32: /**
33: * This service is the {@link ClientTransport}'s interface to the
34: * {@link CacheManager} for lookup messaging.
35: * <p>
36: * This API hides the MTS and messaging details. In particular,
37: * the transport selects which WP server(s) the lookups should
38: * be sent to, aggregates results if necessary, and retries any
39: * failed deliveries.
40: * <p>
41: * The service requestor must implement the Client API.
42: */
43: public interface LookupService extends Service {
44:
45: /**
46: * Lookup entries in the server(s).
47: * <p>
48: * The map is from String keys to UIDs. The key is the "getAll"
49: * name or "list" suffix. If the client has a cached Record
50: * from a prior lookup then it can pass the UID of that Record
51: * to request a RecordIsValid response, otherwise it should pass
52: * a null UID. If the current record's UID doesn't match
53: * the UID then a full Record will be sent back.
54: * <p>
55: * It's fine to submit a singleton map, but for efficiency a
56: * client can use this API to batch requests.
57: */
58: void lookup(Map m);
59:
60: interface Client {
61: /**
62: * Respond to a lookup request.
63: * <p>
64: * The map is from String keys to either Record or RecordIsValid
65: * objects.
66: * <p>
67: * RecordIsValid objects are used for lookups that specified a
68: * UID to validate a cached Record, otherwise Record objects
69: * are used to provide the full data (e.g. the AddressEntries
70: * for a "getAll" lookup).
71: * <p>
72: * The values contain relative timestamp offsets for the
73: * cache expiration time (e.g. "+5000 millis"), so the baseTime
74: * is also specified.
75: */
76: void lookupAnswer(long baseTime, Map m);
77: }
78: }
|