-
Notifications
You must be signed in to change notification settings - Fork 19
/
LocalRecoveryConfig.java
88 lines (71 loc) · 3.21 KB
/
LocalRecoveryConfig.java
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
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
package org.apache.flink.runtime.state;
import org.apache.flink.util.Preconditions;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Optional;
import java.util.function.Supplier;
/**
* This class encapsulates the completed configuration for local recovery, i.e. the root directories
* into which all file-based snapshots can be written and the general mode for the local recover
* feature.
*/
public class LocalRecoveryConfig {
public static final LocalRecoveryConfig BACKUP_AND_RECOVERY_DISABLED =
new LocalRecoveryConfig(false, false, null);
/** Whether to recover from the local snapshot. */
private final boolean localRecoveryEnabled;
/** Whether to do backup checkpoint on local disk. */
private final boolean localBackupEnabled;
/** Encapsulates the root directories and the subtask-specific path. */
@Nullable private final LocalSnapshotDirectoryProvider localStateDirectories;
public LocalRecoveryConfig(
boolean localRecoveryEnabled,
boolean localBackupEnabled,
@Nullable LocalSnapshotDirectoryProvider directoryProvider) {
this.localRecoveryEnabled = localRecoveryEnabled;
this.localBackupEnabled = localBackupEnabled;
this.localStateDirectories = directoryProvider;
}
public boolean isLocalRecoveryEnabled() {
return localRecoveryEnabled;
}
public boolean isLocalBackupEnabled() {
return localBackupEnabled;
}
public boolean isLocalRecoveryOrLocalBackupEnabled() {
return localRecoveryEnabled || localBackupEnabled;
}
public Optional<LocalSnapshotDirectoryProvider> getLocalStateDirectoryProvider() {
return Optional.ofNullable(localStateDirectories);
}
@Override
public String toString() {
return "LocalRecoveryConfig{" + "localStateDirectories=" + localStateDirectories + '}';
}
public static Supplier<IllegalStateException> localRecoveryNotEnabled() {
return () ->
new IllegalStateException(
"Getting a LocalRecoveryDirectoryProvider is only supported with the local recovery enabled. This is a bug and should be reported.");
}
public static LocalRecoveryConfig backupAndRecoveryEnabled(
@Nonnull LocalSnapshotDirectoryProvider directoryProvider) {
return new LocalRecoveryConfig(true, true, Preconditions.checkNotNull(directoryProvider));
}
}