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: package org.cougaar.core.util;
27:
28: import java.io.IOException;
29: import java.io.ObjectOutputStream;
30:
31: import org.cougaar.core.mts.MessageAddress;
32:
33: /**
34: * A {@link UniqueObject} with an agent "owner" field and allocation
35: * stack context.
36: */
37: public abstract class OwnedUniqueObject extends SimpleUniqueObject {
38: protected MessageAddress owner;
39:
40: private transient Throwable allocationContext;
41:
42: protected OwnedUniqueObject() {
43: allocationContext = new Throwable("Allocation context");
44: }
45:
46: public boolean isFrom(MessageAddress where) {
47: if (owner == null) {
48: ownerError("owner was never set");
49: }
50: return where.equals(owner);
51: }
52:
53: public void setOwner(MessageAddress newOwner) {
54: allocationContext = new Throwable("Allocation context");
55: owner = newOwner;
56: }
57:
58: public MessageAddress getOwner() {
59: if (owner == null) {
60: ownerError("owner was never set");
61: }
62: return owner;
63: }
64:
65: /** alias for getOwner */
66: public MessageAddress getSource() {
67: return getOwner();
68: }
69:
70: private void ownerError(String reason) {
71: if (allocationContext != null) {
72: allocationContext.printStackTrace();
73: } else {
74: System.err.println("OwnedUniqueObject deserialized");
75: }
76: throw new RuntimeException(reason + ": " + this );
77: }
78:
79: private void writeObject(ObjectOutputStream stream)
80: throws IOException {
81: if (owner == null) {
82: ownerError("writeObject with no owner");
83: }
84: stream.defaultWriteObject();
85: }
86: }
|