aboutsummaryrefslogtreecommitdiffstats
path: root/api-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeatureApi.java
blob: 751ca28f8b09fdb9cb96dba07a07ef7ab1d0185c (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
/*-
 * ============LICENSE_START=======================================================
 * api-active-standby-management
 * ================================================================================
 * Copyright (C) 2017-2019 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.drools.activestandby;

import org.onap.policy.common.utils.services.OrderedService;

/**
 * This interface provides a way to invoke optional features at various points in the code. At
 * appropriate points in the application, the code iterates through this list, invoking these
 * optional methods.
 */
public interface ActiveStandbyFeatureApi extends OrderedService {

    /**
     * Returns the resourceName (PDP ID) for the Drools-PDP that is
     * currently designated as active.
     *
     * @return String (resourceName)
     */
    String getPdpdNowActive();

    /**
     * Returns the resourceName (PDP ID) for the Drools-PDP that is
     * previously designated as active.
     *
     * @return String (resourceName)
     */
    String getPdpdLastActive();

    /**
     * Returns the resourceName associated with this instance of the feature.
     *
     * @return String (resourceName)
     */
    String getResourceName();
}