001: /*
002: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: * Free SoftwareFoundation, Inc.
023: * 59 Temple Place, Suite 330
024: * Boston, MA 02111-1307 USA
025: *
026: * @author Scott Ferguson
027: */
028:
029: package com.caucho.servlets.webdav;
030:
031: import com.caucho.log.Log;
032: import com.caucho.util.NullIterator;
033:
034: import javax.servlet.ServletContext;
035: import javax.servlet.http.HttpServletRequest;
036: import java.io.IOException;
037: import java.io.InputStream;
038: import java.io.OutputStream;
039: import java.util.Iterator;
040: import java.util.logging.Logger;
041:
042: /**
043: * Represents a virtual filesystem.
044: */
045: public abstract class AbstractPath {
046: protected static final Logger log = Log.open(AbstractPath.class);
047:
048: /**
049: * Returns true if the named file is a file.
050: *
051: * @param path the requested relative path
052: * @param request the servlet request
053: * @param app the servlet context
054: */
055: public abstract boolean isFile(String path,
056: HttpServletRequest request, ServletContext app)
057: throws IOException;
058:
059: /**
060: * Returns true if the named file is a directory.
061: *
062: * @param path the requested relative path
063: * @param request the servlet request
064: * @param app the servlet context
065: */
066: public abstract boolean isDirectory(String path,
067: HttpServletRequest request, ServletContext app)
068: throws IOException;
069:
070: /**
071: * Returns true if the file can be read.
072: *
073: * @param path the requested relative path
074: * @param request the servlet request
075: * @param app the servlet context
076: */
077: public abstract boolean canRead(String path,
078: HttpServletRequest request, ServletContext app)
079: throws IOException;
080:
081: /**
082: * Returns true if the file exists.
083: *
084: * @param path the requested relative path
085: * @param request the servlet request
086: * @param app the servlet context
087: */
088: public abstract boolean exists(String path,
089: HttpServletRequest request, ServletContext app)
090: throws IOException;
091:
092: /**
093: * Returns the length of the named file.
094: *
095: * @param path the requested relative path
096: * @param request the servlet request
097: * @param app the servlet context
098: */
099: public abstract long getLength(String path,
100: HttpServletRequest request, ServletContext app)
101: throws IOException;
102:
103: /**
104: * Returns the last modified time of the named file.
105: *
106: * @param path the requested relative path
107: * @param request the servlet request
108: * @param app the servlet context
109: */
110: public abstract long getLastModified(String path,
111: HttpServletRequest request, ServletContext app)
112: throws IOException;
113:
114: /**
115: * Returns an iterator over the attribute names.
116: * Each attribute name is of the type AttributeName.
117: *
118: * @param path the requested relative path
119: * @param request the servlet request
120: * @param app the servlet context
121: */
122: public Iterator getAttributeNames(String path,
123: HttpServletRequest request, ServletContext app)
124: throws IOException {
125: return NullIterator.create();
126: }
127:
128: /**
129: * Returns an attribute value.
130: *
131: * @param name the attribute name
132: * @param path the requested relative path
133: * @param request the servlet request
134: * @param app the servlet context
135: */
136: public String getAttribute(AttributeName name, String path,
137: HttpServletRequest request, ServletContext app)
138: throws IOException {
139: return null;
140: }
141:
142: /**
143: * Sets an attribute value.
144: *
145: * @param name the attribute name
146: * @param value the attribute value
147: * @param path the requested relative path
148: * @param request the servlet request
149: * @param app the servlet context
150: *
151: * @return true if the setting was successful
152: */
153: public boolean setAttribute(AttributeName name, String value,
154: String path, HttpServletRequest request, ServletContext app)
155: throws IOException {
156: return false;
157: }
158:
159: /**
160: * Removes an attribute value.
161: *
162: * @param name the attribute name
163: * @param path the requested relative path
164: * @param request the servlet request
165: * @param app the servlet context
166: */
167: public boolean removeAttribute(AttributeName name, String path,
168: HttpServletRequest request, ServletContext app)
169: throws IOException {
170: return false;
171: }
172:
173: /**
174: * Returns a list of the files in the directory.
175: *
176: * @param path the requested relative path
177: * @param request the servlet request
178: * @param app the servlet context
179: */
180: public abstract String[] list(String path,
181: HttpServletRequest request, ServletContext app)
182: throws IOException;
183:
184: /**
185: * Creates the named directory.
186: *
187: * @param path the requested relative path
188: * @param request the servlet request
189: * @param app the servlet context
190: *
191: * @return true if the creation succeeded.
192: */
193: public abstract boolean mkdir(String path,
194: HttpServletRequest request, ServletContext app)
195: throws IOException;
196:
197: /**
198: * Removes the named directory.
199: *
200: * @param path the requested relative path
201: * @param request the servlet request
202: * @param app the servlet context
203: *
204: * @return true if the remove succeeded.
205: */
206: public abstract boolean rmdir(String path,
207: HttpServletRequest request, ServletContext app)
208: throws IOException;
209:
210: /**
211: * Renames the file without forcing a copy. If rename returns true,
212: * use copy instead.
213: *
214: * @param path the requested relative path
215: * @param destination the new name
216: * @param request the servlet request
217: * @param app the servlet context
218: *
219: * @return true if the remove succeeded.
220: */
221: public boolean rename(String path, String destination,
222: HttpServletRequest request, ServletContext app)
223: throws IOException {
224: return false;
225: }
226:
227: /**
228: * Deletes the file
229: *
230: * @param path the requested relative path
231: * @param request the servlet request
232: * @param app the servlet context
233: *
234: * @return true if the remove succeeded.
235: */
236: public abstract boolean remove(String path,
237: HttpServletRequest request, ServletContext app)
238: throws IOException;
239:
240: /**
241: * Opens an OutputStream for writing.
242: *
243: * @param path the requested relative path
244: * @param request the servlet request
245: * @param app the servlet context
246: *
247: * @return the output stream to the resource.
248: */
249: public abstract OutputStream openWrite(String path,
250: HttpServletRequest request, ServletContext app)
251: throws IOException;
252:
253: /**
254: * Opens an InputStream for reading
255: *
256: * @param path the requested relative path
257: * @param request the servlet request
258: * @param app the servlet context
259: *
260: * @return the input stream to the resource.
261: */
262: public abstract InputStream openRead(String path,
263: HttpServletRequest request, ServletContext app)
264: throws IOException;
265:
266: /**
267: * Cleans up when no longer needed.
268: */
269: public void destroy() {
270: }
271: }
|