KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > datashare > objects > ActivateConnectionObject


1 /* ----- BEGIN LICENSE BLOCK -----
2  * Version: MPL 1.1
3  *
4  * The contents of this file are subject to the Mozilla Public License Version
5  * 1.1 (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  * http://www.mozilla.org/MPL/
8  *
9  * 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 JavaDoc
43    {
44    /**
45     * this allows us to serialize this class without 'marshalling' errors.
46     */
47    static final long serialVersionUID = 9030593813711490501L;
48
49    /**
50     * the unique name for the client that is creating/sending this instance, used by the
51     * DataShareServer to assign ownership of the channel to a named client
52     */
53    public String JavaDoc clientKeyValue;
54
55    /**
56     * Constructor, useful only for creating an instance to be used for 'instanceOf' testing
57     */
58    public ActivateConnectionObject()
59       {}
60
61    /**
62     * Constructor, used by Clients to create an instance of this object.
63     * No further calls to methods in this class
64     * are required prior to sending this object.
65     *
66     * @param clientKeyValue should be set to the unique name of the client
67     * that is sending this object
68     */
69    public ActivateConnectionObject(String JavaDoc clientKeyValue)
70       {
71       this.clientKeyValue = clientKeyValue;
72       }
73    }
74
Popular Tags