01: /*
02: * <copyright>
03: *
04: * Copyright 2001-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.plugin.freeze;
28:
29: import java.util.Set;
30:
31: import org.cougaar.core.mts.MessageAddress;
32: import org.cougaar.core.persist.NotPersistable;
33: import org.cougaar.core.relay.Relay;
34: import org.cougaar.core.util.SimpleUniqueObject;
35:
36: /**
37: * A target-side freeze {@link Relay}.
38: * <p>
39: * NOTE: This is part of the older mechanism for freezing the society. The
40: * current mechanism uses FreezeServlet located on every agent in the society,
41: * and depends on some external process to tell all agents to freeze. This older
42: * mechanism has not been removed so that people can continue to use a single servlet
43: * to freeze the entire society, but the FreezeServlet mechanism is preferred now.
44: */
45: public class FreezeRelayTarget extends SimpleUniqueObject implements
46: Relay.Target, NotPersistable {
47: transient MessageAddress sourceAddress;
48: transient Set response;
49: transient Token token;
50:
51: FreezeRelayTarget(MessageAddress source) {
52: this .sourceAddress = source;
53: }
54:
55: // Application Target API
56: void setUnfrozenAgents(Set unfrozenAgents) {
57: response = unfrozenAgents;
58: }
59:
60: // Target implementation
61: public MessageAddress getSource() {
62: return sourceAddress;
63: }
64:
65: public Object getResponse() {
66: return response;
67: }
68:
69: public int updateContent(Object newContent, Token token) {
70: return Relay.NO_CHANGE; // Content is never updated
71: }
72: }
|