1 // ========================================================================
2 // Copyright (c) 2004-2009 Mort Bay Consulting Pty. Ltd.
3 // ------------------------------------------------------------------------
4 // All rights reserved. This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v1.0
6 // and Apache License v2.0 which accompanies this distribution.
7 // The Eclipse Public License is available at
8 // http://www.eclipse.org/legal/epl-v10.html
9 // The Apache License v2.0 is available at
10 // http://www.opensource.org/licenses/apache2.0.php
11 // You may elect to redistribute this code under either of these licenses.
12 // ========================================================================
13
14 package org.eclipse.jetty.testing;
15
16 import java.net.InetAddress;
17 import java.util.Enumeration;
18 import java.util.EventListener;
19
20 import org.eclipse.jetty.io.ByteArrayBuffer;
21 import org.eclipse.jetty.server.LocalConnector;
22 import org.eclipse.jetty.server.Server;
23 import org.eclipse.jetty.server.bio.SocketConnector;
24 import org.eclipse.jetty.server.nio.SelectChannelConnector;
25 import org.eclipse.jetty.servlet.FilterHolder;
26 import org.eclipse.jetty.servlet.ServletContextHandler;
27 import org.eclipse.jetty.servlet.ServletHolder;
28 import org.eclipse.jetty.util.Attributes;
29
30
31
32 /* ------------------------------------------------------------ */
33 /** Testing support for servlets and filters.
34 *
35 * Allows a programatic setup of a context with servlets and filters for
36 * testing. Raw HTTP requests may be sent to the context and responses received.
37 * To avoid handling raw HTTP see {@link org.eclipse.jetty.testing.HttpTester}.
38 * <pre>
39 * ServletTester tester=new ServletTester();
40 * tester.setContextPath("/context");
41 * tester.addServlet(TestServlet.class, "/servlet/*");
42 * tester.addServlet("org.eclipse.jetty.servlet.DefaultServlet", "/");
43 * tester.start();
44 * String response = tester.getResponses("GET /context/servlet/info HTTP/1.0\r\n\r\n");
45 * </pre>
46 *
47 * @see org.eclipse.jetty.testing.HttpTester
48 *
49 *
50 */
51 public class ServletTester
52 {
53 Server _server = new Server();
54 LocalConnector _connector = new LocalConnector();
55 // Context _context = new Context(Context.SESSIONS|Context.SECURITY);
56 //jaspi why security if it is not set up?
57 ServletContextHandler _context = new ServletContextHandler(ServletContextHandler.SESSIONS);
58
59 public ServletTester()
60 {
61 try
62 {
63 _server.setSendServerVersion(false);
64 _server.addConnector(_connector);
65 _server.setHandler(_context);
66 }
67 catch (Error e)
68 {
69 throw e;
70 }
71 catch (RuntimeException e)
72 {
73 throw e;
74 }
75 catch (Exception e)
76 {
77 throw new RuntimeException(e);
78 }
79 }
80
81 /* ------------------------------------------------------------ */
82 public void start() throws Exception
83 {
84 _server.start();
85 }
86
87 /* ------------------------------------------------------------ */
88 public void stop() throws Exception
89 {
90 _server.stop();
91 }
92
93 /* ------------------------------------------------------------ */
94 public ServletContextHandler getContext()
95 {
96 return _context;
97 }
98
99 /* ------------------------------------------------------------ */
100 /** Get raw HTTP responses from raw HTTP requests.
101 * Multiple requests and responses may be handled, but only if
102 * persistent connections conditions apply.
103 * @param rawRequests String of raw HTTP requests
104 * @return String of raw HTTP responses
105 * @throws Exception
106 */
107 public String getResponses(String rawRequests) throws Exception
108 {
109 return _connector.getResponses(rawRequests);
110 }
111
112 /* ------------------------------------------------------------ */
113 /** Get raw HTTP responses from raw HTTP requests.
114 * Multiple requests and responses may be handled, but only if
115 * persistent connections conditions apply.
116 * @param rawRequests String of raw HTTP requests
117 * @param connector The connector to handle the responses
118 * @return String of raw HTTP responses
119 * @throws Exception
120 */
121 public String getResponses(String rawRequests, LocalConnector connector) throws Exception
122 {
123 return connector.getResponses(rawRequests);
124 }
125
126 /* ------------------------------------------------------------ */
127 /** Get raw HTTP responses from raw HTTP requests.
128 * Multiple requests and responses may be handled, but only if
129 * persistent connections conditions apply.
130 * @param rawRequests String of raw HTTP requests
131 * @return String of raw HTTP responses
132 * @throws Exception
133 */
134 public ByteArrayBuffer getResponses(ByteArrayBuffer rawRequests) throws Exception
135 {
136 return _connector.getResponses(rawRequests,false);
137 }
138
139 /* ------------------------------------------------------------ */
140 /** Create a Socket connector.
141 * This methods adds a socket connector to the server
142 * @param locahost if true, only listen on local host, else listen on all interfaces.
143 * @return A URL to access the server via the socket connector.
144 * @throws Exception
145 */
146 public String createSocketConnector(boolean localhost)
147 throws Exception
148 {
149 synchronized (this)
150 {
151 SocketConnector connector = new SocketConnector();
152 if (localhost)
153 connector.setHost("127.0.0.1");
154 _server.addConnector(connector);
155 if (_server.isStarted())
156 connector.start();
157 else
158 connector.open();
159
160 return "http://127.0.0.1:"+connector.getLocalPort();
161 }
162 }
163
164 /* ------------------------------------------------------------ */
165 /** Create a SelectChannel connector.
166 * This methods adds a select channel connector to the server
167 * @return A URL to access the server via the connector.
168 * @throws Exception
169 */
170 public String createChannelConnector(boolean localhost)
171 throws Exception
172 {
173 synchronized (this)
174 {
175 SelectChannelConnector connector = new SelectChannelConnector();
176 if (localhost)
177 connector.setHost("127.0.0.1");
178 _server.addConnector(connector);
179 if (_server.isStarted())
180 connector.start();
181 else
182 connector.open();
183
184 return "http://"+(localhost?"127.0.0.1":
185 InetAddress.getLocalHost().getHostAddress()
186 )+":"+connector.getLocalPort();
187 }
188 }
189
190 /* ------------------------------------------------------------ */
191 /** Create a local connector.
192 * This methods adds a local connector to the server
193 * @return The LocalConnector object
194 * @throws Exception
195 */
196 public LocalConnector createLocalConnector()
197 throws Exception
198 {
199 synchronized (this)
200 {
201 LocalConnector connector = new LocalConnector();
202 _server.addConnector(connector);
203
204 if (_server.isStarted())
205 connector.start();
206
207 return connector;
208 }
209 }
210
211 /* ------------------------------------------------------------ */
212 /**
213 * @param listener
214 * @see org.eclipse.jetty.handler.ContextHandler#addEventListener(java.util.EventListener)
215 */
216 public void addEventListener(EventListener listener)
217 {
218 _context.addEventListener(listener);
219 }
220
221 /* ------------------------------------------------------------ */
222 /**
223 * @param filterClass
224 * @param pathSpec
225 * @param dispatches
226 * @return
227 * @see org.eclipse.jetty.servlet.Scope#addFilter(java.lang.Class, java.lang.String, int)
228 */
229 public FilterHolder addFilter(Class filterClass, String pathSpec, int dispatches)
230 {
231 return _context.addFilter(filterClass,pathSpec,dispatches);
232 }
233
234 /* ------------------------------------------------------------ */
235 /**
236 * @param filterClass
237 * @param pathSpec
238 * @param dispatches
239 * @return
240 * @see org.eclipse.jetty.servlet.Scope#addFilter(java.lang.String, java.lang.String, int)
241 */
242 public FilterHolder addFilter(String filterClass, String pathSpec, int dispatches)
243 {
244 return _context.addFilter(filterClass,pathSpec,dispatches);
245 }
246
247 /* ------------------------------------------------------------ */
248 /**
249 * @param servlet
250 * @param pathSpec
251 * @return
252 * @see org.eclipse.jetty.servlet.Scope#addServlet(java.lang.Class, java.lang.String)
253 */
254 public ServletHolder addServlet(Class servlet, String pathSpec)
255 {
256 return _context.addServlet(servlet,pathSpec);
257 }
258
259 /* ------------------------------------------------------------ */
260 /**
261 * @param className
262 * @param pathSpec
263 * @return
264 * @see org.eclipse.jetty.servlet.Scope#addServlet(java.lang.String, java.lang.String)
265 */
266 public ServletHolder addServlet(String className, String pathSpec)
267 {
268 return _context.addServlet(className,pathSpec);
269 }
270
271 /* ------------------------------------------------------------ */
272 /**
273 * @param name
274 * @return
275 * @see org.eclipse.jetty.handler.ContextHandler#getAttribute(java.lang.String)
276 */
277 public Object getAttribute(String name)
278 {
279 return _context.getAttribute(name);
280 }
281
282 /* ------------------------------------------------------------ */
283 /**
284 * @return
285 * @see org.eclipse.jetty.handler.ContextHandler#getAttributeNames()
286 */
287 public Enumeration getAttributeNames()
288 {
289 return _context.getAttributeNames();
290 }
291
292 /* ------------------------------------------------------------ */
293 /**
294 * @return
295 * @see org.eclipse.jetty.handler.ContextHandler#getAttributes()
296 */
297 public Attributes getAttributes()
298 {
299 return _context.getAttributes();
300 }
301
302 /* ------------------------------------------------------------ */
303 /**
304 * @return
305 * @see org.eclipse.jetty.handler.ContextHandler#getResourceBase()
306 */
307 public String getResourceBase()
308 {
309 return _context.getResourceBase();
310 }
311
312 /* ------------------------------------------------------------ */
313 /**
314 * @param name
315 * @param value
316 * @see org.eclipse.jetty.handler.ContextHandler#setAttribute(java.lang.String, java.lang.Object)
317 */
318 public void setAttribute(String name, Object value)
319 {
320 _context.setAttribute(name,value);
321 }
322
323 /* ------------------------------------------------------------ */
324 /**
325 * @param classLoader
326 * @see org.eclipse.jetty.handler.ContextHandler#setClassLoader(java.lang.ClassLoader)
327 */
328 public void setClassLoader(ClassLoader classLoader)
329 {
330 _context.setClassLoader(classLoader);
331 }
332
333 /* ------------------------------------------------------------ */
334 /**
335 * @param contextPath
336 * @see org.eclipse.jetty.handler.ContextHandler#setContextPath(java.lang.String)
337 */
338 public void setContextPath(String contextPath)
339 {
340 _context.setContextPath(contextPath);
341 }
342
343 /* ------------------------------------------------------------ */
344 /**
345 * @param eventListeners
346 * @see org.eclipse.jetty.handler.ContextHandler#setEventListeners(java.util.EventListener[])
347 */
348 public void setEventListeners(EventListener[] eventListeners)
349 {
350 _context.setEventListeners(eventListeners);
351 }
352
353 /* ------------------------------------------------------------ */
354 /**
355 * @param resourceBase
356 * @see org.eclipse.jetty.handler.ContextHandler#setResourceBase(java.lang.String)
357 */
358 public void setResourceBase(String resourceBase)
359 {
360 _context.setResourceBase(resourceBase);
361 }
362
363 }