gerrit.onap Code Review - policy/apex-pdp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.client.full.rest;
  22
  23 import java.net.URI;
  24
  25 /**
  26  * This class reads and handles command line parameters to the Apex RESTful services.
  27  *
  28  * @author Michael Watkins (michael.watkins@ericsson.com)
  29  */
  30 public class ApexServicesRestParameters {
  31     public static final int DEFAULT_REST_PORT = 18989;
  32     public static final int INFINITY_TIME_TO_LIVE = -1;
  33
  34     // Base URI the HTTP server will listen on
  35     private static final String DEFAULT_SERVER_URI_ROOT = "http://localhost:";
  36     private static final String DEFAULT_REST_PATH = "/apexservices/";
  37     private static final String DEFAULT_STATIC_PATH = "/";
  38
  39     // Package that will field REST requests
  40     private static final String[] DEFAULT_PACKAGES = new String[] { "org.onap.policy.apex.client.deployment.rest",
  41             "org.onap.policy.apex.client.editor.rest", "org.onap.policy.apex.client.monitoring.rest" };
  42
  43     // The services parameters
  44     private boolean helpSet = false;
  45     private int restPort = DEFAULT_REST_PORT;
  46     private long timeToLive = INFINITY_TIME_TO_LIVE;
  47
  48     public String validate() {
  49         String validationMessage = "";
  50         validationMessage += validatePort();
  51         validationMessage += validateTimeToLive();
  52
  53         return validationMessage;
  54     }
  55
  56     public URI getBaseURI() {
  57         return URI.create(DEFAULT_SERVER_URI_ROOT + restPort + DEFAULT_REST_PATH);
  58     }
  59
  60     public String[] getRESTPackages() {
  61         return DEFAULT_PACKAGES;
  62     }
  63
  64     public String getStaticPath() {
  65         return DEFAULT_STATIC_PATH;
  66     }
  67
  68     private String validatePort() {
  69         if (restPort < 1024 || restPort > 65535) {
  70             return "port must be greater than 1023 and less than 65536\n";
  71         } else {
  72             return "";
  73         }
  74     }
  75
  76     private String validateTimeToLive() {
  77         if (timeToLive < -1) {
  78             return "time to live must be greater than -1 (set to -1 to wait forever)\n";
  79         } else {
  80             return "";
  81         }
  82     }
  83
  84     public boolean isHelpSet() {
  85         return helpSet;
  86     }
  87
  88     public void setHelp(final boolean helpSet) {
  89         this.helpSet = helpSet;
  90     }
  91
  92     public int getRESTPort() {
  93         return restPort;
  94     }
  95
  96     public void setRESTPort(final int restPort) {
  97         this.restPort = restPort;
  98     }
  99
 100     public long getTimeToLive() {
 101         return timeToLive;
 102     }
 103
 104     public void setTimeToLive(final long timeToLive) {
 105         this.timeToLive = timeToLive;
 106     }
 107
 108     @Override
 109     public String toString() {
 110         final StringBuilder ret = new StringBuilder();
 111         ret.append(this.getClass().getSimpleName()).append(": URI=").append(this.getBaseURI()).append(", TTL=")
 112                 .append(this.getTimeToLive()).append("sec");
 113         return ret.toString();
 114     }
 115 }