models-sim/policy-models-sim-pdp/src/main/java/org/onap/policy/models/sim/pdp/PdpSimulatorMain.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2021 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
   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.models.sim.pdp;
  23
  24 import java.util.Arrays;
  25 import org.onap.policy.common.utils.cmd.CommandLineException;
  26 import org.onap.policy.common.utils.services.Registry;
  27 import org.onap.policy.models.sim.pdp.exception.PdpSimulatorException;
  28 import org.onap.policy.models.sim.pdp.exception.PdpSimulatorRunTimeException;
  29 import org.onap.policy.models.sim.pdp.parameters.PdpSimulatorParameterGroup;
  30 import org.onap.policy.models.sim.pdp.parameters.PdpSimulatorParameterHandler;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 /**
  35  * This class initiates PdpSimulator.
  36  *
  37  * @author Ajith Sreekumar (ajith.sreekumar@est.tech)
  38  */
  39 public class PdpSimulatorMain {
  40
  41     private static final String PDP_SIMULATOR_FAIL_MSG = "start of pdp simulator failed";
  42
  43     private static final Logger LOGGER = LoggerFactory.getLogger(PdpSimulatorMain.class);
  44
  45     private PdpSimulatorActivator activator;
  46     private PdpSimulatorParameterGroup parameterGroup;
  47
  48     /**
  49      * Instantiates the PdpSimulator.
  50      *
  51      * @param args the command line arguments
  52      */
  53     public PdpSimulatorMain(final String[] args) {
  54         if (LOGGER.isInfoEnabled()) {
  55             LOGGER.info("In PdpSimulator with parameters {}", Arrays.toString(args));
  56         }
  57
  58         // Check the arguments
  59         final PdpSimulatorCommandLineArguments arguments = new PdpSimulatorCommandLineArguments();
  60         try {
  61             // The arguments return a string if there is a message to print and we should exit
  62             final String argumentMessage = arguments.parse(args);
  63             if (argumentMessage != null) {
  64                 LOGGER.debug(argumentMessage);
  65                 return;
  66             }
  67             // Validate that the arguments are sane
  68             arguments.validate();
  69         } catch (final PdpSimulatorRunTimeException | CommandLineException e) {
  70             LOGGER.error(PDP_SIMULATOR_FAIL_MSG, e);
  71             return;
  72         }
  73
  74         // Read the parameters
  75         try {
  76             parameterGroup = new PdpSimulatorParameterHandler().getParameters(arguments);
  77         } catch (final Exception e) {
  78             LOGGER.error(PDP_SIMULATOR_FAIL_MSG, e);
  79             return;
  80         }
  81
  82         // create the activator
  83         activator = new PdpSimulatorActivator(parameterGroup);
  84         Registry.register(PdpSimulatorConstants.REG_PDP_SIMULATOR_ACTIVATOR, activator);
  85         // Start the activator
  86         try {
  87             activator.initialize();
  88         } catch (final PdpSimulatorException e) {
  89             LOGGER.error("start of PdpSimulator failed, used parameters are {}", Arrays.toString(args), e);
  90             Registry.unregister(PdpSimulatorConstants.REG_PDP_SIMULATOR_ACTIVATOR);
  91             return;
  92         }
  93
  94         // Add a shutdown hook to shut everything down in an orderly manner
  95         Runtime.getRuntime().addShutdownHook(new PdpSimulatorShutdownHookClass());
  96
  97         LOGGER.info("Started PdpSimulator service");
  98     }
  99
 100     /**
 101      * Get the parameters specified in JSON.
 102      *
 103      * @return parameterGroup the parameters
 104      */
 105     public PdpSimulatorParameterGroup getParameters() {
 106         return parameterGroup;
 107     }
 108
 109
 110     /**
 111      * Shut down Execution.
 112      *
 113      * @throws PdpSimulatorException on shutdown errors
 114      */
 115     public void shutdown() throws PdpSimulatorException {
 116         // clear the parameterGroup variable
 117         parameterGroup = null;
 118
 119         // clear the pdp simulator activator
 120         if (activator != null && activator.isAlive()) {
 121             activator.terminate();
 122         }
 123     }
 124
 125     /**
 126      * The Class PdpSimulatorShutdownHookClass terminates the pdp simulator when its run method is called.
 127      */
 128     private class PdpSimulatorShutdownHookClass extends Thread {
 129         /*
 130          * (non-Javadoc)
 131          *
 132          * @see java.lang.Runnable#run()
 133          */
 134         @Override
 135         public void run() {
 136             try {
 137                 // Shutdown the pdp simulator service and wait for everything to stop
 138                 if (activator != null && activator.isAlive()) {
 139                     activator.terminate();
 140                 }
 141             } catch (final PdpSimulatorException e) {
 142                 LOGGER.warn("error occured during shut down of the pdp simulator service", e);
 143             }
 144         }
 145     }
 146
 147     /**
 148      * The main method. Arguments are validated in the constructor thus adding the NOSONAR.
 149      *
 150      * @param args the arguments
 151      *
 152      */
 153     public static void main(final String[] args) { // NOSONAR
 154         /*
 155          * The arguments are validated by the constructor, thus sonar is disabled.
 156          */
 157
 158         new PdpSimulatorMain(args);
 159     }
 160 }