1 /******************************************************************************
2 * FIBSAttributes.java - Fetch what we need to connect to the server
3 * $Id$
4 *
5 * BuckoFIBS - Backgammon by BuckoSoft
6 * Copyright(c) 2009,2010 - Dick Balaska - BuckoSoft, Corp.
7 *
8 * $Log$
9 * Revision 1.4 2011/05/22 05:48:15 dick
10 * Point to the "new" cvs location.
11 *
12 * Revision 1.3 2010/03/03 13:12:21 inim
13 * Replaced (c) sign in comment mangled by CVS default encoding back to UTF-8
14 *
15 * Revision 1.2 2010/03/03 12:19:49 inim
16 * Moved source to UTF8 encoding from CP1252 encoding. To this end all source files' (c) message was updated to "Copyright© 2009,2010 - Dick Balaska - BuckoSoft, Corp.". This replaces the (c) sign to UTF8, and adds the new year 2010.
17 *
18 * Revision 1.1 2010/02/04 05:57:53 inim
19 * Mavenized project folder layout
20 *
21 * Revision 1.6 2009/02/14 12:29:56 dick
22 * BuckoFIBS is released under the GNU license.
23 *
24 * Revision 1.5 2009/02/02 08:36:54 dick
25 * Add getAppSignature().
26 *
27 * Revision 1.4 2009/01/28 18:15:52 dick
28 * Prettier cvs link in the javadoc.
29 *
30 * Revision 1.3 2009/01/18 06:17:33 dick
31 * Fix the cvs link.
32 *
33 * Revision 1.2 2009/01/18 05:17:40 dick
34 * Javadoc.
35 *
36 * Revision 1.1 2009/01/12 07:46:06 dick
37 * Fetch what we need to connect to the server.
38 *
39 */
40
41 /*
42 * This program is free software: you can redistribute it and/or modify
43 * it under the terms of the GNU General Public License as published by
44 * the Free Software Foundation, either version 3 of the License, or
45 * (at your option) any later version.
46 *
47 * This program is distributed in the hope that it will be useful,
48 * but WITHOUT ANY WARRANTY; without even the implied warranty of
49 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
50 * GNU General Public License for more details.
51 *
52 * You should have received a copy of the GNU General Public License
53 * along with this program. If not, see <http://www.gnu.org/licenses/>.
54 *
55 * The Original Code is BuckoFIBS, <http://www.buckosoft.com/BuckoFIBS/>.
56 * The Initial Developer of the Original Code is Dick Balaska and BuckoSoft, Corp.
57 *
58 */
59 package com.buckosoft.fibs.net;
60
61 /** Fetch what we need to connect to the server.
62 * @author Dick Balaska
63 * @since 2009/01/11
64 * @version $Revision$ <br> $Date$
65 * @see <a href="http://cvs.buckosoft.com/Projects/BuckoFIBS/BuckoFIBS/src/main/java/com/buckosoft/fibs/net/FIBSAttributes.java">cvs FIBSAttributes.java</a>
66 */
67 public interface FIBSAttributes {
68
69 /** Get the name of the server
70 * (probably either <code>fibs.com</code> or <code>lbd.buckosoft.com</code>)
71 * @return The name of the server
72 */
73 String getServerName();
74
75 /** Get the port number that we are connecting to.
76 * @return probably 4321
77 */
78 int getServerPort();
79
80 /** Get the user name
81 * @return The user name
82 */
83 String getUserName();
84
85 /** Get the user's password in clear text
86 * @return The clear text password
87 */
88 String getUserPassword();
89
90 /** Get the client app signature, the name and version.
91 * @return Something like "BuckoFIBS_1.0"
92 */
93 String getAppSignature();
94
95 /** Should we display messages as we send them?
96 * @return true = yes
97 */
98 boolean isDisplayXmit();
99
100 /** Should messages that are received be sent to stdout for logging?
101 * @return true = log messages to stdout
102 */
103 boolean isStdoutNetworkMessages();
104 }