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;
  22
  23 import java.util.ArrayList;
  24 import java.util.Arrays;
  25 import java.util.HashMap;
  26 import java.util.List;
  27 import java.util.Properties;
  28
  29 import org.onap.policy.common.endpoints.http.server.internal.JettyJerseyServer;
  30 import org.onap.policy.common.endpoints.properties.PolicyEndPointProperties;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 /**
  35  * Factory of HTTP Servlet-Enabled Servlets
  36  */
  37 public interface HttpServletServerFactory {
  38
  39     /**
  40      * builds an http or https server with support for servlets
  41      *
  42      * @param name name
  43      * @param https use secured http over tls connection
  44      * @param host binding host
  45      * @param port port
  46      * @param contextPath server base path
  47      * @param swagger enable swagger documentation
  48      * @param managed is it managed by infrastructure
  49      * @return http server
  50      * @throws IllegalArgumentException when invalid parameters are provided
  51      */
  52     HttpServletServer build(String name, boolean https, String host, int port, String contextPath, boolean swagger,
  53             boolean managed);
  54
  55     /**
  56      * builds an http server with support for servlets
  57      *
  58      * @param name name
  59      * @param host binding host
  60      * @param port port
  61      * @param contextPath server base path
  62      * @param swagger enable swagger documentation
  63      * @param managed is it managed by infrastructure
  64      * @return http server
  65      * @throws IllegalArgumentException when invalid parameters are provided
  66      */
  67     HttpServletServer build(String name, String host, int port, String contextPath, boolean swagger,
  68         boolean managed);
  69
  70     /**
  71      * list of http servers per properties
  72      *
  73      * @param properties properties based configuration
  74      * @return list of http servers
  75      * @throws IllegalArgumentException when invalid parameters are provided
  76      */
  77     List<HttpServletServer> build(Properties properties);
  78
  79     /**
  80      * gets a server based on the port
  81      *
  82      * @param port port
  83      * @return http server
  84      */
  85     HttpServletServer get(int port);
  86
  87     /**
  88      * provides an inventory of servers
  89      *
  90      * @return inventory of servers
  91      */
  92     List<HttpServletServer> inventory();
  93
  94     /**
  95      * destroys server bound to a port
  96      *
  97      * @param port
  98      */
  99     void destroy(int port);
 100
 101     /**
 102      * destroys the factory and therefore all servers
 103      */
 104     void destroy();
 105 }
 106
 107
 108 /**
 109  * Indexed factory implementation
 110  */
 111 class IndexedHttpServletServerFactory implements HttpServletServerFactory {
 112
 113     private static final String SPACES_COMMA_SPACES = "\\s*,\\s*";
 114
 115     /**
 116      * logger
 117      */
 118     protected static Logger logger = LoggerFactory.getLogger(IndexedHttpServletServerFactory.class);
 119
 120     /**
 121      * servers index
 122      */
 123     protected HashMap<Integer, HttpServletServer> servers = new HashMap<>();
 124
 125     @Override
 126     public synchronized HttpServletServer build(String name, boolean https, String host, int port, String contextPath, boolean swagger,
 127             boolean managed) {
 128
 129         if (servers.containsKey(port)) {
 130             return servers.get(port);
 131         }
 132
 133         JettyJerseyServer server = new JettyJerseyServer(name, https, host, port, contextPath, swagger);
 134         if (managed) {
 135             servers.put(port, server);
 136         }
 137
 138         return server;
 139     }
 140
 141     @Override
 142     public synchronized HttpServletServer build(String name, String host, int port, String contextPath,
 143                                                 boolean swagger, boolean managed) {
 144         return build(name, false, host, port, contextPath, swagger, managed);
 145     }
 146
 147
 148     @Override
 149     public synchronized List<HttpServletServer> build(Properties properties) {
 150
 151         ArrayList<HttpServletServer> serviceList = new ArrayList<>();
 152
 153         String serviceNames = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES);
 154         if (serviceNames == null || serviceNames.isEmpty()) {
 155             logger.warn("No topic for HTTP Service: {}", properties);
 156             return serviceList;
 157         }
 158
 159         List<String> serviceNameList = Arrays.asList(serviceNames.split(SPACES_COMMA_SPACES));
 160
 161         for (String serviceName : serviceNameList) {
 162             String servicePortString = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES
 163                     + "." + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_PORT_SUFFIX);
 164
 165             int servicePort;
 166             try {
 167                 if (servicePortString == null || servicePortString.isEmpty()) {
 168                     if (logger.isWarnEnabled()) {
 169                         logger.warn("No HTTP port for service in {}", serviceName);
 170                     }
 171                     continue;
 172                 }
 173                 servicePort = Integer.parseInt(servicePortString);
 174             } catch (NumberFormatException nfe) {
 175                 if (logger.isWarnEnabled()) {
 176                     logger.warn("No HTTP port for service in {}", serviceName);
 177                 }
 178                 continue;
 179             }
 180
 181             String hostName = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "."
 182                     + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_HOST_SUFFIX);
 183
 184             String contextUriPath = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "."
 185                     + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_CONTEXT_URIPATH_SUFFIX);
 186
 187             String userName = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "."
 188                     + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_AUTH_USERNAME_SUFFIX);
 189
 190             String password = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "."
 191                     + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_AUTH_PASSWORD_SUFFIX);
 192
 193             String authUriPath = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "."
 194                     + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_AUTH_URIPATH_SUFFIX);
 195
 196             String restClasses = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "."
 197                     + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_REST_CLASSES_SUFFIX);
 198
 199             String restPackages = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "."
 200                     + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_REST_PACKAGES_SUFFIX);
 201             String restUriPath = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "."
 202                     + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_REST_URIPATH_SUFFIX);
 203
 204             String managedString = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "."
 205                     + serviceName + PolicyEndPointProperties.PROPERTY_MANAGED_SUFFIX);
 206             boolean managed = true;
 207             if (managedString != null && !managedString.isEmpty()) {
 208                 managed = Boolean.parseBoolean(managedString);
 209             }
 210
 211             String swaggerString = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "."
 212                     + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_SWAGGER_SUFFIX);
 213             boolean swagger = false;
 214             if (swaggerString != null && !swaggerString.isEmpty()) {
 215                 swagger = Boolean.parseBoolean(swaggerString);
 216             }
 217
 218             String httpsString = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "."
 219                 + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_HTTPS_SUFFIX);
 220             boolean https = false;
 221             if (httpsString != null && !httpsString.isEmpty()) {
 222                 https = Boolean.parseBoolean(httpsString);
 223             }
 224
 225             HttpServletServer service = build(serviceName, https, hostName, servicePort, contextUriPath, swagger, managed);
 226             if (userName != null && !userName.isEmpty() && password != null && !password.isEmpty()) {
 227                 service.setBasicAuthentication(userName, password, authUriPath);
 228             }
 229
 230             if (restClasses != null && !restClasses.isEmpty()) {
 231                 List<String> restClassesList = Arrays.asList(restClasses.split(SPACES_COMMA_SPACES));
 232                 for (String restClass : restClassesList) {
 233                     service.addServletClass(restUriPath, restClass);
 234                 }
 235             }
 236
 237             if (restPackages != null && !restPackages.isEmpty()) {
 238                 List<String> restPackageList = Arrays.asList(restPackages.split(SPACES_COMMA_SPACES));
 239                 for (String restPackage : restPackageList) {
 240                     service.addServletPackage(restUriPath, restPackage);
 241                 }
 242             }
 243
 244             serviceList.add(service);
 245         }
 246
 247         return serviceList;
 248     }
 249
 250     @Override
 251     public synchronized HttpServletServer get(int port) {
 252
 253         if (servers.containsKey(port)) {
 254             return servers.get(port);
 255         }
 256
 257         throw new IllegalArgumentException("Http Server for " + port + " not found");
 258     }
 259
 260     @Override
 261     public synchronized List<HttpServletServer> inventory() {
 262         return new ArrayList<>(this.servers.values());
 263     }
 264
 265     @Override
 266     public synchronized void destroy(int port) {
 267
 268         if (!servers.containsKey(port)) {
 269             return;
 270         }
 271
 272         HttpServletServer server = servers.remove(port);
 273         server.shutdown();
 274     }
 275
 276     @Override
 277     public synchronized void destroy() {
 278         List<HttpServletServer> httpServletServers = this.inventory();
 279         for (HttpServletServer server : httpServletServers) {
 280             server.shutdown();
 281         }
 282
 283         synchronized (this) {
 284             this.servers.clear();
 285         }
 286     }
 287
 288 }