Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ResourceDigestSource |
|
| 1.0;1 |
1 | // Copyright 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry.asset; | |
16 | ||
17 | import org.apache.hivemind.ApplicationRuntimeException; | |
18 | ||
19 | /** | |
20 | * Calculates the digest value, as a string, for a particular classpath resource. This is primarily | |
21 | * used by the {@link org.apache.tapestry.asset.AssetService}to authenticate requests (you are not | |
22 | * allowed access to a resource unless you can provide the correct digest value). | |
23 | * | |
24 | * @author Howard M. Lewis Ship | |
25 | * @since 4.0 | |
26 | */ | |
27 | public interface ResourceDigestSource | |
28 | { | |
29 | /** | |
30 | * Calculates the DIGEST checksum for a classpath resource. Because this is expensive, the value | |
31 | * may be cached. | |
32 | * | |
33 | * @param resourcePath | |
34 | * the classpath resource, which should start with a leading slash. | |
35 | * @return A string representation of the digest for the provided resource path. | |
36 | * @throws ApplicationRuntimeException | |
37 | * if the resource does not exist, or there is an error calculating the checksum. | |
38 | */ | |
39 | ||
40 | String getDigestForResource(String resourcePath); | |
41 | } |