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

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