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
|
/*
* 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.catalina;
import java.io.InputStream;
import java.net.URL;
import java.security.cert.Certificate;
import java.util.jar.Manifest;
/**
* Represents a file or directory within a web application. It borrows heavily from {@link java.io.File}.
*/
public interface WebResource {
/**
* @return {@link java.io.File#lastModified()}.
*/
long getLastModified();
/**
* @return the last modified time of this resource in the correct format for the HTTP Last-Modified header as
* specified by RFC 2616.
*/
String getLastModifiedHttp();
/**
* @return {@link java.io.File#exists()}.
*/
boolean exists();
/**
* Indicates if this resource is required for applications to correctly scan the file structure but that does not
* exist in either the main or any additional {@link WebResourceSet}. For example, if an external directory is
* mapped to /WEB-INF/lib in an otherwise empty web application, /WEB-INF will be represented as a virtual resource.
*
* @return <code>true</code> for a virtual resource
*/
boolean isVirtual();
/**
* @return {@link java.io.File#isDirectory()}.
*/
boolean isDirectory();
/**
* @return {@link java.io.File#isFile()}.
*/
boolean isFile();
/**
* @return {@link java.io.File#delete()}.
*/
boolean delete();
/**
* @return {@link java.io.File#getName()}.
*/
String getName();
/**
* @return {@link java.io.File#length()}.
*/
long getContentLength();
/**
* @return {@link java.io.File#getCanonicalPath()}.
*/
String getCanonicalPath();
/**
* @return {@link java.io.File#canRead()}.
*/
boolean canRead();
/**
* @return The path of this resource relative to the web application root. If the resource is a directory, the
* return value will end in '/'.
*/
String getWebappPath();
/**
* Return the weak ETag calculated from the content length and last modified.
*
* @return The ETag for this resource
*/
String getETag();
/**
* Return the strong ETag if available else return the weak ETag calculated from the content length and last
* modified.
*
* @return The ETag for this resource
*/
default String getStrongETag() {
return getETag();
}
/**
* Set the MIME type for this Resource.
*
* @param mimeType The mime type that will be associated with the resource
*/
void setMimeType(String mimeType);
/**
* @return the MIME type for this Resource.
*/
String getMimeType();
/**
* Obtain an InputStream based on the contents of this resource.
*
* @return An InputStream based on the contents of this resource or <code>null</code> if the resource does not exist
* or does not represent a file
*/
InputStream getInputStream();
/**
* @return the binary content of this resource or {@code null} if it is not available in a byte[] because, for
* example, it is too big.
*/
byte[] getContent();
/**
* @return The time the file was created. If not available, the result of {@link #getLastModified()} will be
* returned.
*/
long getCreation();
/**
* @return a URL to access the resource or <code>null</code> if no such URL is available or if the resource does not
* exist.
*/
URL getURL();
/**
* @return the code base for this resource that will be used when looking up the assigned permissions for the code
* base in the security policy file when running under a security manager.
*/
URL getCodeBase();
/**
* @return a reference to the WebResourceRoot of which this WebResource is a part.
*/
WebResourceRoot getWebResourceRoot();
/**
* @return the certificates that were used to sign this resource to verify it or @null if none.
*
* @see java.util.jar.JarEntry#getCertificates()
*/
Certificate[] getCertificates();
/**
* @return the manifest associated with this resource or @null if none.
*
* @see java.util.jar.JarFile#getManifest()
*/
Manifest getManifest();
}
|
