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 for the
34: * {@link LeaseManager} for sending bind/unbind messages.
35: * <p>
36: * This API hides the MTS and messaging details. In particular,
37: * the transport selects which WP server(s) the modifications 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 ModifyService extends Service {
44:
45: /**
46: * Bind or renew leased entries in the server(s).
47: * <p>
48: * The map keys are Strings for the name of the entry (e.g.
49: * "AgentX"). The value can be either a Record, UID, or a
50: * NameTag that wraps either a Record or UID. Records are
51: * used for new leases and UIDs are used for lease renewals.
52: * <p>
53: * The NameTag specifies the agent that's requesting the action.
54: * If a NameTag is not used then the agent is the local
55: * node-agent.
56: * <p>
57: * Lease renewal just sends the UID of the most recent
58: * version. If the server's UID for the name matches the
59: * sent UID then the server extends the Lease and tells the
60: * client the new expiration time. If the server doesn't know
61: * the UID then the client will be told that the lease is not
62: * known and it should send the full Record. If a conflicting
63: * UID is in place then the server will either tell the client
64: * that the Lease renewal is denied or act as if the lease is
65: * not known and request the full Record object for further
66: * deconfliction analysis.
67: * <p>
68: * It's fine to submit a singleton map, but for efficiency a
69: * client can use this API to batch requests.
70: */
71: void modify(Map m);
72:
73: interface Client {
74: /**
75: * Receive the answer to a modify request.
76: * <p>
77: * The map is from String keys to objects, which are of type
78: * Lease, LeaseNotKnown, or LeaseDenied.
79: * <p>
80: * The values in the map may use relative timestamp offsets
81: * (e.g. "+5000 millis"), so the baseTime is also specified.
82: */
83: void modifyAnswer(long baseTime, Map m);
84: }
85: }
|