aboutsummaryrefslogtreecommitdiffstats
path: root/examples/examples-servlet/src/main/java/org/onap/policy/apex/examples/servlet/ApexServletListener.java
blob: c1b7fbc11d51eaa39b8ce0446721fd9de104dc91 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.examples.servlet;

import java.util.ArrayList;
import java.util.List;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
import org.onap.policy.apex.model.basicmodel.concepts.ApexRuntimeException;
import org.onap.policy.apex.service.engine.main.ApexMain;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;

/**
 * This class is a listener that is called when the servlet is started and stopped. It brings up the Apex engine on
 * servlet start and shuts it down on servlet stop.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
@WebListener
public class ApexServletListener implements ServletContextListener {
    private static final XLogger LOGGER = XLoggerFactory.getXLogger(ApexServletListener.class);

    // The Apex engine reference
    private ApexMain apexMain;

    /**
     * {@inheritDoc}.
     */
    @Override
    public void contextInitialized(final ServletContextEvent servletContextEvent) {
        // The web.xml file contains the context parameters for the Apex engine
        final String configFileName = servletContextEvent.getServletContext().getInitParameter("config-file");
        final String modelFileName = servletContextEvent.getServletContext().getInitParameter("model-file");

        LOGGER.info("Apex Servliet has been started, config-file={}, model-file={}", configFileName, modelFileName);

        // Check that a configuration file have been specified
        if (servletContextEvent.getServletContext().getInitParameter("config-file") == null) {
            final var errorMessage =
                    "Apex servlet start failed, servlet parameter \"config-file\" has not been specified";
            LOGGER.error("Apex servlet start failed, servlet parameter \"config-file\" has not been specified");
            throw new ApexRuntimeException(errorMessage);
        }

        // Construct the Apex command line arguments
        final List<String> argsList = new ArrayList<>();
        argsList.add("-config-file");
        argsList.add(configFileName);

        // Model file name is an optional parameter
        if (modelFileName != null) {
            argsList.add("-model-file");
            argsList.add(modelFileName);
        }

        // Initialize apex
        apexMain = new ApexMain(argsList.toArray(new String[argsList.size()]));
    }


    /**
     * {@inheritDoc}.
     */
    @Override
    public void contextDestroyed(final ServletContextEvent servletContextEvent) {
        // Shut Apex down
        try {
            apexMain.shutdown();
            apexMain = null;
        } catch (final ApexException e) {
            LOGGER.error("Apex servlet stop did not execute normally", e);
        }

        LOGGER.info("Apex Servliet has been stopped");
    }
}