ResourceManager


1   /*-- 
2   
3    Copyright (C) 2001-2003 Aetrion LLC.
4    All rights reserved.
5    
6    Redistribution and use in source and binary forms, with or without
7    modification, are permitted provided that the following conditions
8    are met:
9    
10   1. Redistributions of source code must retain the above copyright
11      notice, this list of conditions, and the following disclaimer.
12   
13   2. Redistributions in binary form must reproduce the above copyright
14      notice, this list of conditions, and the disclaimer that follows 
15      these conditions in the documentation and/or other materials 
16      provided with the distribution.
17  
18   3. The name "JPublish" must not be used to endorse or promote products
19      derived from this software without prior written permission.  For
20      written permission, please contact info@aetrion.com.
21   
22   4. Products derived from this software may not be called "JPublish", nor
23      may "JPublish" appear in their name, without prior written permission
24      from Aetrion LLC (info@aetrion.com).
25   
26   In addition, the authors of this software request (but do not require) 
27   that you include in the end-user documentation provided with the 
28   redistribution and/or in the software itself an acknowledgement equivalent 
29   to the following:
30       "This product includes software developed by
31        Aetrion LLC (http://www.aetrion.com/)."
32  
33   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36   DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, 
37   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
38   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
39   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
40   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
41   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
42   IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
43   POSSIBILITY OF SUCH DAMAGE.
44  
45   For more information on JPublish, please see <http://www.jpublish.org/>.
46   
47   */
48  
49  package org.jpublish.resource;
50  
51  import java.io.IOException  ;
52  import java.io.OutputStream  ;
53  
54  import org.jpublish.Manager;
55  
56  /**
57   * Interface for accessing static resources.
58   *
59   * @author Anthony Eden
60   */
61  
62  public interface ResourceManager extends Manager {
63  
64      /**
65       * Load the static resource data at the given path and write it to the specified OutputStream.
66       *
67       * @param path The resource path
68       * @param out The OutputStream
69       * @throws IOException Any IOException
70       * @throws ResourceNotFoundException
71       */
72  
73      public void load(String   path, OutputStream   out) throws IOException  ,
74              ResourceNotFoundException;
75  
76      /**
77       * Return true if the resource for the specified path exists.
78       *
79       * @param path The resource path
80       * @return True if the resource exists
81       * @throws IOException
82       */
83  
84      public boolean exists(String   path) throws IOException  ;
85  
86      /**
87       * Get the last modified time of the resource with the given path.  This method should return -1 if the last
88       * modified time is not known.
89       *
90       * @param path The resource path
91       * @return The last modified time
92       * @throws IOException Any IOException
93       */
94  
95      public long getLastModified(String   path) throws IOException  ;
96  
97      /**
98       * Get the content legnth of the resource with the given path.  This method should return -1 if the content length
99       * is not known.
100      *
101      * @param path The resource path
102      * @return The content length
103      * @throws IOException Any IOException
104      */
105 
106     public long getContentLength(String   path) throws IOException  ;
107 
108 }
109
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags