aboutsummaryrefslogtreecommitdiffstats
path: root/bpmn/so-bpmn-infrastructure-common/src/main/java/org/onap/so/bpmn/infrastructure/decisionpoint/api/ControllerRunnable.java
blob: 670f4d399e651191e878fe9c028babbf1204c77b (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
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2019 Nordix
 *  ================================================================================
 *  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.so.bpmn.infrastructure.decisionpoint.api;

/**
 * the ControllerRunnable interface should be implemented by any class intended to execute against controller northbound
 * interface.
 *
 */
public interface ControllerRunnable<T> {

    /**
     * This method is used to decide whether the implementation is to serve the controller northbound interface.
     *
     * @param context {@link ControllerContext} is used as the input to the execution.
     * @return
     */
    Boolean understand(final ControllerContext<T> context);

    /**
     * this method is used to check whether the controller Northbound interface is ready to use.
     *
     * @param context {@link ControllerContext} is used as the input to the execution.
     * @return True if the controller is ready to use or return false.
     */
    Boolean ready(final ControllerContext<T> context);

    /**
     * This method is used to set up the context so it can be used to run against the controller NB.
     */
    void prepare(final ControllerContext<T> context);

    /**
     * This method is used to run against the controller northbound interface.
     *
     * @param context {@link ControllerContext} is used as the input to the execution.
     */
    void run(final ControllerContext<T> context);

}