ResourceDigestSource


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  /**
18   * Calculates the digest value, as a string, for a particular classpath resource. This is primarily
19   * used by the {@link org.apache.tapestry.asset.AssetService}to authenticate requests (you are not
20   * allowed access to a resource unless you can provide the correct digest value).
21   * 
22   * @author Howard M. Lewis Ship
23   * @since 4.0
24   */
25  public interface ResourceDigestSource
26  {
27      /**
28       * Calculates the DIGEST checksum for a classpath resource. Because this is expensive, the value
29       * may be cached.
30       * 
31       * @param resourcePath
32       *            the classpath resource, which should start with a leading slash.
33       * @return A string representation of the digest for the provided resource path.
34       * @throws ApplicationRuntimeException
35       *             if the resource does not exist, or there is an error calculating the checksum.
36       */
37  
38      public String   getDigestForResource(String   resourcePath);
39  }

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags