2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2016-2018 Ericsson. All rights reserved.
4 * Modifications Copyright (C) 2020 Nordix Foundation.
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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.apex.plugins.executor.java;
24 import java.lang.reflect.Method;
26 import java.util.Properties;
28 import org.onap.policy.apex.context.ContextException;
29 import org.onap.policy.apex.core.engine.executor.StateFinalizerExecutor;
30 import org.onap.policy.apex.core.engine.executor.context.StateFinalizerExecutionContext;
31 import org.onap.policy.apex.core.engine.executor.exception.StateMachineException;
32 import org.slf4j.ext.XLogger;
33 import org.slf4j.ext.XLoggerFactory;
36 * The Class JavaStateFinalizerExecutor is the state finalizer executor for state finalizer logic written in Java.
38 * @author Liam Fallon (liam.fallon@ericsson.com)
40 public class JavaStateFinalizerExecutor extends StateFinalizerExecutor {
41 // Logger for this class
42 private static final XLogger LOGGER = XLoggerFactory.getXLogger(JavaStateFinalizerExecutor.class);
44 // The Java State Finalizer executor class
45 private Object stateFinalizerLogicObject = null;
48 * Prepares the state finalizer for processing.
50 * @throws StateMachineException thrown when a state machine execution error occurs
53 public void prepare() throws StateMachineException {
54 // Call generic prepare logic
57 // Get the class for state finalizer execution
59 // Create the state finalizer logic object from the byte code of the class
60 stateFinalizerLogicObject = Class.forName(getSubject().getLogic()).getDeclaredConstructor().newInstance();
61 } catch (final Exception e) {
62 LOGGER.error("instantiation error on Java class \"" + getSubject().getLogic() + "\"", e);
63 throw new StateMachineException("instantiation error on Java class \"" + getSubject().getLogic() + "\"", e);
68 * Executes the executor for the state finalizer logic in a sequential manner.
70 * @param executionId the execution ID for the current APEX policy execution
71 * @param executionProperties properties for the current APEX policy execution
72 * @param incomingFields the incoming fields for finalisation
73 * @return The state output for the state
74 * @throws StateMachineException on an execution error
75 * @throws ContextException on context errors
78 public String execute(final long executionId, final Properties executionProperties,
79 final Map<String, Object> incomingFields) throws StateMachineException, ContextException {
80 // Do execution pre work
81 executePre(executionId, executionProperties, incomingFields);
83 // Check and execute the Java logic
84 boolean returnValue = false;
86 // Find and call the method with the signature "public boolean getStateOutput(final
87 // StateFinalizerExecutionContext executor) throws ApexException"
89 // task logic in the Java class
90 final Method method = stateFinalizerLogicObject.getClass().getDeclaredMethod("getStateOutput",
91 new Class[] {StateFinalizerExecutionContext.class});
92 returnValue = (boolean) method.invoke(stateFinalizerLogicObject, getExecutionContext());
93 } catch (final Exception e) {
94 LOGGER.error("execute: state finalizer logic failed to run for state finalizer \"" + getSubject().getId()
96 throw new StateMachineException(
97 "state finalizer logic failed to run for state finalizer \"" + getSubject().getId() + "\"", e);
100 // Do the execution post work
101 executePost(returnValue);
103 // Send back the return event
104 return getOutgoing();
108 * Cleans up the state finalizer after processing.
110 * @throws StateMachineException thrown when a state machine execution error occurs
113 public void cleanUp() throws StateMachineException {
114 LOGGER.debug("cleanUp:" + getSubject().getId() + "," + getSubject().getLogicFlavour() + ","
115 + getSubject().getLogic());