1 /***
2 * Copyright 2003-2010 Terracotta, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package net.sf.ehcache.constructs.nonstop;
18
19 import net.sf.ehcache.config.TimeoutBehaviorConfiguration.TimeoutBehaviorType;
20
21 /***
22 * Interface for executing clustered operations (that can potentially get stuck)
23 *
24 * @author Abhishek Sanoujam
25 *
26 * @param <V>
27 */
28 public interface ClusterOperation<V> {
29
30 /***
31 * Perform the actual operation.
32 * This operation can potentially get stuck in the network. This method is called by an executor thread
33 *
34 * @return the return value depending on the implementation
35 * @throws Exception
36 */
37 V performClusterOperation() throws Exception;
38
39 /***
40 * Perform action when the actual operation is not able to complete. Implementation should take care of what to do depending on the
41 * {@link TimeoutBehaviorType}
42 *
43 * @param configuredTimeoutBehavior The configured {@link TimeoutBehaviorType}
44 * @return value depending on the implementation
45 */
46 V performClusterOperationTimedOut(TimeoutBehaviorType configuredTimeoutBehavior);
47
48 }