2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2018 AT&T Intellectual Property. All rights
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END============================================
20 * ===================================================================
24 package org.onap.clamp.clds.camel;
26 import org.apache.camel.ExchangeProperty;
29 * This interface describes the CamelProxy parameters that must be passed to the
32 public interface CamelProxy {
35 * This method is called when invoking a camel flow.
37 * @param actionCommand
38 * The action coming from the Clamp UI (like SUBMIT, UPDATE,
40 * @param modelProperties
41 * The Model properties created based on the BPMN Json and
43 * @param modelBpmnProperties
44 * The Json with all the properties describing the flow
48 * The control loop name
50 * The Global properties JSON containing YAML (coming from CLamp
53 * Is a test or not (flag coming from the UI)
55 * The user ID coming from the UI
56 * @param isInsertTestEvent
57 * Is a test or not (flag coming from the UI)
59 * The latest event action in database (like CREATE, SUBMIT, ...)
60 * @return A string containing the result of the Camel flow execution
62 String submit(@ExchangeProperty("actionCd") String actionCommand,
63 @ExchangeProperty("modelProp") String modelProperties,
64 @ExchangeProperty("modelBpmnProp") String modelBpmnProperties,
65 @ExchangeProperty("modelName") String modelName, @ExchangeProperty("controlName") String controlName,
66 @ExchangeProperty("docText") String docText, @ExchangeProperty("isTest") boolean isTest,
67 @ExchangeProperty("userid") String userId, @ExchangeProperty("isInsertTestEvent") boolean isInsertTestEvent,
68 @ExchangeProperty("eventAction") String eventAction);