Java > Open Source Codes > org > planetamessenger > protocols > comvc > JComVcConstants


1 /*
2     =========================================================================
3     Package comvc - Implements the ComVc Protocol.
4
5     This module is developed and maintained by PlanetaMessenger.org.
6     Specs, New and updated versions can be found in
7     http://www.planetamessenger.org
8     If you want contact the Team please send a email to Project Manager
9     Leidson Campos Alves Ferreira at leidson@planetamessenger.org
10
11     Copyright (C) since 2001 by PlanetaMessenger.org
12     
13     This library is free software; you can redistribute it and/or
14     modify it under the terms of the GNU Lesser General Public
15     License as published by the Free Software Foundation; either
16     version 2.1 of the License, or (at your option) any later version.
17
18     This library is distributed in the hope that it will be useful,
19     but WITHOUT ANY WARRANTY; without even the implied warranty of
20     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21     Lesser General Public License for more details.
22
23     You should have received a copy of the GNU Lesser General Public
24     License along with this library; if not, write to the Free Software
25     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26
27     =========================================================================
28 */
29 /**
30  *
31  * $Id: JComVcConstants.java,v 1.6 2007/02/11 13:52:36 popolony2k Exp $
32  * $Author: popolony2k $
33  * $Name: $
34  * $Revision: 1.6 $
35  * $State: Exp $
36  *
37  */
38
39 package org.planetamessenger.protocols.comvc;
40
41 import java.util.*;
42 import java.text.*;
43
44
45 public class JComVcConstants {
46
47   // Components Test related constants
48 static final int COMVC_CREATE_USER = 0;
49   static final int COMVC_USER_LOGIN = 1;
50   static final int COMVC_BUDDY_LIST = 2;
51   
52   // Protocol specific constants
53 static final java.lang.String COMVC_REG_SUCCESS = "ComVCok";
54   static final java.lang.String COMVC_SEARCH_SUCCESS = "buscaok";
55   static final java.lang.String COMVC_SEARCH_ERROR = "buscaok1";
56   static final java.lang.String COMVC_PROTO_VER = "COMVC/1.0";
57   static final java.lang.String COMVC_CLIENT_VER = "200006";
58   static final java.lang.String COMVC_LOCAL_INFO = "0"; //"br";
59 static final java.lang.String COMVC_INIT_FLAG = "INI";
60   static final java.lang.String COMVC_STATUS_FLAG = "STS";
61   static final java.lang.String COMVC_IPLIST_FLAG = "LST";
62   static final java.lang.String COMVC_MESSAGE_FLAG = "MSG";
63   static final java.lang.String COMVC_MSG_OFF_FLAG = "MOF";
64   static final java.lang.String COMVC_ACK_FLAG = "ACK";
65   static final java.lang.String COMVC_INPUT_FLAG = "INP";
66   static final java.lang.String COMVC_OUTPUT_FLAG = "OUT";
67   static final java.lang.String COMVC_AUTH_FLAG = "AUT";
68   static final java.lang.String COMVC_ADD_FLAG = "ADD";
69   static final java.lang.String COMVC_SERVER_OK = "200";
70   static final java.lang.String COMVC_SERVER_ERROR = "400";
71   
72   // Protocols Keys constants
73 static final java.lang.String COMVC_IP_KEY = "IP";
74   static final java.lang.String COMVC_PORT_KEY = "PORT";
75   static final java.lang.String COMVC_PORTUDP_KEY = "PORTU";
76   static final java.lang.String COMVC_VERSION_KEY = "V";
77   static final java.lang.String COMVC_STATUS_KEY = "STATUS";
78   static final java.lang.String COMVC_TICKET_KEY = "TICKET";
79   static final java.lang.String COMVC_TICKETD_KEY = "TICKETD";
80   static final java.lang.String COMVC_CRYPT_KEY = "CRYPT";
81   static final java.lang.String COMVC_MSG_KEY = "MSG COMVC";
82   static final java.lang.String COMVC_MSGOFF_KEY = "[MSGOFF]";
83   static final java.lang.String COMVC_USERID_KEY = "IDUOL";
84   static final java.lang.String COMVC_DATE_KEY = "DATA";
85   static final java.lang.String COMVC_TIME_KEY = "HORA";
86   static final java.lang.String COMVC_FORMAT_KEY = "FORMAT";
87   static final java.lang.String COMVC_GETAUT_KEY = "[GETAUT]";
88   static final java.lang.String COMVC_LIST_KEY = "[LIST]";
89   
90   // Server related constants
91 static final java.lang.String COMVC_ADMIN_SERVER = "nvsf1.uol.com.br";
92   static final java.lang.String COMVC_LOGIN_SERVER = "comvc.uol.com.br";
93   static final int COMVC_ADMIN_PORT = 80;
94   static final int COMVC_LOGIN_PORT = 2000;
95   static final int COMVC_SERVICES_PORT = 2104;
96   
97   // Client related contants
98 static final int COMVC_BEGIN_PORT = 2000;
99   static final int COMVC_END_PORT = 6500;
100   static final int COMVC_KEEPALIVE_TIME = 30000;
101   
102   // User status constants
103 static public final int STATUS_OFFLINE = 0;
104   static public final int STATUS_ONLINE = 1;
105   static public final int STATUS_INVISIBLE = 2;
106   static public final int STATUS_AWAY = 3;
107   
108   // Buddy only status
109 static final int STATUS_BUDDY_INVISIBLE = 4;
110
111   
112   // Protocol related functions
113 static final java.lang.String formatNewUserString( JUserDetails userDetails ) {
114   /**
115    * Format a create New User protocol
116    * string.
117    * Parameters:
118    * o userDetails - User details object;
119    */
120     
121     java.lang.String strFmt = "/cgi-bin/cadastro.cgi?senha=" + userDetails.getPassword() + "&tipo=1" +
122                                  "&Nome=" + userDetails.getName() + "&Sobrenome=" + userDetails.getSecondName() +
123                                  "&Apelido=" + userDetails.getNick() + "&Email=" + userDetails.getEmail() +
124                                  "&Sexo=" + userDetails.getGender() + "&DivulgarEmail=" + userDetails.getShowEmail();
125     
126     return strFmt;
127   }
128   
129   static final java.lang.String formatChangePasswordString( JUserDetails userDetails, java.lang.String strNewPasswd ) {
130   /**
131    * Format a create New User protocol
132    * string.
133    * Parameters:
134    * o userDetails - User details object;
135    * o strNewPasswd - The new user passwd;
136    */
137
138     java.lang.String strFmt = "/cgi-bin/mudasenha.cgi?IDUOL=" + userDetails.getUserId() + "&newsenha=" + strNewPasswd +
139                                  "&oldsenha=" + userDetails.getPassword();
140
141     return strFmt;
142   }
143   
144   static final java.lang.String formatSearchUserString( long nUserId ) {
145   /**
146    * Format a search user protocol string .
147    * Parameters:
148    * o nUserId - The user id;
149    */
150     
151     java.lang.String strFmt = "/cgi-bin/contatos.cgi?iduol=" + Long.toString( nUserId );
152         
153     return strFmt;
154   }
155   
156   static final java.lang.String formatLoginString( JUserDetails userDetails, JSystemDetails systemDetails ) {
157   /**
158      Format a login string.
159      Parameter:
160       * userDetails - User details object;
161       * systemDetails - System details object;
162   */
163     
164     java.lang.String strFmt = COMVC_INIT_FLAG + " " + COMVC_PROTO_VER + "\r\n" +
165                                  "IDUOL=" + Long.toString( userDetails.getUserId() ) + "\r\n" +
166                                  "PSW=" + userDetails.getPassword() + "\r\n" +
167                                  "PORT=" + systemDetails.getTCPPort() + "\r\n" +
168                                  "PORTU=" + systemDetails.getUDPPort() + "\r\n" +
169                                  "V=" + COMVC_CLIENT_VER + "\r\n" +
170                                  "LOCAL=" + COMVC_LOCAL_INFO + "\r\n\r\n";
171
172     return strFmt;
173   }
174   
175   static final java.lang.String formatStatusString( JUserDetails userDetails, JSystemDetails systemDetails ) {
176   /**
177      Format the Change Status string.
178      Parameter:
179       * userDetails - User details object;
180       * systemDetails - System details object;
181   */
182     
183     java.lang.String strFmt = COMVC_STATUS_FLAG + " " + COMVC_PROTO_VER + "\r\n" +
184                                  "IDUOL=" + Long.toString( userDetails.getUserId() ) + "\r\n" +
185                                  "TICKET=" + Long.toString( systemDetails.getTicket() ) + "\r\n" +
186                                  "STATUS=" + Integer.toString( userDetails.getStatus() ) + "\r\n\r\n";
187
188     return strFmt;
189   }
190   
191   static final java.lang.String formatIPListString( JUserDetails userDetails, JSystemDetails systemDetails, java.util.HashMap <Long , JComVcContactItem> hUserIdList ) {
192   /**
193      Format the List IP string.
194      Parameters:
195       * userDetails - User details object;
196       * systemDetails - System details object;
197       * hUserIdList - UserId List to retrieve;
198   */
199     
200     java.lang.String strFmt = COMVC_IPLIST_FLAG + " " + COMVC_PROTO_VER + "\r\n" +
201                                  "IDUOL=" + Long.toString( userDetails.getUserId() ) + "\r\n" +
202                                  "TICKET=" + Long.toString( systemDetails.getTicket() ) + "\r\n" +
203                                  "LIST:\r\n";
204
205   
206     java.util.Iterator <JComVcContactItem> itItems = hUserIdList.values().iterator();
207     
208     while( itItems.hasNext() )
209       strFmt+=( itItems.next().toString() + "|0\r\n" );
210
211     strFmt+="\r\n";
212
213     return strFmt;
214   }
215   
216   static final java.lang.String formatMessageString( JUserDetails userDetails, JSystemDetails systemDetails, long nToUser, java.lang.String strMsg, boolean bMsgType ) {
217   /**
218     * Format the Send message String.
219     * Parameters:
220     * o userDetails - User details object;
221     * o systemDetails - System details object;
222     * o nToUser - The target userId;
223     * o strMsg - The message that will be sent;
224     * o bMsgType - The Message type (true direct,
225     * false offline);
226     */
227
228     java.lang.String strMsgType;
229     
230     
231     if( !bMsgType )
232       strMsgType = COMVC_MSG_OFF_FLAG;
233     else
234       strMsgType = COMVC_MESSAGE_FLAG;
235
236     DecimalFormat fmt = new DecimalFormat( "00" );
237     GregorianCalendar cal = new GregorianCalendar();
238     int nSize = 8; // Text size
239 char aEOL[] = { 0x0e, 0x14 };
240     java.lang.String strTmp = org.planetamessenger.util.JKeyParser.replace( strMsg, "\r\n", new String ( aEOL ) );
241     java.lang.String strData = fmt.format( cal.get( cal.YEAR ) ) + fmt.format( cal.get( cal.MONTH ) ) + fmt.format( cal.get( cal.DAY_OF_MONTH ) );
242     java.lang.String strHora = fmt.format( cal.get( cal.HOUR ) ) + fmt.format( cal.get( cal.MINUTE ) ) + fmt.format( cal.get( cal.SECOND ) );
243     java.lang.String strFmt = strMsgType + " " + COMVC_PROTO_VER + "\r\n" +
244                                   "IDUOL=" + Long.toString( userDetails.getUserId() ) + "\r\n" +
245                                   "TICKET=" + Long.toString( systemDetails.getTicket() ) + "\r\n" +
246                                   "IDUOLX=" + Long.toString( nToUser ) + "\r\n" +
247                                   "DATA=" + strData + "\r\n" + "HORA=" + strHora + "\r\n" +
248                                   "FORMAT=-2147483643|-2147483640|MS Sans Serif|" + nSize + "|1|0|0" + "\r\n" +
249                                   //"FORMAT=?|?|MS Sans Serif|" + nSize + "|0|0|0" + "\r\n" +
250 "MSG=" + strTmp + "\r\n\r\n";
251     
252     return strFmt;
253   }
254   
255   static final java.lang.String formatAckString( JUserDetails userDetails, JSystemDetails systemDetails ) {
256   /**
257      Format the Send message String.
258      Parameters:
259       * userDetails - User details object;
260       * systemDetails - System details object;
261   */
262
263     java.lang.String strFmt = COMVC_ACK_FLAG + " " + COMVC_PROTO_VER + "\r\n" +
264                                  "IDUOL=" + Long.toString( userDetails.getUserId() ) + "\r\n" +
265                                  "TICKET=" + Long.toString( systemDetails.getTicket() ) + "\r\n\r\n";
266     
267     return strFmt;
268   }
269   
270   static final java.lang.String formatSuccessString( java.lang.String strMessage ) {
271   /**
272      Format the Success message String.
273      Parameters:
274       * strFlag - The message that will
275         be formatted;
276   */
277     
278     java.lang.String strFmt = strMessage + " " + COMVC_SERVER_OK + "\r\n\r\n";
279     
280     return strFmt;
281   }
282   
283   static final java.lang.String formatInpOutString( boolean bIsInp, JUserDetails userDetails, JSystemDetails systemDetails, long nTargetTicket ) {
284   /**
285    * Format a Input string
286    * Parameter:
287    * o bIsInp - Inp string flag;
288    * o userDetails - User details object;
289    * o systemDetails - System details object;
290    * o nTargetTicket - The Target Ticket;
291   */
292     
293     java.lang.String strMsgType;
294     java.lang.String strFmt;
295     
296     
297     if( bIsInp )
298       strMsgType = COMVC_INPUT_FLAG;
299     else
300       strMsgType = COMVC_OUTPUT_FLAG;
301     
302     strFmt = strMsgType + " " + COMVC_PROTO_VER + "\r\n" +
303              "IDUOL=" + Long.toString( userDetails.getUserId() ) + "\r\n" +
304              "TICKET=" + Long.toString( systemDetails.getTicket() ) + "\r\n" +
305              "IP=" + systemDetails.getIPAddress() + "\r\n" +
306              "PORT=" + systemDetails.getUDPPort() + "\r\n" +
307              "PORTU=" + systemDetails.getTCPPort() + "\r\n" +
308              "TICKETD=" + nTargetTicket + "\r\n" +
309              "STATUS=" + userDetails.getStatus() + "\r\n" +
310              "V=" + COMVC_CLIENT_VER + "\r\n\r\n";
311
312     return strFmt;
313   }
314   
315   static final java.lang.String formatAddUserString( JUserDetails userDetails, JSystemDetails systemDetails, long nToUser ) {
316   /**
317      Format a add user string.
318      Parameter:
319       * userDetails - User details object;
320       * systemDetails - System details object;
321       * nToUser - The Target user;
322   */
323     
324     java.lang.String strFmt = COMVC_ADD_FLAG + " " + COMVC_PROTO_VER + "\r\n" +
325                                   "IDUOL=" + Long.toString( userDetails.getUserId() ) + "\r\n" +
326                                   "NICK=" + userDetails.getNick() + "\r\n" +
327                                   "TICKET=" + Long.toString( systemDetails.getTicket() ) + "\r\n" +
328                                   "IDUOLX=" + Long.toString( nToUser ) + "\r\n\r\n";
329
330     
331     return strFmt;
332   }
333   
334   static final java.lang.String formatAuthorizeUser( long nUserId, JUserDetails userDetails, JSystemDetails systemDetails ) {
335   /**
336     * Format a authorize user string.
337     * Parameter:
338     * o nUserId - The user that we want
339     * authorization;
340     * o userDetails - User details object;
341     * o systemDetails - System details object;
342     */
343     
344     java.lang.String strFmt = COMVC_AUTH_FLAG + " " + COMVC_PROTO_VER + "\r\n" +
345                                  "IDUOL=" + Long.toString( userDetails.getUserId() ) + "\r\n" +
346                                  "TICKET=" + Long.toString( systemDetails.getTicket() ) + "\r\n" +
347                                  "IDUOLX=" + Long.toString( nUserId ) + "\r\n\r\n";
348
349
350     return strFmt;
351   }
352 }
353
354 // JComVcConstants class

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags