aboutsummaryrefslogtreecommitdiffstats
path: root/policy-core/src/main/java/org/onap/policy/drools/core/lock/PolicyResourceLockManager.java
blob: 487814cb971d77e5b8f715a34f9e3bfc44a85a24 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/*
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2018 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.core.lock;

import java.util.List;
import java.util.function.Function;
import java.util.function.Supplier;
import org.onap.policy.drools.core.lock.PolicyResourceLockFeatureApi.OperResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Manager of resource locks. Checks for API implementers.
 */
public class PolicyResourceLockManager extends SimpleLockManager {

    private static Logger logger = LoggerFactory.getLogger(PolicyResourceLockManager.class);

    /**
     * Used by junit tests.
     */
    protected PolicyResourceLockManager() {
        super();
    }

    /**
     * Get instance.
     * 
     * @return the manager singleton
     */
    public static PolicyResourceLockManager getInstance() {
        return Singleton.instance;
    }

    @Override
    public boolean lock(String resourceId, String owner, int holdSec) {
        if (resourceId == null) {
            throw makeNullArgException(MSG_NULL_RESOURCE_ID);
        }

        if (owner == null) {
            throw makeNullArgException(MSG_NULL_OWNER);
        }


        return doBoolIntercept(impl -> impl.beforeLock(resourceId, owner, holdSec), () -> {

            // implementer didn't do the work - defer to the superclass
            boolean locked = super.lock(resourceId, owner, holdSec);

            doIntercept(false, impl -> impl.afterLock(resourceId, owner, locked));

            return locked;
        });
    }

    @Override
    public boolean refresh(String resourceId, String owner, int holdSec) {
        if (resourceId == null) {
            throw makeNullArgException(MSG_NULL_RESOURCE_ID);
        }

        if (owner == null) {
            throw makeNullArgException(MSG_NULL_OWNER);
        }


        return doBoolIntercept(impl -> impl.beforeRefresh(resourceId, owner, holdSec), () -> {

            // implementer didn't do the work - defer to the superclass
            boolean refreshed = super.refresh(resourceId, owner, holdSec);

            doIntercept(false, impl -> impl.afterRefresh(resourceId, owner, refreshed));

            return refreshed;
        });
    }

    @Override
    public boolean unlock(String resourceId, String owner) {
        if (resourceId == null) {
            throw makeNullArgException(MSG_NULL_RESOURCE_ID);
        }

        if (owner == null) {
            throw makeNullArgException(MSG_NULL_OWNER);
        }


        return doBoolIntercept(impl -> impl.beforeUnlock(resourceId, owner), () -> {

            // implementer didn't do the work - defer to the superclass
            boolean unlocked = super.unlock(resourceId, owner);

            doIntercept(false, impl -> impl.afterUnlock(resourceId, owner, unlocked));

            return unlocked;
        });
    }

    /**
     * Is locked.
     * 
     * @throws IllegalArgumentException if the resourceId is {@code null}
     */
    @Override
    public boolean isLocked(String resourceId) {
        if (resourceId == null) {
            throw makeNullArgException(MSG_NULL_RESOURCE_ID);
        }


        return doBoolIntercept(impl -> impl.beforeIsLocked(resourceId), () -> 

           // implementer didn't do the work - defer to the superclass
           super.isLocked(resourceId)
        );
    }

    /**
     *  Is locked by.
     *  
     * @throws IllegalArgumentException if the resourceId or owner is {@code null}
     */
    @Override
    public boolean isLockedBy(String resourceId, String owner) {
        if (resourceId == null) {
            throw makeNullArgException(MSG_NULL_RESOURCE_ID);
        }

        if (owner == null) {
            throw makeNullArgException(MSG_NULL_OWNER);
        }

        return doBoolIntercept(impl -> impl.beforeIsLockedBy(resourceId, owner), () -> 

            // implementer didn't do the work - defer to the superclass
            super.isLockedBy(resourceId, owner)
        );
    }

    /**
     * Applies a function to each implementer of the lock feature. Returns as soon as one
     * of them returns a result other than <b>OPER_UNHANDLED</b>. If they all return
     * <b>OPER_UNHANDLED</b>, then it returns the result of applying the default function.
     * 
     * @param interceptFunc intercept function
     * @param defaultFunc default function
     * @return {@code true} if success, {@code false} otherwise
     */
    private boolean doBoolIntercept(Function<PolicyResourceLockFeatureApi, OperResult> interceptFunc,
                    Supplier<Boolean> defaultFunc) {

        OperResult result = doIntercept(OperResult.OPER_UNHANDLED, interceptFunc);
        if (result != OperResult.OPER_UNHANDLED) {
            return (result == OperResult.OPER_ACCEPTED);
        }

        return defaultFunc.get();
    }

    /**
     * Applies a function to each implementer of the lock feature. Returns as soon as one
     * of them returns a non-null value.
     * 
     * @param continueValue if the implementer returns this value, then it continues to
     *        check addition implementers
     * @param func function to be applied to the implementers
     * @return first non-null value returned by an implementer, <i>continueValue</i> if
     *       they all returned <i>continueValue</i>
     */
    private <T> T doIntercept(T continueValue, Function<PolicyResourceLockFeatureApi, T> func) {

        for (PolicyResourceLockFeatureApi impl : getImplementers()) {
            try {
                T result = func.apply(impl);
                if (result != continueValue) {
                    return result;
                }

            } catch (RuntimeException e) {
                logger.warn("lock feature {} threw an exception", impl, e);
            }
        }

        return continueValue;
    }

    // these may be overridden by junit tests

    /**
     * Get implementers.
     * 
     * @return the list of feature implementers
     */
    protected List<PolicyResourceLockFeatureApi> getImplementers() {
        return PolicyResourceLockFeatureApi.impl.getList();
    }

    /**
     * Initialization-on-demand holder idiom.
     */
    private static class Singleton {

        private static final PolicyResourceLockManager instance = new PolicyResourceLockManager();
        
        /**
         * Not invoked.
         */
        private Singleton() {
            super();
        }
    }
}