main/src/main/java/org/onap/policy/pap/main/startstop/PapCommandLineArguments.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2021 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019, 2021 AT&T Intellectual Property.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.pap.main.startstop;
  23
  24 import org.apache.commons.cli.Option;
  25 import org.onap.policy.common.utils.cmd.CommandLineArgumentsHandler;
  26 import org.onap.policy.common.utils.cmd.CommandLineException;
  27 import org.onap.policy.common.utils.resources.MessageConstants;
  28 import org.onap.policy.pap.main.PolicyPapRuntimeException;
  29
  30 /**
  31  * This class reads and handles command line parameters for the policy pap service.
  32  *
  33  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  34  */
  35 public class PapCommandLineArguments extends CommandLineArgumentsHandler {
  36
  37     protected static final String GROUP_FILE_OPTION = "g";
  38     protected static final String GROUP_FILE_LONG_OPTION = "groups-file";
  39     public static final String GROUP_FILE_ARG_NAME = "GROUP_FILE";
  40
  41     protected static final String DEFAULT_GROUP_RESOURCE = "PapDb.json";
  42
  43     /**
  44      * Construct the options for the CLI editor.
  45      */
  46     public PapCommandLineArguments() {
  47         super(Main.class.getName(), MessageConstants.POLICY_PAP, customOptionG());
  48     }
  49
  50     private static Option customOptionG() {
  51         return Option.builder(GROUP_FILE_OPTION).longOpt(GROUP_FILE_LONG_OPTION)
  52                        .desc("the full path to the groups file to use, "
  53                                      + "the groups file contains the group configuration added to the DB")
  54                        .hasArg().argName(GROUP_FILE_ARG_NAME).required(false).type(String.class).build();
  55     }
  56
  57     protected String getPdpGroupsConfiguration() {
  58         return this.getCommandLine()
  59                        .getOptionValue(GROUP_FILE_OPTION, DEFAULT_GROUP_RESOURCE);
  60     }
  61
  62     @Override
  63     public void validate() throws CommandLineException {
  64         super.validate();
  65         String groupConfig = getPdpGroupsConfiguration();
  66         if (!groupConfig.equals(DEFAULT_GROUP_RESOURCE)) {
  67             validateReadableFile(MessageConstants.POLICY_PAP, groupConfig);
  68         }
  69     }
  70
  71     /**
  72      * Construct the options for the CLI editor and parse in the given arguments.
  73      *
  74      * @param args The command line arguments
  75      */
  76     public PapCommandLineArguments(final String[] args) {
  77         this();
  78
  79         try {
  80             parse(args);
  81         } catch (final CommandLineException e) {
  82             throw new PolicyPapRuntimeException("parse error on policy pap parameters", e);
  83         }
  84     }
  85 }