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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tomcat.util.http.fileupload;
import java.io.File;
import java.io.IOException;
/**
* Strategy for deleting files.
* <p>
* There is more than one way to delete a file.
* You may want to limit access to certain directories, to only delete
* directories if they are empty, or maybe to force deletion.
* <p>
* This class captures the strategy to use and is designed for user subclassing.
*
* @since 1.3
*/
public class FileDeleteStrategy {
/**
* The singleton instance for normal file deletion, which does not permit
* the deletion of directories that are not empty.
*/
public static final FileDeleteStrategy NORMAL = new FileDeleteStrategy("Normal");
/** The name of the strategy. */
private final String name;
//-----------------------------------------------------------------------
/**
* Restricted constructor.
*
* @param name the name by which the strategy is known
*/
protected FileDeleteStrategy(String name) {
this.name = name;
}
//-----------------------------------------------------------------------
/**
* Deletes the file object, which may be a file or a directory.
* All <code>IOException</code>s are caught and false returned instead.
* If the file does not exist or is null, true is returned.
* <p>
* Subclass writers should override {@link #doDelete(File)}, not this method.
*
* @param fileToDelete the file to delete, null returns true
* @return true if the file was deleted, or there was no such file
*/
public boolean deleteQuietly(File fileToDelete) {
if (fileToDelete == null || fileToDelete.exists() == false) {
return true;
}
try {
return doDelete(fileToDelete);
} catch (IOException ex) {
return false;
}
}
/**
* Actually deletes the file object, which may be a file or a directory.
* <p>
* This method is designed for subclasses to override.
* The implementation may return either false or an <code>IOException</code>
* when deletion fails. The {@link #deleteQuietly(File)} method will handle
* either response appropriately.
* A check has been made to ensure that the file will exist.
* <p>
* This implementation uses {@link File#delete()}.
*
* @param fileToDelete the file to delete, exists, not null
* @return true if the file was deleteds
* @throws NullPointerException if the file is null
* @throws IOException if an error occurs during file deletion
*/
protected boolean doDelete(File fileToDelete) throws IOException {
return fileToDelete.delete();
}
//-----------------------------------------------------------------------
/**
* Gets a string describing the delete strategy.
*
* @return a string describing the delete strategy
*/
@Override
public String toString() {
return "FileDeleteStrategy[" + name + "]";
}
//-----------------------------------------------------------------------
/**
* Force file deletion strategy.
*/
static class ForceFileDeleteStrategy extends FileDeleteStrategy {
/** Default Constructor */
ForceFileDeleteStrategy() {
super("Force");
}
/**
* Deletes the file object.
* <p>
* This implementation uses <code>FileUtils.forceDelete() <code>
* if the file exists.
*
* @param fileToDelete the file to delete, not null
* @return Always returns {@code true}
* @throws NullPointerException if the file is null
* @throws IOException if an error occurs during file deletion
*/
@Override
protected boolean doDelete(File fileToDelete) throws IOException {
FileUtils.forceDelete(fileToDelete);
return true;
}
}
}
|
