aboutsummaryrefslogtreecommitdiffstats
path: root/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ManagerContext.java
blob: 0dcd302698a3880a5d7c712fbf5c299b95ff0518 (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
/*-
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2020 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.controlloop.eventmanager;

import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import org.onap.policy.controlloop.actorserviceprovider.ActorService;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.ophistory.OperationHistoryDataManager;

/**
 * Context for the Operation Manager.
 */
public interface ManagerContext {

    /**
     * Gets the actor service.
     *
     * @return the actor service
     */
    ActorService getActorService();

    /**
     * Gets the operation history data manager.
     *
     * @return the operation history data manager
     */
    OperationHistoryDataManager getDataManager();

    /**
     * Requests a lock on the specified target.
     *
     * @param target target to be locked
     * @param lockUnavailableCallback callback to be invoked if the lock is
     *        unavailable/lost
     * @return a future to await the lock
     */
    CompletableFuture<OperationOutcome> requestLock(String target, Consumer<OperationOutcome> lockUnavailableCallback);

    /**
     * Indicates that the given operation manager has been updated.
     *
     * @param operationMgr operation manager that has been updated
     */
    void updated(ControlLoopOperationManager2 operationMgr);
}