1
2
3
4
5
6
7
8
9
10
11
12
13
14 package ch.qos.logback.classic.model.processor;
15
16 import ch.qos.logback.classic.joran.ReconfigureOnChangeTask;
17 import ch.qos.logback.classic.model.ConfigurationModel;
18 import ch.qos.logback.core.Context;
19 import ch.qos.logback.core.CoreConstants;
20 import ch.qos.logback.core.joran.spi.ConfigurationWatchList;
21 import ch.qos.logback.core.joran.util.ConfigurationWatchListUtil;
22 import ch.qos.logback.core.model.Model;
23 import ch.qos.logback.core.model.processor.ModelHandlerBase;
24 import ch.qos.logback.core.model.processor.ModelHandlerException;
25 import ch.qos.logback.core.model.processor.ModelInterpretationContext;
26 import ch.qos.logback.core.spi.ConfigurationEvent;
27 import ch.qos.logback.core.util.Duration;
28 import ch.qos.logback.core.util.OptionHelper;
29
30 import java.util.concurrent.ScheduledExecutorService;
31 import java.util.concurrent.ScheduledFuture;
32 import java.util.concurrent.TimeUnit;
33
34
35
36
37
38
39
40 public class ConfigurationModelHandlerFull extends ConfigurationModelHandler {
41
42 public static final String FAILED_WATCH_PREDICATE_MESSAGE_1 = "Missing watchable .xml or .properties files.";
43 public static final String FAILED_WATCH_PREDICATE_MESSAGE_2 = "Watching .xml files requires that the main configuration file is reachable as a URL";
44
45 public ConfigurationModelHandlerFull(Context context) {
46 super(context);
47 }
48
49 static public ModelHandlerBase makeInstance(Context context, ModelInterpretationContext mic) {
50 return new ConfigurationModelHandlerFull(context);
51 }
52
53 @Override
54 public void postHandle(ModelInterpretationContext mic, Model model) throws ModelHandlerException {
55 ConfigurationModel configurationModel = (ConfigurationModel) model;
56
57
58 if (scanning != Boolean.TRUE) {
59 if (!isLocalScanRequested(mic)) {
60 return;
61 }
62 addInfo("Scan requested by <propertiesConfigurator>. Will scan for changes in watched .properties files.");
63 }
64
65 String scanPeriodStr = mic.subst(configurationModel.getScanPeriodStr());
66 scheduleReconfigureOnChangeTask(scanPeriodStr);
67
68 ConfigurationWatchList cwl = ConfigurationWatchListUtil.getConfigurationWatchList(getContext());
69 if (cwl != null) {
70 try {
71 addInfo("Main configuration file URL: " + cwl.getTopURL());
72 addInfo("FileWatchList= {" + cwl.getFileWatchListAsStr() + "}");
73 addInfo("URLWatchList= {" + cwl.getUrlWatchListAsStr() + "}");
74 } catch (NoSuchMethodError e) {
75 addWarn("It looks like the version of logback-classic is more recent than");
76 addWarn("the version of logback-core. Please align the two versions.");
77 }
78 }
79 }
80
81 private boolean isLocalScanRequested(ModelInterpretationContext mic) {
82 return mic.getObjectMap().get(PropertiesConfiguratorModelHandler.LOCAL_SCAN_REQUESTED_KEY) == Boolean.TRUE;
83 }
84
85
86
87
88
89
90
91
92
93
94 public void detachedPostProcess(String scanStr, String scanPeriodStr) {
95 if (OptionHelper.isNullOrEmptyOrAllSpaces(scanStr) || CoreConstants.FALSE_STR.equalsIgnoreCase(scanStr)) {
96 return;
97 }
98
99 scheduleReconfigureOnChangeTask(scanPeriodStr);
100 }
101
102
103
104
105
106
107
108
109
110
111 public void detachedPostProcess(String scanPeriodStr) {
112 scheduleReconfigureOnChangeTask(scanPeriodStr);
113 }
114
115
116
117
118
119
120
121
122
123
124
125 private void scheduleReconfigureOnChangeTask(String scanPeriodStr) {
126
127 boolean watchPredicateFulfilled = ConfigurationWatchListUtil.watchPredicateFulfilled(context);
128 if (!watchPredicateFulfilled) {
129 addWarn(FAILED_WATCH_PREDICATE_MESSAGE_1);
130 addWarn(FAILED_WATCH_PREDICATE_MESSAGE_2);
131 return;
132 }
133
134 ReconfigureOnChangeTask rocTask = new ReconfigureOnChangeTask();
135 rocTask.setContext(context);
136
137 addInfo("Registering a new ReconfigureOnChangeTask " + rocTask);
138
139 context.fireConfigurationEvent(ConfigurationEvent.newConfigurationChangeDetectorRegisteredEvent(rocTask));
140
141 Duration duration = getDurationOfScanPeriodAttribute(scanPeriodStr, SCAN_PERIOD_DEFAULT);
142
143 ConfigurationWatchList cwl = ConfigurationWatchListUtil.getConfigurationWatchList(context);
144
145 String fileWatchListAsStr = (cwl != null) ? cwl.getFileWatchListAsStr() : "";
146
147 addInfo("Will scan for changes in [" + fileWatchListAsStr + "] ");
148
149
150
151
152 addInfo("Setting ReconfigureOnChangeTask scanning period to " + duration);
153
154 ScheduledExecutorService scheduledExecutorService = context.getScheduledExecutorService();
155 ScheduledFuture<?> scheduledFuture = scheduledExecutorService.scheduleAtFixedRate(rocTask, duration.getMilliseconds(), duration.getMilliseconds(),
156 TimeUnit.MILLISECONDS);
157 rocTask.setScheduledFuture(scheduledFuture);
158 context.addScheduledFuture(scheduledFuture);
159
160 }
161
162 private Duration getDurationOfScanPeriodAttribute(String scanPeriodAttrib, Duration defaultDuration) {
163 Duration duration = null;
164
165 if (!OptionHelper.isNullOrEmptyOrAllSpaces(scanPeriodAttrib)) {
166 try {
167 duration = Duration.valueOf(scanPeriodAttrib);
168 } catch (IllegalStateException | IllegalArgumentException e) {
169 addWarn("Failed to parse 'scanPeriod' attribute [" + scanPeriodAttrib + "]", e);
170
171 }
172 }
173
174 if (duration == null) {
175 addInfo("No 'scanPeriod' specified. Defaulting to " + defaultDuration.toString());
176 duration = defaultDuration;
177 }
178 return duration;
179 }
180 }