gerrit.onap Code Review - policy/common.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * policy-endpoints
   4  * ================================================================================
   5  * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2019-2020 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.common.endpoints.http.server.internal;
  23
  24 import io.swagger.jersey.config.JerseyJaxrsConfig;
  25 import java.util.HashMap;
  26 import java.util.Map;
  27 import org.apache.commons.lang3.StringUtils;
  28 import org.eclipse.jetty.servlet.ServletHolder;
  29 import org.glassfish.jersey.server.ServerProperties;
  30 import org.onap.policy.common.utils.network.NetworkUtil;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 /**
  35  * REST Jetty Server that uses Jersey Servlets to support JAX-RS Web Services.
  36  *
  37  * <p>Note: the serialization provider will always be added to the server's class providers, as will the swagger
  38  * providers (assuming swagger has been enabled). This happens whether {@link #addServletClass(String, String)} is used
  39  * or {@link #addServletPackage(String, String)} is used. Thus it's possible to have both the server's class provider
  40  * property and the server's package provider property populated.
  41  */
  42 public class JettyJerseyServer extends JettyServletServer {
  43
  44     /**
  45      * Swagger API Base Path.
  46      */
  47     protected static final String SWAGGER_API_BASEPATH = "swagger.api.basepath";
  48
  49     /**
  50      * Swagger Context ID.
  51      */
  52     protected static final String SWAGGER_CONTEXT_ID = "swagger.context.id";
  53
  54     /**
  55      * Swagger Scanner ID.
  56      */
  57     protected static final String SWAGGER_SCANNER_ID = "swagger.scanner.id";
  58
  59     /**
  60      * Swagger Pretty Print.
  61      */
  62     protected static final String SWAGGER_PRETTY_PRINT = "swagger.pretty.print";
  63
  64     /**
  65      * Jersey Jackson Classes Init Param Value.
  66      */
  67     protected static final String JERSEY_JACKSON_INIT_CLASSNAMES_PARAM_VALUE =
  68             "org.glassfish.jersey.jackson.internal.jackson.jaxrs.json.JacksonJsonProvider";
  69
  70     /**
  71      * Jersey Swagger Classes Init Param Value.
  72      */
  73     protected static final String SWAGGER_INIT_CLASSNAMES_PARAM_VALUE =
  74             "io.swagger.jaxrs.listing.ApiListingResource," + "io.swagger.jaxrs.listing.SwaggerSerializers";
  75
  76     /**
  77      * Logger.
  78      */
  79     protected static Logger logger = LoggerFactory.getLogger(JettyJerseyServer.class);
  80
  81     /**
  82      * Container for servlets.
  83      */
  84     protected final Map<String, ServletHolder> servlets = new HashMap<>();
  85
  86     /**
  87      * Swagger ID.
  88      */
  89     protected String swaggerId = null;
  90
  91     /**
  92      * The serialization provider to be used when classes are added to the service.
  93      */
  94     private String classProvider = JERSEY_JACKSON_INIT_CLASSNAMES_PARAM_VALUE;
  95
  96     /**
  97      * Constructor.
  98      *
  99      * @param name name
 100      * @param https enable https?
 101      * @param host host server host
 102      * @param port port server port
 103      * @param swagger support swagger?
 104      * @param contextPath context path
 105      *
 106      * @throws IllegalArgumentException in invalid arguments are provided
 107      */
 108     public JettyJerseyServer(String name, boolean https, String host, int port, String contextPath, boolean swagger) {
 109
 110         super(name, https, host, port, contextPath);
 111         if (swagger) {
 112             this.swaggerId = "swagger-" + this.port;
 113             attachSwaggerServlet(https);
 114         }
 115     }
 116
 117     /**
 118      * Attaches a swagger initialization servlet.
 119      */
 120     protected void attachSwaggerServlet(boolean https) {
 121
 122         ServletHolder swaggerServlet = context.addServlet(JerseyJaxrsConfig.class, "/");
 123
 124         String hostname = this.connector.getHost();
 125         if (StringUtils.isBlank(hostname) || hostname.equals(NetworkUtil.IPV4_WILDCARD_ADDRESS)) {
 126             hostname = NetworkUtil.getHostname();
 127         }
 128
 129         swaggerServlet.setInitParameter(SWAGGER_API_BASEPATH,
 130                 ((https) ? "https://" : "http://") + hostname + ":" + this.connector.getPort() + "/");
 131         swaggerServlet.setInitParameter(SWAGGER_CONTEXT_ID, swaggerId);
 132         swaggerServlet.setInitParameter(SWAGGER_SCANNER_ID, swaggerId);
 133         swaggerServlet.setInitParameter(SWAGGER_PRETTY_PRINT, "true");
 134         swaggerServlet.setInitOrder(2);
 135
 136         if (logger.isDebugEnabled()) {
 137             logger.debug("{}: Swagger Servlet has been attached: {}", this, swaggerServlet.dump());
 138         }
 139     }
 140
 141     /**
 142      * Retrieves cached server based on servlet path.
 143      *
 144      * @param servletPath servlet path
 145      * @return the jetty servlet holder
 146      *
 147      * @throws IllegalArgumentException if invalid arguments are provided
 148      */
 149     protected synchronized ServletHolder getServlet(String servletPath) {
 150
 151         return servlets.computeIfAbsent(servletPath, key -> {
 152
 153             ServletHolder jerseyServlet =
 154                     context.addServlet(org.glassfish.jersey.servlet.ServletContainer.class, servletPath);
 155             jerseyServlet.setInitOrder(0);
 156
 157             return jerseyServlet;
 158         });
 159     }
 160
 161     @Override
 162     public synchronized void addServletPackage(String servletPath, String restPackage) {
 163         String servPath = servletPath;
 164         if (StringUtils.isBlank(restPackage)) {
 165             throw new IllegalArgumentException("No discoverable REST package provided");
 166         }
 167
 168         if (servPath == null || servPath.isEmpty()) {
 169             servPath = "/*";
 170         }
 171
 172         ServletHolder jerseyServlet = this.getServlet(servPath);
 173
 174         initStandardParams(jerseyServlet);
 175
 176         String initPackages = jerseyServlet.getInitParameter(ServerProperties.PROVIDER_PACKAGES);
 177         if (initPackages == null) {
 178             initPackages = restPackage;
 179
 180         } else {
 181             initPackages += "," + restPackage;
 182         }
 183
 184         jerseyServlet.setInitParameter(ServerProperties.PROVIDER_PACKAGES, initPackages);
 185
 186         if (logger.isDebugEnabled()) {
 187             logger.debug("{}: added REST package: {}", this, jerseyServlet.dump());
 188         }
 189     }
 190
 191     @Override
 192     public synchronized void addServletClass(String servletPath, String restClass) {
 193
 194         if (StringUtils.isBlank(restClass)) {
 195             throw new IllegalArgumentException("No discoverable REST class provided");
 196         }
 197
 198         if (servletPath == null || servletPath.isEmpty()) {
 199             servletPath = "/*";
 200         }
 201
 202         ServletHolder jerseyServlet = this.getServlet(servletPath);
 203
 204         initStandardParams(jerseyServlet);
 205
 206         String initClasses = jerseyServlet.getInitParameter(ServerProperties.PROVIDER_CLASSNAMES);
 207         if (initClasses == null) {
 208             initClasses = restClass;
 209
 210         } else {
 211             initClasses += "," + restClass;
 212         }
 213
 214         jerseyServlet.setInitParameter(ServerProperties.PROVIDER_CLASSNAMES, initClasses);
 215
 216         if (logger.isDebugEnabled()) {
 217             logger.debug("{}: added REST class: {}", this, jerseyServlet.dump());
 218         }
 219     }
 220
 221     /**
 222      * Adds "standard" parameters to the initParameter set. Sets swagger parameters, if specified, and sets the class
 223      * provider property. This can be invoked multiple times, but only the first actually causes any changes to the
 224      * parameter set.
 225      *
 226      * @param jerseyServlet servlet into which parameters should be added
 227      */
 228     private void initStandardParams(ServletHolder jerseyServlet) {
 229         String initClasses = jerseyServlet.getInitParameter(ServerProperties.PROVIDER_CLASSNAMES);
 230         if (initClasses != null) {
 231             return;
 232         }
 233
 234         initClasses = classProvider;
 235
 236         if (this.swaggerId != null) {
 237             initClasses += "," + SWAGGER_INIT_CLASSNAMES_PARAM_VALUE;
 238
 239             jerseyServlet.setInitParameter(SWAGGER_CONTEXT_ID, swaggerId);
 240             jerseyServlet.setInitParameter(SWAGGER_SCANNER_ID, swaggerId);
 241         }
 242
 243         jerseyServlet.setInitParameter(ServerProperties.PROVIDER_CLASSNAMES, initClasses);
 244
 245         jerseyServlet.setInitParameter(ServerProperties.METAINF_SERVICES_LOOKUP_DISABLE, "true");
 246     }
 247
 248     /**
 249      * Note: this must be invoked <i>before</i> {@link #addServletClass(String, String)} or
 250      * {@link #addServletPackage(String, String)}.
 251      */
 252     @Override
 253     public void setSerializationProvider(String provider) {
 254         classProvider = provider;
 255     }
 256
 257     @Override
 258     public String toString() {
 259         StringBuilder builder = new StringBuilder();
 260         builder.append("JettyJerseyServer [Jerseyservlets=").append(servlets).append(", swaggerId=").append(swaggerId)
 261                 .append(", toString()=").append(super.toString()).append("]");
 262         return builder.toString();
 263     }
 264 }