Repository


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.repository;
50  
51  import java.io.IOException  ;
52  
53  import org.jpublish.Manager;
54  
55  /**
56   * A common interface which all repositories must implement.  A Repository represents a data store which contains
57   * content.
58   *
59   * @author Anthony Eden
60   */
61  
62  public interface Repository extends Manager {
63  
64      /**
65       * Get the name of the repository.  This name is used to expose the Repository in the view renderer.
66       *
67       * @return The Repository name
68       */
69  
70      public String   getName();
71  
72      /**
73       * Get a String representation of the content.  This method is a convenience method which can be used to quickly
74       * pull content from a repository.
75       *
76       * @param path The content path
77       * @return The content String
78       * @throws IOException
79       * @throws ContentNotFoundException
80       */
81  
82      public String   get(String   path) throws IOException  , ContentNotFoundException;
83  
84      /**
85       * Get the content from the given path.
86       *
87       * @param path The relative content path
88       * @return The content object
89       * @throws IOException Any IOException
90       * @throws ContentNotFoundException
91       */
92  
93      public Content getContent(String   path)
94              throws IOException  , ContentNotFoundException;
95  
96      /**
97       * Get the last modified time of the content with the given path.  This method may return -1 if the last modified
98       * time is not known.
99       *
100      * @param path The content path
101      * @return The last modified time
102      * @throws IOException Any IOException
103      */
104 
105     public long getLastModified(String   path) throws IOException  ;
106 
107 }
108
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags