Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
SwaggerRestDispatcherServlet	67	31	0%	12	6	0.866666786.7%	Show methods

Class SwaggerRestDispatcherServlet

Class SwaggerRestDispatcherServlet	Line # 67	Total Statements 31	% Filtered 0%	Complexity 12	Uncovered Elements 6	TOTAL Coverage 0.866666786.7%
SwaggerRestDispatcherServlet(RestIntegrationModule,EndpointDefinitionRegistry,EventBus,RestToolsModule,ComponentProvider)   SwaggerRestDispatcherServlet(RestIntegrationModule,EndpointDefinitionRegistry,EventBus,RestToolsModule,ComponentProvider)	8787	2.02	0.00%	1.01	0.00	1.0 1.0100%
SwaggerRestDispatcherServlet(RestIntegrationModule,EndpointDefinitionRegistry,EventBus,RestToolsModule)   SwaggerRestDispatcherServlet(RestIntegrationModule,EndpointDefinitionRegistry,EventBus,RestToolsModule)	9696	1.01	0.00%	1.01	1.01	0.0 0.00%
init(ServletConfig) : void   init(ServletConfig) : void	101101	7.07	0.00%	1.01	0.00	1.0 1.0100%
initApiListing() : void   initApiListing() : void	114114	4.04	0.00%	1.01	0.00	1.0 1.0100%
refreshApiListing() : void   refreshApiListing() : void	127127	3.03	0.00%	1.01	0.00	1.0 1.0100%
service(HttpServletRequest,HttpServletResponse) : void   service(HttpServletRequest,HttpServletResponse) : void	133133	4.04	0.00%	2.02	0.00	1.0 1.0100%
destroy() : void   destroy() : void	144144	4.04	0.00%	2.02	1.01	0.8333333 0.833333383.3%
onEndpointRegistered(EndpointDefinitionRegistryEvent) : void   onEndpointRegistered(EndpointDefinitionRegistryEvent) : void	153153	2.02	0.00%	1.01	0.00	1.0 1.0100%
onEndpointReregistered(EndpointDefinitionRegistryEvent) : void   onEndpointReregistered(EndpointDefinitionRegistryEvent) : void	159159	2.02	0.00%	1.01	0.00	1.0 1.0100%
onEndpointUnregistered(EndpointDefinitionRegistryEvent) : void   onEndpointUnregistered(EndpointDefinitionRegistryEvent) : void	165165	2.02	0.00%	1.01	2.02	0.0 0.00%

 

Contributing tests

Contributing tests

Select all

	Test contribution	Test	Result	Actions
	0.4888889	info.magnolia.rest.tools.SwaggerRestDispatcherServletTest.handleStaleSwaggerInServletContextinfo.magnolia.rest.tools.SwaggerRestDispatcherServletTest.handleStaleSwaggerInServletContext	1PASS

 

Source view

1		/**
2		* This file Copyright (c) 2013-2017 Magnolia International
3		* Ltd. (http://www.magnolia-cms.com). All rights reserved.
4		*
5		*
6		* This file is dual-licensed under both the Magnolia
7		* Network Agreement and the GNU General Public License.
8		* You may elect to use one or the other of these licenses.
9		*
10		* This file is distributed in the hope that it will be
11		* useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12		* implied warranty of MERCHANTABILITY or FITNESS FOR A
13		* PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14		* Redistribution, except as permitted by whichever of the GPL
15		* or MNA you select, is prohibited.
16		*
17		* 1. For the GPL license (GPL), you can redistribute and/or
18		* modify this file under the terms of the GNU General
19		* Public License, Version 3, as published by the Free Software
20		* Foundation. You should have received a copy of the GNU
21		* General Public License, Version 3 along with this program;
22		* if not, write to the Free Software Foundation, Inc., 51
23		* Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24		*
25		* 2. For the Magnolia Network Agreement (MNA), this file
26		* and the accompanying materials are made available under the
27		* terms of the MNA which accompanies this distribution, and
28		* is available at http://www.magnolia-cms.com/mna.html
29		*
30		* Any modifications to this file must keep this entire header
31		* intact.
32		*
33		*/
34		package info.magnolia.rest.tools;
35
36		import info.magnolia.cms.util.CustomServletConfig;
37		import info.magnolia.context.MgnlContext;
38		import info.magnolia.event.EventBus;
39		import info.magnolia.event.SystemEventBus;
40		import info.magnolia.objectfactory.ComponentProvider;
41		import info.magnolia.objectfactory.Components;
42		import info.magnolia.rest.RestDispatcherServlet;
43		import info.magnolia.rest.RestIntegrationModule;
44		import info.magnolia.rest.registry.ConfiguredEndpointDefinition;
45		import info.magnolia.rest.registry.EndpointDefinitionRegistry;
46		import info.magnolia.rest.registry.EndpointDefinitionRegistryEvent;
47
48		import java.io.IOException;
49		import java.util.HashMap;
50
51		import javax.inject.Inject;
52		import javax.inject.Named;
53		import javax.servlet.ServletConfig;
54		import javax.servlet.ServletException;
55		import javax.servlet.http.HttpServletRequest;
56		import javax.servlet.http.HttpServletResponse;
57
58		import io.swagger.jaxrs.config.DefaultJaxrsConfig;
59		import io.swagger.jaxrs.listing.ApiListingResource;
60
61		/**
62		* API-aware dispatcher of the rest requests to the dynamically registered endpoints.
63		*
64		* Additional providers needed for the API documentation are loaded in {@link info.magnolia.rest.RestDispatcherServlet}.
65		* More providers can be loaded by adding them to the configuration of {@link info.magnolia.rest.RestIntegrationModule}.
66		*/
		86.7% Uncovered Elements: 6 (45) Complexity: 12 Complexity Density: 0.39
67		public class SwaggerRestDispatcherServlet extends RestDispatcherServlet {
68
69		private final static String PARAMETER_API_VERSION = "api.version";
70		private final static String PARAMETER_API_BASEPATH = "swagger.api.basepath";
71		private static final String ENDPOINT_NAME = "api-listing-resource-json";
72		/**
73		* Key of object in servlet context where swagger caches data.
74		*/
75		static final String SWAGGER = "swagger";
76
77		private final RestToolsModule restToolsModule;
78		private DefaultJaxrsConfig config;
79		/**
80		* Indicates that endpoint definitions have changed. Swagger caches some information in the servlet context
81		* (see {@link ApiListingResource}), which we can only access (and flush) during a request. However, since notifications
82		* about changed endpoint definitions arrive independently of requests, we use this flag to keep track of 'staleness'
83		* and flush on the next request we encounter.
84		*/
85		private boolean swaggerCacheIsStale = false;
86
		100% Uncovered Elements: 0 (2) Complexity: 1 Complexity Density: 0.5
87	1	@Inject...
88		public SwaggerRestDispatcherServlet(final RestIntegrationModule restIntegrationModule, final EndpointDefinitionRegistry endpointDefinitionRegistry, @Named(SystemEventBus.NAME) EventBus systemEventBus, final RestToolsModule restToolsModule, ComponentProvider componentProvider) {
89	1	super(restIntegrationModule, endpointDefinitionRegistry, systemEventBus, componentProvider);
90	1	this.restToolsModule = restToolsModule;
91		}
92
93		/**
94		* @deprecated since 2.0 – use {@link SwaggerRestDispatcherServlet#SwaggerRestDispatcherServlet(RestIntegrationModule, EndpointDefinitionRegistry, EventBus, RestToolsModule, ComponentProvider)} instead.
95		*/
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
96	0	@Deprecated...
97		public SwaggerRestDispatcherServlet(final RestIntegrationModule restIntegrationModule, final EndpointDefinitionRegistry endpointDefinitionRegistry, @Named(SystemEventBus.NAME) EventBus systemEventBus, final RestToolsModule restToolsModule) {
98	0	this(restIntegrationModule, endpointDefinitionRegistry, systemEventBus, restToolsModule, Components.getComponentProvider());
99		}
100
		100% Uncovered Elements: 0 (7) Complexity: 1 Complexity Density: 0.14
101	1	@Override...
102		public void init(ServletConfig servletConfig) throws ServletException {
103	1	super.init(servletConfig);
104
105	1	initApiListing();
106
107	1	config = new DefaultJaxrsConfig();
108	1	HashMap<String, String> initParameters = new HashMap<String, String>();
109	1	initParameters.put(PARAMETER_API_VERSION, restToolsModule.getApiVersion());
110	1	initParameters.put(PARAMETER_API_BASEPATH, restToolsModule.getApiBasepath());
111	1	config.init(new CustomServletConfig("DefaultJaxrsConfig", super.getServletContext(), initParameters));
112		}
113
		100% Uncovered Elements: 0 (4) Complexity: 1 Complexity Density: 0.25
114	3	private void initApiListing() {...
115		// Register API listing resource
116	3	ConfiguredEndpointDefinition endpointDefinition = new ConfiguredEndpointDefinition();
117	3	endpointDefinition.setImplementationClass(ApiListingResource.class);
118	3	endpointDefinition.setName(ENDPOINT_NAME);
119	3	super.registerEndpoint(endpointDefinition);
120		}
121
122		/**
123		* Refresh doc listings after changes in endpoint config.
124		* In particular, un- and re-register the doc endpoint to create new instances in order to get rid of internal cachings,
125		* like in {@link ApiListingResource}. Then set a flag to flush additional cached data in servlet context on next opportunity.
126		*/
		100% Uncovered Elements: 0 (3) Complexity: 1 Complexity Density: 0.33
127	2	private void refreshApiListing() {...
128	2	unregisterEndpoint(ENDPOINT_NAME);
129	2	initApiListing();
130	2	swaggerCacheIsStale = true;
131		}
132
		100% Uncovered Elements: 0 (6) Complexity: 2 Complexity Density: 0.5
133	3	@Override...
134		protected void service(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) throws ServletException, IOException {
135		// Swagger caches data in context -> hack it away. Sometimes you gotta turn your swag off.
136	3	if (swaggerCacheIsStale) {
137	2	MgnlContext.getWebContext().getServletContext().removeAttribute(SWAGGER);
138	2	swaggerCacheIsStale = false;
139		}
140
141	3	super.service(httpServletRequest, httpServletResponse);
142		}
143
		83.3% Uncovered Elements: 1 (6) Complexity: 2 Complexity Density: 0.5
144	1	@Override...
145		public void destroy() {
146	1	unregisterEndpoint(ENDPOINT_NAME);
147	1	super.destroy();
148	1	if (config != null) {
149	1	config.destroy();
150		}
151		}
152
		100% Uncovered Elements: 0 (2) Complexity: 1 Complexity Density: 0.5
153	1	@Override...
154		public void onEndpointRegistered(EndpointDefinitionRegistryEvent event) {
155	1	super.onEndpointRegistered(event);
156	1	refreshApiListing();
157		}
158
		100% Uncovered Elements: 0 (2) Complexity: 1 Complexity Density: 0.5
159	1	@Override...
160		public void onEndpointReregistered(EndpointDefinitionRegistryEvent event) {
161	1	super.onEndpointReregistered(event);
162	1	refreshApiListing();
163		}
164
		0% Uncovered Elements: 2 (2) Complexity: 1 Complexity Density: 0.5
165	0	@Override...
166		public void onEndpointUnregistered(EndpointDefinitionRegistryEvent event) {
167	0	super.onEndpointUnregistered(event);
168	0	refreshApiListing();
169		}
170		}