Classes

Class	Line #	Total Statements	Complexity	TOTAL Coverage	Actions
AbstractRequestHandler	39	25	11	0.00%	Show methods

Class AbstractRequestHandler

Class AbstractRequestHandler	Line # 39	Total Statements 25	Complexity 11	TOTAL Coverage 0.00%
handle(String,Request,HttpServletRequest,HttpServletResponse) : void   handle(String,Request,HttpServletRequest,HttpServletResponse) : void	5656	8.08	3.03	0.0 0.00%
dumpRequest(HttpServletRequest) : void   dumpRequest(HttpServletRequest) : void	106106	8.08	1.01	0.0 0.00%
shutdown() : void   shutdown() : void	138138	4.04	2.02	0.0 0.00%
getUri() : String   getUri() : String	156156	1.01	1.01	0.0 0.00%
setUri(String) : void   setUri(String) : void	166166	1.01	1.01	0.0 0.00%
setPath(String) : void   setPath(String) : void	177177	1.01	1.01	0.0 0.00%
getPath() : String   getPath() : String	188188	1.01	1.01	0.0 0.00%
registerHandler() : void   registerHandler() : void	201201	1.01	1.01	0.0 0.00%

 

Contributing tests

Source view

1		/*
2		* Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3		* Copyright (C) $$Year-Rel$$ The Jalview Authors
4		*
5		* This file is part of Jalview.
6		*
7		* Jalview is free software: you can redistribute it and/or
8		* modify it under the terms of the GNU General Public License
9		* as published by the Free Software Foundation, either version 3
10		* of the License, or (at your option) any later version.
11		*
12		* Jalview is distributed in the hope that it will be useful, but
13		* WITHOUT ANY WARRANTY; without even the implied warranty
14		* of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15		* PURPOSE. See the GNU General Public License for more details.
16		*
17		* You should have received a copy of the GNU General Public License
18		* along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19		* The Jalview Authors are detailed in the 'AUTHORS' file.
20		*/
21		package jalview.httpserver;
22
23		import java.io.IOException;
24		import java.net.BindException;
25		import java.util.Collections;
26
27		import javax.servlet.ServletException;
28		import javax.servlet.http.HttpServletRequest;
29		import javax.servlet.http.HttpServletResponse;
30
31		import org.eclipse.jetty.server.Request;
32		import org.eclipse.jetty.server.handler.AbstractHandler;
33
34		/**
35		*
36		* @author gmcarstairs
37		*
38		*/
		0% Uncovered Elements: 35 (35) Complexity: 11 Complexity Density: 0.44
39		public abstract class AbstractRequestHandler extends AbstractHandler
40		{
41
42		/*
43		* The relative path (below context root) of this handler (without /
44		* separators)
45		*/
46		private String path;
47
48		/*
49		* The full URI on which this handler listens
50		*/
51		private String uri;
52
53		/**
54		* Handle an incoming Http request.
55		*/
		0% Uncovered Elements: 10 (10) Complexity: 3 Complexity Density: 0.38
56	0	@Override...
57		public void handle(String target, Request baseRequest,
58		HttpServletRequest request, HttpServletResponse response)
59		throws IOException, ServletException
60		{
61	0	try
62		{
63		// dumpRequest(request); // debug
64	0	processRequest(request, response);
65		} catch (Throwable t)
66		{
67		/*
68		* Set server error status on response
69		*/
70	0	jalview.bin.Console.errPrintln("Exception handling request "
71		+ request.getRequestURI() + " : " + t.getMessage());
72	0	if (response.isCommitted())
73		{
74		/*
75		* Can't write an HTTP header once any response content has been written
76		*/
77	0	jalview.bin.Console.errPrintln(
78		"Unable to return HTTP 500 as response already committed");
79		}
80		else
81		{
82	0	response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
83		}
84		} finally
85		{
86	0	response.getWriter().flush();
87	0	baseRequest.setHandled(true);
88		}
89		}
90
91		/**
92		* Subclasses should override this method to perform request processing
93		*
94		* @param request
95		* @param response
96		* @throws IOException
97		*/
98		protected abstract void processRequest(HttpServletRequest request,
99		HttpServletResponse response) throws IOException;
100
101		/**
102		* For debug - writes HTTP request details to stdout
103		*
104		* @param request
105		*/
		0% Uncovered Elements: 8 (8) Complexity: 1 Complexity Density: 0.12
106	0	protected void dumpRequest(HttpServletRequest request)...
107		{
108	0	jalview.bin.Console.outPrintln(request.getMethod());
109	0	jalview.bin.Console.outPrintln(request.getRequestURL());
110	0	for (String hdr : Collections.list(request.getHeaderNames()))
111		{
112	0	for (String val : Collections.list(request.getHeaders(hdr)))
113		{
114	0	jalview.bin.Console.outPrintln(hdr + ": " + val);
115		}
116		}
117	0	for (String param : Collections.list(request.getParameterNames()))
118		{
119	0	for (String val : request.getParameterValues(param))
120		{
121	0	jalview.bin.Console.outPrintln(param + "=" + val);
122		}
123		}
124		}
125
126		/**
127		* Returns a display name for the handler
128		*
129		* @return
130		*/
131		public abstract String getName();
132
133		/**
134		* Deregister this listener and close it down
135		*
136		* @throws Exception
137		*/
		0% Uncovered Elements: 4 (4) Complexity: 2 Complexity Density: 0.5
138	0	public void shutdown()...
139		{
140	0	try
141		{
142	0	HttpServer.getInstance().removeHandler(this);
143	0	stop();
144		} catch (Exception e)
145		{
146	0	jalview.bin.Console.errPrintln(
147		"Error stopping " + getName() + ": " + e.getMessage());
148		}
149		}
150
151		/**
152		* Returns the URI on which we are listening
153		*
154		* @return
155		*/
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
156	0	public String getUri()...
157		{
158	0	return this.uri;
159		}
160
161		/**
162		* Set the URI to this handler
163		*
164		* @param u
165		*/
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
166	0	protected void setUri(String u)...
167		{
168	0	this.uri = u;
169		}
170
171		/**
172		* Sets the relative path to this handler - do this before registering the
173		* handler.
174		*
175		* @param p
176		*/
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
177	0	protected void setPath(String p)...
178		{
179	0	this.path = p;
180		}
181
182		/**
183		* Returns the relative path to this handler below the context root (without /
184		* separators)
185		*
186		* @return
187		*/
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
188	0	public String getPath()...
189		{
190	0	return this.path;
191		}
192
193		/**
194		* Registers the handler with the HttpServer and reports its URI on stdout
195		*
196		* @throws BindException
197		* if no port could be allocated
198		* @throws IllegalStateException
199		* if this method is called before {@link #setPath}
200		*/
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
201	0	protected void registerHandler() throws BindException...
202		{
203	0	HttpServer.getInstance().registerHandler(this);
204		}
205		}