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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.apex.client.monitoring.rest;
26 * This class reads and handles command line parameters to the Apex RESTful services.
28 * @author Michael Watkins (michael.watkins@ericsson.com)
30 public class ApexMonitoringRestParameters {
31 public static final int DEFAULT_REST_PORT = 18989;
32 public static final int INFINITY_TIME_TO_LIVE = -1;
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 = "/";
39 // Package that will field REST requests
40 private static final String[] DEFAULT_PACKAGES = new String[] {"org.onap.policy.apex.client.monitoring.rest"};
42 // The services parameters
43 private boolean helpSet = false;
44 private int restPort = DEFAULT_REST_PORT;
45 private long timeToLive = INFINITY_TIME_TO_LIVE;
47 public String validate() {
48 String validationMessage = "";
49 validationMessage += validatePort();
50 validationMessage += validateTimeToLive();
52 return validationMessage;
55 public URI getBaseURI() {
56 return URI.create(DEFAULT_SERVER_URI_ROOT + restPort + DEFAULT_REST_PATH);
59 public String[] getRESTPackages() {
60 return DEFAULT_PACKAGES;
63 public String getStaticPath() {
64 return DEFAULT_STATIC_PATH;
67 private String validatePort() {
68 if (restPort < 1024 || restPort > 65535) {
69 return "port must be greater than 1023 and less than 65536\n";
75 private String validateTimeToLive() {
76 if (timeToLive < -1) {
77 return "time to live must be greater than -1 (set to -1 to wait forever)\n";
83 public boolean isHelpSet() {
87 public void setHelp(final boolean helpSet) {
88 this.helpSet = helpSet;
91 public int getRESTPort() {
95 public void setRESTPort(final int restPort) {
96 this.restPort = restPort;
99 public long getTimeToLive() {
103 public void setTimeToLive(final long timeToLive) {
104 this.timeToLive = timeToLive;
108 public String toString() {
109 final StringBuilder ret = new StringBuilder();
110 ret.append(this.getClass().getSimpleName()).append(": URI=").append(this.getBaseURI()).append(", TTL=")
111 .append(this.getTimeToLive()).append("sec");
112 return ret.toString();