aboutsummaryrefslogtreecommitdiffstats
path: root/client/client-full/src/main/java/org/onap/policy/apex/client/full/rest/ApexServicesRestMain.java
blob: a2fb0ac735c67d6a17329257ac2490cd7f4723e1 (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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. 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.client.full.rest;

import java.io.PrintStream;

/**
 * This class is the main class that is used to launch the Apex editor from the command line.
 *
 */
public class ApexServicesRestMain {
    /**
     * The Enum EditorState holds the current state of the editor.
     */
    // Editor state
    public enum EditorState {
        /** The editor is stopped. */
        STOPPED,
        /** The editor is ready to run. */
        READY,
        /** The editor is getting ready to run. */
        INITIALIZING,
        /** The editor is running. */
        RUNNING
    }

    private static final int EDITOR_RNNING_CHECK_TIMEOUT = 1000;

    private EditorState state = EditorState.STOPPED;

    // The Apex editor this class is running
    private ApexServicesRest apexServices = null;

    // The parameters for the editor
    private ApexServicesRestParameters parameters = null;

    // Output and error streams for messages
    private final PrintStream outStream;

    /**
     * Main method, main entry point for command.
     *
     * @param args The command line arguments for the editor
     */
    public static void main(final String[] args) {
        try {
            final ApexServicesRestMain editorMain = new ApexServicesRestMain(args, System.out);
            editorMain.init();
        } catch (final Exception e) {
            System.err.println(e.getMessage());
        }
    }

    /**
     * Constructor, kicks off the editor.
     *
     * @param args The command line arguments for the editor
     * @param outStream The stream for output messages
     */
    public ApexServicesRestMain(final String[] args, final PrintStream outStream) {
        // Save the streams for output and error
        this.outStream = outStream;

        // Editor parameter parsing
        final ApexServicesRestParameterParser parser = new ApexServicesRestParameterParser();

        try {
            // Get and check the parameters
            parameters = parser.parse(args);
        } catch (final ApexServicesRestParameterException e) {
            throw new ApexServicesRestParameterException(
                    "Apex Editor REST endpoint (" + this.toString() + ") parameter error, " + e.getMessage() + '\n'
                            + parser.getHelp(ApexServicesRestMain.class.getCanonicalName()));
        }

        if (parameters.isHelpSet()) {
            throw new ApexServicesRestParameterException(parser.getHelp(ApexServicesRestMain.class.getCanonicalName()));
        }

        // Validate the parameters
        final String validationMessage = parameters.validate();
        if (validationMessage.length() > 0) {
            throw new ApexServicesRestParameterException(
                    "Apex Editor REST endpoint (" + this.toString() + ") parameters invalid, " + validationMessage
                            + '\n' + parser.getHelp(ApexServicesRestMain.class.getCanonicalName()));
        }

        state = EditorState.READY;
    }

    /**
     * Initialize the Apex editor.
     */
    public void init() {
        outStream.println("Apex Editor REST endpoint (" + this.toString() + ") starting at "
                + parameters.getBaseURI().toString() + " . . .");

        try {
            state = EditorState.INITIALIZING;

            // Start the editor
            apexServices = new ApexServicesRest(parameters);

            // Add a shutdown hook to shut down the editor when the process is exiting
            Runtime.getRuntime().addShutdownHook(new Thread(new ApexServicesRestShutdownHook()));

            state = EditorState.RUNNING;

            if (parameters.getTimeToLive() == ApexServicesRestParameters.INFINITY_TIME_TO_LIVE) {
                outStream.println("Apex Editor REST endpoint (" + this.toString() + ") started at "
                        + parameters.getBaseURI().toString());
            } else {
                outStream.println("Apex Editor REST endpoint (" + this.toString() + ") started");
            }

            // Find out how long is left to wait
            long timeRemaining = parameters.getTimeToLive();
            while (timeRemaining == ApexServicesRestParameters.INFINITY_TIME_TO_LIVE || timeRemaining > 0) {
                // decrement the time to live in the non-infinity case
                if (timeRemaining > 0) {
                    timeRemaining--;
                }

                // Wait for a second
                Thread.sleep(EDITOR_RNNING_CHECK_TIMEOUT);
            }
        } catch (final Exception e) {
            outStream.println(
                    "Apex Editor REST endpoint (" + this.toString() + ") failed at with error: " + e.getMessage());
        } finally {
            if (apexServices != null) {
                apexServices.shutdown();
                apexServices = null;
            }
            state = EditorState.STOPPED;
        }
    }

    /**
     * Get the editor state.
     *
     * @return the state
     */
    public EditorState getState() {
        return state;
    }

    /*
     * (non-Javadoc)
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        final StringBuilder ret = new StringBuilder();
        ret.append(this.getClass().getSimpleName()).append(": Config=[").append(parameters).append("], State=")
                .append(this.getState());
        return ret.toString();
    }

    /**
     * Explicitly shut down the editor.
     */
    public void shutdown() {
        if (apexServices != null) {
            outStream.println("Apex Editor REST endpoint (" + this.toString() + ") shutting down");
            apexServices.shutdown();
        }
        state = EditorState.STOPPED;
        outStream.println("Apex Editor REST endpoint (" + this.toString() + ") shut down");
    }

    /**
     * This class is a shutdown hook for the Apex editor command.
     */
    private class ApexServicesRestShutdownHook implements Runnable {
        /*
         * (non-Javadoc)
         *
         * @see java.lang.Runnable#run()
         */
        @Override
        public void run() {
            if (apexServices != null) {
                apexServices.shutdown();
            }
        }
    }
}