/
DeletionConfig.java
106 lines (87 loc) · 2.86 KB
/
DeletionConfig.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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/*
* Copyright (c) 2019 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.services.thingsearch.common.config;
import java.time.Duration;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.services.utils.config.KnownConfigValue;
/**
* Provides the configuration settings for the physical deletion of thing entities that are marked as
* {@code "__deleted"}.
* <p>
* Java serialization is supported for DeletionConfig.
* </p>
*/
@Immutable
public interface DeletionConfig {
/**
* Indicates whether physical deletion of marked thing entities is enabled.
*
* @return {@code true} if deletion is enabled, {@code false} else.
*/
boolean isEnabled();
/**
* Returns the amount of time after which thing entities should be deleted.
* I. e. thing entities that are marked as deleted longer than the returned duration are subject for physical
* deletion.
*
* @return the deletion age.
*/
Duration getDeletionAge();
/**
* Returns the interval of physical deletion.
*
* @return the interval.
*/
Duration getRunInterval();
/**
* Returns the hour of the first physical deletion run.
*
* @return the first interval hour (UTC).
*/
int getFirstIntervalHour();
/**
* An enumeration of the known config path expressions and their associated default values for DeletionConfig.
*/
enum DeletionConfigValue implements KnownConfigValue {
/**
* Determines whether physical deletion of marked thing entities is enabled.
*/
ENABLED("enabled", true),
/**
* Determines the amount of time after which thing entities should be deleted.
*/
DELETION_AGE("deletion-age", Duration.ofDays(3L)),
/**
* Determines the interval of physical deletion.
*/
RUN_INTERVAL("run-interval", Duration.ofHours(24L)),
/**
* The hour of the first physical deletion run.
*/
FIRST_INTERVAL_HOUR("first-interval-hour", 21);
private final String configPath;
private final Object defaultValue;
private DeletionConfigValue(final String configPath, final Object defaultValue) {
this.configPath = configPath;
this.defaultValue = defaultValue;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
@Override
public String getConfigPath() {
return configPath;
}
}
}