-
Notifications
You must be signed in to change notification settings - Fork 131
/
BulkRequestTarget.java
418 lines (348 loc) · 12.6 KB
/
BulkRequestTarget.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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
/*
COPYRIGHT STATUS:
Dec 1st 2001, Fermi National Accelerator Laboratory (FNAL) documents and
software are sponsored by the U.S. Department of Energy under Contract No.
DE-AC02-76CH03000. Therefore, the U.S. Government retains a world-wide
non-exclusive, royalty-free license to publish or reproduce these documents
and software for U.S. Government purposes. All documents and software
available from this server are protected under the U.S. and Foreign
Copyright Laws, and FNAL reserves all rights.
Distribution of the software available from this server is free of
charge subject to the user following the terms of the Fermitools
Software Legal Information.
Redistribution and/or modification of the software shall be accompanied
by the Fermitools Software Legal Information (including the copyright
notice).
The user is asked to feed back problems, benefits, and/or suggestions
about the software to the Fermilab Software Providers.
Neither the name of Fermilab, the URA, nor the names of the contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
DISCLAIMER OF LIABILITY (BSD):
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL FERMILAB,
OR THE URA, OR THE U.S. DEPARTMENT of ENERGY, OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Liabilities of the Government:
This software is provided by URA, independent from its Prime Contract
with the U.S. Department of Energy. URA is acting independently from
the Government and in its own private capacity and is not acting on
behalf of the U.S. Government, nor as its contractor nor its agent.
Correspondingly, it is understood and agreed that the U.S. Government
has no connection to this software and in no manner whatsoever shall
be liable for nor assume any responsibility or obligation for any claim,
cost, or damages arising out of or resulting from the use of the software
available from this server.
Export Control:
All documents and software available from this server are subject to U.S.
export control laws. Anyone downloading information from this server is
obligated to secure any necessary Government licenses before exporting
documents or software obtained from this server.
*/
package org.dcache.services.bulk.util;
import static java.util.Objects.requireNonNull;
import static org.dcache.services.bulk.util.BulkRequestTarget.State.CANCELLED;
import static org.dcache.services.bulk.util.BulkRequestTarget.State.CREATED;
import static org.dcache.services.bulk.util.BulkRequestTarget.State.READY;
import static org.dcache.services.bulk.util.BulkRequestTarget.State.RUNNING;
import com.google.common.base.Throwables;
import diskCacheV111.util.FsPath;
import diskCacheV111.util.PnfsId;
import java.sql.Timestamp;
import java.util.Optional;
import org.dcache.namespace.FileType;
import org.dcache.services.bulk.BulkServiceException;
import org.dcache.vehicles.FileAttributes;
/**
* Wraps data for an individual target of a request. This object corresponds to the underlying
* storage table, except that pnfsid and file type are extracted from the file attributes field
* and the throwable error is stored as classname and message.
* <p>
* Provides state management for the in-memory updates, as well as for cancellation.
*/
public final class BulkRequestTarget {
public static final State[] NON_TERMINAL = new State[]{CREATED, READY,
RUNNING};
public static FsPath computeFsPath(String prefix, String target) {
if (prefix == null) {
return FsPath.create(FsPath.ROOT + target);
} else {
return FsPath.create(
FsPath.ROOT + (prefix.endsWith("/") ? prefix : prefix + "/") + target);
}
}
public static final FsPath ROOT_REQUEST_PATH = computeFsPath(null, "=request_target=");
public static final PnfsId PLACEHOLDER_PNFSID = new PnfsId("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF");
public enum State {
CREATED, READY, RUNNING, CANCELLED, COMPLETED, FAILED, SKIPPED
}
public enum PID {
ROOT, INITIAL, DISCOVERED
}
private static final String INVALID_STATE_TRANSITION =
"%s: invalid target state transition %s to %s; please report this to dcache.org.";
private static final String TARGET_FORMAT =
"TARGET [%s, %s, %s][%s][%s: (C %s)(S %s)(U %s)(ret %s)][%s] %s : %s (err %s %s)";
private static final String KEY_SEPARATOR = "::";
private static final String KEY_FORMAT = "%s" + KEY_SEPARATOR + "%s";
public static String[] parse(String key) {
return key.split(KEY_SEPARATOR);
}
private final Optional<BulkServiceStatistics> statistics;
private Long id;
private PID pid;
private Long rid;
private String ruid;
private FsPath path;
private String activity;
private State state;
private long createdAt;
private Long startedAt;
private long lastUpdated;
private int retried;
private String errorType;
private String errorMessage;
private FileAttributes attributes;
BulkRequestTarget(BulkServiceStatistics statistics) {
this.statistics = Optional.ofNullable(statistics);
/**
* Constructed by fluid builder.
*/
state = CREATED;
if (statistics != null) {
statistics.increment(CREATED.name());
}
createdAt = System.currentTimeMillis();
}
public synchronized boolean cancel() {
switch (state) {
case CREATED:
case READY:
case RUNNING:
updateCounters(CANCELLED);
state = CANCELLED;
if (errorType == null) {
errorType = BulkServiceException.class.getCanonicalName();
errorMessage = getKey() + ": " + state;
}
return true;
default:
/*
* Already terminated.
*/
return false;
}
}
public synchronized boolean isCreated() {
switch (state) {
case CREATED:
return true;
default:
return false;
}
}
public synchronized boolean isReady() {
switch (state) {
case READY:
return true;
default:
return false;
}
}
public synchronized boolean isTerminated() {
switch (state) {
case FAILED:
case CANCELLED:
case COMPLETED:
case SKIPPED:
return true;
default:
return false;
}
}
public synchronized void resetToReady() {
++retried;
updateCounters(READY);
state = READY;
setErrorObject(null);
lastUpdated = System.currentTimeMillis();
}
public String getActivity() {
return activity;
}
public FileAttributes getAttributes() {
return attributes;
}
public long getCreatedAt() {
return createdAt;
}
public Long getId() {
return id;
}
public String getKey() {
return String.format(KEY_FORMAT, ruid, id);
}
public long getLastUpdated() {
return lastUpdated;
}
public PID getPid() {
return pid;
}
public PnfsId getPnfsId() {
return attributes == null ? null : attributes.getPnfsId();
}
public FsPath getPath() {
return path == null ? FsPath.ROOT : path;
}
public int getRetried() {
return retried;
}
public Long getRid() {
return rid;
}
public String getRuid() {
return ruid;
}
public Long getStartedAt() {
return startedAt;
}
public State getState() {
return state;
}
public FileType getType() {
return attributes == null ? null : attributes.getFileType();
}
public String getErrorType() {
return errorType;
}
public String getErrorMessage() {
return errorMessage;
}
public void setActivity(String activity) {
this.activity = activity;
}
public void setAttributes(FileAttributes attributes) {
this.attributes = attributes;
}
public void setCreatedAt(long createdAt) {
this.createdAt = createdAt;
}
public void setErrorObject(Object error) {
Throwable errorObject;
errorType = null;
if (error != null) {
if (error instanceof Throwable) {
errorObject = Throwables.getRootCause((Throwable) error);
} else {
errorObject = Throwables.getRootCause(new Throwable(String.valueOf(error)));
}
errorType = errorObject.getClass().getCanonicalName();
errorMessage = errorObject.getMessage();
setState(State.FAILED);
}
}
public void setErrorType(String errorType) {
this.errorType = errorType;
}
public void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
public void setId(Long id) {
this.id = id;
}
public void setLastUpdated(long lastUpdated) {
this.lastUpdated = lastUpdated;
}
public void setPath(FsPath path) {
this.path = path;
}
public void setPid(PID pid) {
this.pid = pid;
}
public void setRid(Long rid) {
this.rid = rid;
}
public void setRuid(String ruid) {
this.ruid = ruid;
}
public void setRetried(int retried) {
this.retried = retried;
}
public void setStartedAt(Long startedAt) {
this.startedAt = startedAt;
}
public synchronized boolean setState(State state) {
requireNonNull(state);
if (this.state == state) {
return false;
}
switch (this.state) {
case CANCELLED:
case COMPLETED:
case FAILED:
case SKIPPED:
return false;
case RUNNING:
switch (state) {
case CANCELLED:
case COMPLETED:
case FAILED:
case SKIPPED:
updateCounters(state);
this.state = state;
lastUpdated = System.currentTimeMillis();
return true;
default:
throw new IllegalStateException(
String.format(INVALID_STATE_TRANSITION,
id,
this.state,
state));
}
case READY:
switch (state) {
case CANCELLED:
case COMPLETED:
case FAILED:
case SKIPPED:
case RUNNING:
updateCounters(state);
this.state = state;
lastUpdated = System.currentTimeMillis();
return true;
default:
throw new IllegalStateException(
String.format(INVALID_STATE_TRANSITION,
id,
this.state,
state));
}
case CREATED:
default:
updateCounters(state);
this.state = state;
lastUpdated = System.currentTimeMillis();
return true;
}
}
@Override
public String toString() {
return String.format(TARGET_FORMAT, id, pid, ruid, activity,
state, new Timestamp(createdAt), startedAt == null ? null : new Timestamp(startedAt),
new Timestamp(lastUpdated), retried, getType(), getPnfsId(), path, errorType, errorMessage);
}
private void updateCounters(State state) {
statistics.ifPresent(s -> {
s.decrement(this.state.name());
s.increment(state.name());
});
}
}