-
Notifications
You must be signed in to change notification settings - Fork 131
/
FileRequest.java
417 lines (353 loc) · 13.2 KB
/
FileRequest.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
/*
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.
*/
/*
* FileRequest.java
*
* Created on July 5, 2002, 12:04 PM
*/
package org.dcache.srm.request;
import com.google.common.reflect.TypeToken;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.dao.DataAccessException;
import java.net.URI;
import diskCacheV111.srm.RequestFileStatus;
import org.dcache.srm.AbstractStorageElement;
import org.dcache.srm.SRM;
import org.dcache.srm.SRMException;
import org.dcache.srm.SRMInternalErrorException;
import org.dcache.srm.SRMInvalidRequestException;
import org.dcache.srm.SRMUser;
import org.dcache.srm.qos.QOSTicket;
import org.dcache.srm.scheduler.IllegalStateTransition;
import org.dcache.srm.scheduler.State;
import org.dcache.srm.util.Configuration;
import org.dcache.srm.util.JDC;
import org.dcache.srm.v2_2.TReturnStatus;
import org.dcache.srm.v2_2.TStatusCode;
import static com.google.common.base.Predicates.in;
import static com.google.common.collect.Iterables.any;
import static java.util.Arrays.asList;
/**
* A FileRequest is used by ContainerRequest (and its subclasses) to represent
* the individual files that form this request. For example if the user issues
* an srmLs operation then the corresponding LsRequest object will contain zero
* or more LsFileRequest objects (a subclass of FileRequest), one for each file
* in the srmLs operation.
*/
public abstract class FileRequest<R extends ContainerRequest> extends Job {
private final static Logger logger =
LoggerFactory.getLogger(FileRequest.class);
//file ContainerRequest is being processed
// for get and put it means that file turl
// is not available yet
//for copy - file is being copied
@SuppressWarnings("unchecked")
private final Class<R> containerRequestType = (Class<R>) new TypeToken<R>(getClass()) {}.getRawType();
//request which contains this fileRequest (which is different from request number)
protected final long requestId;
//pointer to underlying storage
private transient AbstractStorageElement storage;
//srm configuration
private transient Configuration configuration;
//error message if error, or just information message
private transient QOSTicket qosTicket;
/**
* Status code from version 2.2
* provides a better description of
* reasons for failure, etc
* need this to comply with the spec
*/
private TStatusCode statusCode;
/** Creates new FileRequest */
protected FileRequest(long requestId,
long lifetime)
{
super(lifetime);
this.requestId = requestId;
logger.debug("created");
}
/** this constructor is used for restoring the previously
* saved FileRequest from persitance storage
*/
protected FileRequest(
long id,
Long nextJobId,
long creationTime,long lifetime,
int stateId,String errorMessage,
String scheduelerId,
long schedulerTimeStamp,
int numberOfRetries,
long lastStateTransitionTime,
JobHistory[] jobHistoryArray,
long requestId,
String statusCodeString) {
super(id,
nextJobId,
creationTime, lifetime,
stateId, errorMessage,
scheduelerId,
schedulerTimeStamp,
numberOfRetries,
lastStateTransitionTime,
jobHistoryArray);
this.requestId = requestId;
this.statusCode = statusCodeString==null
?null
:TStatusCode.fromString(statusCodeString);
logger.debug("restored");
}
public void addDebugHistoryEvent(String description) {
addHistoryEvent( description);
}
/**
* @return the configuration
*/
public final Configuration getConfiguration() {
if(configuration == null) {
configuration = SRM.getSRM().getConfiguration();
}
return configuration;
}
public abstract RequestFileStatus getRequestFileStatus() ;
public abstract TReturnStatus getReturnStatus();
@Override
public boolean equals(Object o) {
return o == this;
}
@Override
public int hashCode() {
return (int) (getId() ^ getId() >> 32);
}
public void setStatus(SRMUser user, String status) throws SRMException {
logger.debug("("+status+")");
try {
wlock();
try {
if(status.equalsIgnoreCase("Done")) {
State state = getState();
if( !state.isFinal()) {
if(state == State.READY ||
state == State.TRANSFERRING ||
state == State.RUNNING) {
setState(State.DONE, "SRM client set state to Done.");
}
else {
setState(State.CANCELED, "SRM client cancelled operation by setting state to Done.");
}
}
}
else if(status.equalsIgnoreCase("Running")) {
setState(State.TRANSFERRING, "SRM client set state to Running.");
}
else if(status.equalsIgnoreCase("Failed")) {
setState(State.FAILED, "SRM client set state to Failed.");
}
else {
String error = "Can't set Status to "+status;
logger.error(error);
throw new SRMException(error);
}
} finally {
wunlock();
}
}
catch(IllegalStateTransition ist) {
String error = "Can't set Status to " + status + " due to: " + ist.getMessage();
logger.error(error);
throw new SRMException(error);
}
}
@Override
protected void stateChanged(State oldState)
{
try {
getContainerRequest().fileRequestStateChanged(this);
} catch (SRMInvalidRequestException ire) {
logger.error(ire.toString());
}
}
public void abort(String reason) throws IllegalStateTransition, SRMException
{
wlock();
try {
/* [ SRM 2.2, 5.12.2 ]
*
* a) srmAbortFiles aborts all files in the request regardless of the state.
* g) srmAbortFiles must not change the request level status of the completed
* requests. Once a request is completed, the status of the request remains
* the same.
* h) When duplicate abort file request is issued on the same files, SRM_SUCCESS
* must be returned to all duplicate abort file requests and no operations on
* duplicate abort file requests must performed.
*
* Combined we interpret this to mean that for any non-final state, the request
* is cancelled.
*
* Note that the remaining items more constraints for particular types of
* requests. Some subclasses thus override this method.
*/
if (!getState().isFinal()) {
setState(State.CANCELED, reason);
}
} finally {
wunlock();
}
}
public SRMUser getUser() throws SRMInvalidRequestException {
return getContainerRequest().getUser();
}
public R getContainerRequest() throws SRMInvalidRequestException {
return Job.getJob(requestId, containerRequestType);
}
/**
* Getter for property requestId.
* @return Value of property requestId.
*/
public long getRequestId() {
return requestId;
}
public void setQOSTicket(QOSTicket qosTicket) {
this.qosTicket = qosTicket;
}
public QOSTicket getQOSTicket() {
return qosTicket;
}
public abstract boolean isTouchingSurl(URI surl);
/**
* @param newLifetime new lifetime in millis
* -1 stands for infinite lifetime
* @return int lifetime left in millis
* -1 stands for infinite lifetime
*/
public abstract long extendLifetime(long newLifetime) throws SRMException ;
public TStatusCode getStatusCode() {
rlock();
try {
return statusCode;
} finally {
runlock();
}
}
public String getStatusCodeString() {
rlock();
try {
return statusCode==null ? null:statusCode.getValue() ;
} finally {
runlock();
}
}
public final void setStateAndStatusCode(
State state,
String description,
TStatusCode statusCode) throws IllegalStateTransition {
wlock();
try {
setState(state, description);
setStatusCode(statusCode);
} finally {
wunlock();
}
}
public void setStatusCode(TStatusCode statusCode) {
wlock();
try {
this.statusCode = statusCode;
} finally {
wunlock();
}
}
/**
*
* @return
*/
@Override
public String getSubmitterId() {
try {
return Long.toString(getUser().getId());
} catch (Exception e) {
//
// Throwing the exception from this method
// will prevent the change of the status of this request
// to canceled, done or failed.
// Therefore we catch the exception and
// just report the submitter id as unknown
//
logger.error(e.toString());
return "unknown";
}
}
@Override
public JDC applyJdc()
{
JDC current = jdc.apply();
JDC.appendToSession(String.valueOf(requestId) + ':' + String.valueOf(id));
return current;
}
/**
* @return the storage
*/
public final AbstractStorageElement getStorage() {
if(storage == null) {
storage = SRM.getSRM().getStorage();
}
return storage;
}
protected boolean isProtocolSupported(String[] protocols)
throws SRMInternalErrorException
{
return any(asList(protocols), in(asList(getStorage().supportedGetProtocols())));
}
@Override
public void toString(StringBuilder sb, boolean longformat) {
toString(sb, "", longformat);
}
abstract void toString(StringBuilder sb, String padding, boolean longformat);
}