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.server;
28:
29: import java.util.Map;
30: import org.cougaar.core.component.Service;
31: import org.cougaar.core.mts.MessageAddress;
32:
33: /**
34: * This service sends "modify-ack"s.
35: * <p>
36: * This API mirrors the client's ModifyService.
37: * <p>
38: * The clientAddr is the address of the client that sent
39: * the modify message, which is where the response message
40: * will be sent.
41: * <p>
42: * The clientTime is the time that the client sent it's request.
43: * Answer messages sent back to the client are tagged with both
44: * the client's time and the server's time, which allows
45: * the client to measure the round-trip-time and correct for
46: * any clock drift.
47: * <p>
48: * This API hides the MTS and messaging details.
49: * <p>
50: * The service requestor must implement the Client API.
51: *
52: * @see org.cougaar.core.wp.resolver.ModifyService
53: */
54: public interface ModifyAckService extends Service {
55:
56: /** Acknowledge a client's "modify" request. */
57: void modifyAnswer(MessageAddress clientAddr, long clientTime, Map m);
58:
59: interface Client {
60: /**
61: * Handle a client's modify request.
62: * <p>
63: * The server should call the "modifyAnswer" method.
64: */
65: void modify(MessageAddress clientAddr, long clientTime, Map m);
66: }
67: }
|