KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > quickserver > net > server > ClientIdentifiable


1 /*
2  * This file is part of the QuickServer library
3  * Copyright (C) 2003-2005 QuickServer.org
4  *
5  * Use, modification, copying and distribution of this software is subject to
6  * the terms and conditions of the GNU Lesser General Public License.
7  * You should have received a copy of the GNU LGP License along with this
8  * library; if not, you can download a copy from <http://www.quickserver.org/>.
9  *
10  * For questions, suggestions, bug-reports, enhancement-requests etc.
11  * visit http://www.quickserver.org
12  *
13  */

14
15 package org.quickserver.net.server;
16 /**
17  * This is an interface that can be implemented by {@link ClientData}
18  * so that the client connected can be identified.
19  * One can search an client by using
20  * {@link QuickServer#findFirstClientById}, {@link QuickServer#findAllClientById},
21  * {@link QuickServer#findClientByKey}, {@link QuickServer#findAllClientByKey},
22  * {@link QuickServer#findAllClient}
23  * @since 1.3.1
24  */

25 public interface ClientIdentifiable {
26     /**
27      * Returns string (hash code) unique for that user connected.
28      */

29     public String JavaDoc getClientId();
30
31     /**
32      * Returns string (hash code) unique for that client connected.
33      * used to differentiate client that share same user ids.
34      */

35     public String JavaDoc getClientKey();
36
37     /**
38      * Returns some inforamtion for that client connected.
39      */

40     public String JavaDoc getClientInfo();
41 }
42
Popular Tags