01: /* ----- BEGIN LICENSE BLOCK -----
02: * Version: MPL 1.1
03: *
04: * The contents of this file are subject to the Mozilla Public License Version
05: * 1.1 (the "License"); you may not use this file except in compliance with
06: * the License. You may obtain a copy of the License at
07: * http://www.mozilla.org/MPL/
08: *
09: * Software distributed under the License is distributed on an "AS IS" basis,
10: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11: * for the specific language governing rights and limitations under the
12: * License.
13: *
14: * The Original Code is the DataShare server.
15: *
16: * The Initial Developer of the Original Code is
17: * Ball Aerospace & Technologies Corp, Fairborn, Ohio
18: * Portions created by the Initial Developer are Copyright (C) 2001
19: * the Initial Developer. All Rights Reserved.
20: *
21: * Contributor(s): Charles Wood <cwood@ball.com>
22: *
23: * ----- END LICENSE BLOCK ----- */
24: /* RCS $Id: ActivateConnectionObject.java,v 1.1.1.1 2001/10/23 13:37:19 lizellaman Exp $
25: * $Log: ActivateConnectionObject.java,v $
26: * Revision 1.1.1.1 2001/10/23 13:37:19 lizellaman
27: * initial sourceforge release
28: *
29: */
30:
31: package org.datashare.objects;
32:
33: /**
34: * a Client must send this object over a connection before the DataShareServer will use the
35: * connection to send or recieve data. It lets the server know which 'client'
36: * has established the connection. This object is sent from the Clients over the data
37: * and commmandStatus Channels to the DataShare server.
38: *
39: * @since Version 2
40: * @author Charles Wood
41: */
42: public class ActivateConnectionObject implements java.io.Serializable {
43: /**
44: * this allows us to serialize this class without 'marshalling' errors.
45: */
46: static final long serialVersionUID = 9030593813711490501L;
47:
48: /**
49: * the unique name for the client that is creating/sending this instance, used by the
50: * DataShareServer to assign ownership of the channel to a named client
51: */
52: public String clientKeyValue;
53:
54: /**
55: * Constructor, useful only for creating an instance to be used for 'instanceOf' testing
56: */
57: public ActivateConnectionObject() {
58: }
59:
60: /**
61: * Constructor, used by Clients to create an instance of this object.
62: * No further calls to methods in this class
63: * are required prior to sending this object.
64: *
65: * @param clientKeyValue should be set to the unique name of the client
66: * that is sending this object
67: */
68: public ActivateConnectionObject(String clientKeyValue) {
69: this.clientKeyValue = clientKeyValue;
70: }
71: }
|