KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > debug > DebuggerClient


1 /*
2  * Copyright (c) 2003 The Visigoth Software Society. All rights
3  * reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowledgement:
19  * "This product includes software developed by the
20  * Visigoth Software Society (http://www.visigoths.org/)."
21  * Alternately, this acknowledgement may appear in the software itself,
22  * if and wherever such third-party acknowledgements normally appear.
23  *
24  * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
25  * project contributors may be used to endorse or promote products derived
26  * from this software without prior written permission. For written
27  * permission, please contact visigoths@visigoths.org.
28  *
29  * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
30  * nor may "FreeMarker" or "Visigoth" appear in their names
31  * without prior written permission of the Visigoth Software Society.
32  *
33  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
37  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44  * SUCH DAMAGE.
45  * ====================================================================
46  *
47  * This software consists of voluntary contributions made by many
48  * individuals on behalf of the Visigoth Software Society. For more
49  * information on the Visigoth Software Society, please see
50  * http://www.visigoths.org/
51  */
52
53 package freemarker.debug;
54
55 import java.io.IOException JavaDoc;
56 import java.io.ObjectInputStream JavaDoc;
57 import java.io.ObjectOutputStream JavaDoc;
58 import java.net.InetAddress JavaDoc;
59 import java.net.Socket JavaDoc;
60 import java.security.MessageDigest JavaDoc;
61
62 import freemarker.template.utility.UndeclaredThrowableException;
63
64 /**
65  * A utility class that allows you to connect to the FreeMarker debugger service
66  * running on a specific host and port.
67  * @author Attila Szegedi
68  * @version $Id: DebuggerClient.java,v 1.3 2003/06/08 00:58:16 herbyderby Exp $
69  */
70 public class DebuggerClient
71 {
72     private DebuggerClient()
73     {
74     }
75     
76     /**
77      * Connects to the FreeMarker debugger service running on a specific host
78      * and port. The Java VM to which the connection is made must have defined
79      * the system property <tt>freemarker.debug.password</tt> in order to enable
80      * the debugger service. Additionally, the <tt>freemarker.debug.port</tt>
81      * system property can be set to specify the port where the debugger service
82      * is listening. When not specified, it defaults to
83      * {@link Debugger#DEFAULT_PORT}.
84      * @param host the host address of the machine where the debugger service is
85      * running.
86      * @param port the port of the debugger service
87      * @param password the password required to connect to the debugger service
88      * @return Debugger a debugger object. null is returned in case incorrect
89      * password was supplied.
90      * @throws IOException if an exception occurs.
91      */
92     public static Debugger getDebugger(InetAddress JavaDoc host, int port, String JavaDoc password)
93     throws
94         IOException JavaDoc
95     {
96         try
97         {
98             Socket JavaDoc s = new Socket JavaDoc(host, port);
99             try
100             {
101                 ObjectOutputStream JavaDoc out = new ObjectOutputStream JavaDoc(s.getOutputStream());
102                 ObjectInputStream JavaDoc in = new ObjectInputStream JavaDoc(s.getInputStream());
103                 int protocolVersion = in.readInt();
104                 if(protocolVersion > 220)
105                 {
106                     throw new IOException JavaDoc(
107                         "Incompatible protocol version " + protocolVersion +
108                         ". At most 220 was expected.");
109                 }
110                 byte[] challenge = (byte[])in.readObject();
111                 MessageDigest JavaDoc md = MessageDigest.getInstance("SHA");
112                 md.update(password.getBytes("UTF-8"));
113                 md.update(challenge);
114                 out.writeObject(md.digest());
115                 return (Debugger)in.readObject();
116             }
117             finally
118             {
119                 s.close();
120             }
121         }
122         catch(IOException JavaDoc e)
123         {
124             throw e;
125         }
126         catch(Exception JavaDoc e)
127         {
128             throw new UndeclaredThrowableException(e);
129         }
130     }
131 }
132
Popular Tags