1 /*
2 * Copyright 2012-2025 CodeLibs Project and the Others.
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,
13 * either express or implied. See the License for the specific language
14 * governing permissions and limitations under the License.
15 */
16 package org.codelibs.fess.helper;
17
18 import org.codelibs.core.concurrent.CommonPoolUtil;
19 import org.codelibs.core.lang.ThreadUtil;
20
21 /**
22 * The abstract helper for configuration.
23 *
24 * This class provides a basic framework for managing configurations that can be reloaded.
25 * It includes functionality for updating configurations in a separate thread and controlling the reloading interval.
26 */
27 public abstract class AbstractConfigHelper {
28
29 /**
30 * Default constructor.
31 */
32 public AbstractConfigHelper() {
33 // Default constructor
34 }
35
36 /**
37 * The interval for reloading.
38 */
39 protected long reloadInterval = 1000L;
40
41 /**
42 * Update the configuration.
43 */
44 public void update() {
45 CommonPoolUtil.execute(this::load);
46 }
47
48 /**
49 * Wait for the next reloading.
50 */
51 protected void waitForNext() {
52 if (reloadInterval > 0) {
53 ThreadUtil.sleep(reloadInterval);
54 }
55 }
56
57 /**
58 * Load the configuration.
59 * @return The number of loaded configurations.
60 */
61 public abstract int load();
62
63 /**
64 * Set the interval for reloading.
65 * @param reloadInterval The interval for reloading.
66 */
67 public void setReloadInterval(final long reloadInterval) {
68 this.reloadInterval = reloadInterval;
69 }
70 }