policy-endpoints/src/main/java/org/onap/policy/drools/http/server/internal/JettyJerseyServer.java

   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 package org.onap.policy.drools.http.server.internal;
  21
  22 import java.net.InetAddress;
  23 import java.net.UnknownHostException;
  24 import java.util.HashMap;
  25
  26 import org.eclipse.jetty.servlet.ServletHolder;
  27 import org.onap.policy.drools.utils.NetworkUtil;
  28 import org.slf4j.LoggerFactory;
  29 import org.slf4j.Logger;
  30
  31 import io.swagger.jersey.config.JerseyJaxrsConfig;
  32
  33 /**
  34  * REST Jetty Server that uses Jersey Servlets to support JAX-RS Web Services
  35  */
  36 public class JettyJerseyServer extends JettyServletServer {
  37
  38         /**
  39          * Swagger API Base Path
  40          */
  41         protected static final String SWAGGER_API_BASEPATH = "swagger.api.basepath";
  42
  43         /**
  44          * Swagger Context ID
  45          */
  46         protected static final String SWAGGER_CONTEXT_ID = "swagger.context.id";
  47
  48         /**
  49          * Swagger Scanner ID
  50          */
  51         protected static final String SWAGGER_SCANNER_ID = "swagger.scanner.id";
  52
  53         /**
  54          * Swagger Pretty Print
  55          */
  56         protected static final String SWAGGER_PRETTY_PRINT = "swagger.pretty.print";
  57
  58         /**
  59          * Swagger Packages
  60          */
  61         protected static final String SWAGGER_INIT_PACKAGES_PARAM_VALUE = "io.swagger.jaxrs.listing";
  62
  63         /**
  64          * Jersey Packages Init Param Name
  65          */
  66         protected static final String JERSEY_INIT_PACKAGES_PARAM_NAME = "jersey.config.server.provider.packages";
  67
  68         /**
  69          * Jersey Packages Init Param Value
  70          */
  71         protected static final String JERSEY_INIT_PACKAGES_PARAM_VALUE = "com.fasterxml.jackson.jaxrs.json";
  72
  73         /**
  74          * Jersey Classes Init Param Name
  75          */
  76         protected static final String JERSEY_INIT_CLASSNAMES_PARAM_NAME = "jersey.config.server.provider.classnames";
  77
  78         /**
  79          * Jersey Jackson Classes Init Param Value
  80          */
  81         protected static final String JERSEY_JACKSON_INIT_CLASSNAMES_PARAM_VALUE = "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 = "io.swagger.jaxrs.listing.ApiListingResource," +
  87                                                                                                                                         "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          * retrieves cached server based on servlet path
 148          *
 149          * @param servletPath servlet path
 150          * @return the jetty servlet holder
 151          *
 152          * @throws IllegalArgumentException if invalid arguments are provided
 153          */
 154         protected synchronized ServletHolder getServlet(String servletPath) {
 155
 156                 ServletHolder jerseyServlet = servlets.get(servletPath);
 157                 if (jerseyServlet == null) {
 158                         jerseyServlet = context.addServlet
 159                         (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         if (servPath == null || servPath.isEmpty())
 174             servPath = "/*";
 175
 176                 ServletHolder jerseyServlet = this.getServlet(servPath);
 177
 178                 String initClasses =
 179                                 jerseyServlet.getInitParameter(JERSEY_INIT_CLASSNAMES_PARAM_NAME);
 180                 if (initClasses != null && !initClasses.isEmpty())
 181                         logger.warn("Both packages and classes are used in Jetty+Jersey Configuration: {}", restPackage);
 182
 183                 String initPackages =
 184                                 jerseyServlet.getInitParameter(JERSEY_INIT_PACKAGES_PARAM_NAME);
 185                 if (initPackages == null) {
 186                         if (this.swaggerId != null) {
 187                                 initPackages = JERSEY_INIT_PACKAGES_PARAM_VALUE + "," +
 188                                                SWAGGER_INIT_PACKAGES_PARAM_VALUE + "," +
 189                                                        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 + "," +
 195                                                restPackage;
 196                         }
 197                 } else {
 198                         initPackages = initPackages + "," + restPackage;
 199                 }
 200
 201         jerseyServlet.setInitParameter(JERSEY_INIT_PACKAGES_PARAM_NAME,  initPackages);
 202
 203         if (logger.isDebugEnabled())
 204                 logger.debug("{}: added REST package: {}", this, jerseyServlet.dump());
 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         if (servletPath == null || servletPath.isEmpty())
 214                 servletPath = "/*";
 215
 216                 ServletHolder jerseyServlet = this.getServlet(servletPath);
 217
 218                 String initPackages =
 219                                 jerseyServlet.getInitParameter(JERSEY_INIT_PACKAGES_PARAM_NAME);
 220                 if (initPackages != null && !initPackages.isEmpty())
 221                         logger.warn("Both classes and packages are used in Jetty+Jersey Configuration: {}", restClass);
 222
 223                 String initClasses =
 224                                 jerseyServlet.getInitParameter(JERSEY_INIT_CLASSNAMES_PARAM_NAME);
 225                 if (initClasses == null) {
 226                         if (this.swaggerId != null) {
 227                                 initClasses = JERSEY_JACKSON_INIT_CLASSNAMES_PARAM_VALUE + "," +
 228                                                       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         @Override
 247         public String toString() {
 248                 StringBuilder builder = new StringBuilder();
 249                 builder.append("JettyJerseyServer [servlets=").append(servlets).append(", swaggerId=").append(swaggerId)
 250                                 .append(", toString()=").append(super.toString()).append("]");
 251                 return builder.toString();
 252         }
 253 }