KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > datashare > TreeViewServerInterface


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: TreeViewServerInterface.java,v 1.1.1.1 2001/10/23 13:37:16 lizellaman Exp $
25  * $Log: TreeViewServerInterface.java,v $
26  * Revision 1.1.1.1 2001/10/23 13:37:16 lizellaman
27  * initial sourceforge release
28  *
29  */
30
31 package org.datashare;
32
33 import java.util.Hashtable JavaDoc;
34 import java.io.IOException JavaDoc;
35
36 /**
37  * this class defines the methods that the TreeView class may invoke on the
38  * DataShareServer class. This was done mainly so that a limit could be placed
39  * on how much access the TreeView class has to DataShareServer methods.
40  */
41 public interface TreeViewServerInterface
42    {
43    /**
44     * returns true if the client is admin type
45     */
46    boolean
47    isClientAdmin(String JavaDoc clientKey);
48
49    /**
50     * returns true if the server has this client in its list of currently registered clients
51     */
52    boolean
53    isClientRegistered(String JavaDoc clientKey);
54
55    /**
56     * returns true if persisted data is to be created for objects
57     */
58    boolean
59    getPersistData();
60
61    /**
62     * returns reference to persistence interface, should be non-null if getPersistData() returns true
63     */
64    PersistenceInterface
65    getPersistenceInterface();
66
67    /**
68     * This method saveds the specified data to the database and puts the data's key value into the
69     * PersistDataCallbackInterface instance after the data is created.
70     *
71     * @param tableName the name of the table this data should be added to
72     * @param props describes what is to be persisted in the database
73     * @param callback the interface that supplies the methods used to set the Key for this data
74     */
75    void
76    saveDataToDatabase(String JavaDoc tableName, Hashtable JavaDoc props, PersistDataCallbackInterface callback);
77
78    void
79    removeConsumer(String JavaDoc clientKey, String JavaDoc sessionKey, String JavaDoc channelKey);
80
81    void
82    addConsumer(String JavaDoc clientKey, String JavaDoc sessionKey, String JavaDoc channelKey, boolean channelActive);
83
84    boolean
85    getShowArchivedSessionsToAdmin();
86
87    Hashtable JavaDoc
88    getSessionTable();
89
90    Hashtable JavaDoc
91    getSpecialClientTable();
92
93    /**
94     * Returns the ClientInfo for this client is this client is found in specialClients table
95     */
96    ClientInfo
97    getClientInfo(String JavaDoc clientKey);
98
99    int
100    getNextPort();
101
102    String JavaDoc
103    getServerInfo();
104
105 // boolean
106 // getAllowArchiving();
107 }
108
Popular Tags