1 | /* |
2 | * Copyright 2006-2007 the original author or authors. |
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 org.springframework.batch.retry.backoff; |
18 | |
19 | import org.springframework.batch.retry.RetryContext; |
20 | |
21 | /** |
22 | * Simple base class for {@link BackOffPolicy} implementations that maintain no |
23 | * state across invocations. |
24 | * |
25 | * @author Rob Harrop |
26 | * @author Dave Syer |
27 | */ |
28 | public abstract class StatelessBackOffPolicy implements BackOffPolicy { |
29 | |
30 | /** |
31 | * Delegates directly to the {@link #doBackOff()} method without passing on |
32 | * the {@link BackOffContext} argument which is not needed for stateless |
33 | * implementations. |
34 | */ |
35 | public final void backOff(BackOffContext backOffContext) throws BackOffInterruptedException { |
36 | doBackOff(); |
37 | } |
38 | |
39 | /** |
40 | * Returns '<code>null</code>'. Subclasses can add behaviour, e.g. |
41 | * initial sleep before first attempt. |
42 | */ |
43 | public BackOffContext start(RetryContext status) { |
44 | return null; |
45 | } |
46 | |
47 | /** |
48 | * Sub-classes should implement this method to perform the actual back off. |
49 | */ |
50 | protected abstract void doBackOff() throws BackOffInterruptedException; |
51 | } |