nl.info.webdav.IWebdavStore Maven / Gradle / Ivy
/*
* $Header: /Users/ak/temp/cvs2svn/webdav-servlet/src/main/java/net/sf/webdav/IWebdavStore.java,v 1.1 2008-08-05 07:38:42 bauhardt Exp $
* $Revision: 1.1 $
* $Date: 2008-08-05 07:38:42 $
*
* ====================================================================
*
* Copyright 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package nl.info.webdav;
import nl.info.webdav.exceptions.WebdavException;
import java.io.InputStream;
import java.security.Principal;
/**
* Interface for simple webdav store implementations.
*
* Based on the BasicWebdavStore from Oliver Zeigermann, that was part of the
* Webdav Construction Kit.
*/
public interface IWebdavStore {
/**
* Life cycle method, called by WebdavServlet's destroy() method. Should be used to clean up resources.
*/
void destroy();
/**
* Indicates that a new request or transaction with this store involved has
* been started. The request will be terminated by either {@link #commit(ITransaction)} mmi}
* or {@link #rollback(ITransaction)}. If only non-read methods have been called, the
* request will be terminated by a {@link #commit(ITransaction)}. This method will be
* called by (@link WebdavStoreAdapter} at the beginning of each request.
*
* @param principal
* the principal that started this request or null if
* there is none available
*
* @throws WebdavException
* if something goes wrong on the store level
*/
ITransaction begin(Principal principal) throws WebdavException;
/**
* Checks if authentication information passed in is valid. If not throws an
* exception.
*
* @param transaction
* indicates that the method is within the scope of a WebDAV
* transaction
*/
void checkAuthentication(ITransaction transaction);
/**
* Indicates that all changes done inside this request shall be made
* permanent and any transactions, connections and other temporary resources
* shall be terminated.
*
* @param transaction
* indicates that the method is within the scope of a WebDAV
* transaction
*
* @throws WebdavException
* if something goes wrong on the store level
*/
void commit(ITransaction transaction) throws WebdavException;
/**
* Indicates that all changes done inside this request shall be undone and
* any transactions, connections and other temporary resources shall be
* terminated.
*
* @param transaction
* indicates that the method is within the scope of a WebDAV
* transaction
*
* @throws WebdavException
* if something goes wrong on the store level
*/
void rollback(ITransaction transaction) throws WebdavException;
/**
* Creates a folder at the position specified by folderUri.
*
* @param transaction
* indicates that the method is within the scope of a WebDAV
* transaction
* @param folderUri
* URI of the folder
* @throws WebdavException
* if something goes wrong on the store level
*/
void createFolder(ITransaction transaction, String folderUri) throws WebdavException;
/**
* Creates a content resource at the position specified by
* resourceUri.
*
* @param transaction
* indicates that the method is within the scope of a WebDAV
* transaction
* @param resourceUri
* URI of the content resource
* @throws WebdavException
* if something goes wrong on the store level
*/
void createResource(ITransaction transaction, String resourceUri) throws WebdavException;
/**
* Gets the content of the resource specified by resourceUri.
*
* @param transaction
* indicates that the method is within the scope of a WebDAV
* transaction
* @param resourceUri
* URI of the content resource
* @return input stream you can read the content of the resource from
* @throws WebdavException
* if something goes wrong on the store level
*/
InputStream getResourceContent(ITransaction transaction, String resourceUri) throws WebdavException;
/**
* Sets / stores the content of the resource specified by
* resourceUri.
*
* @param transaction
* indicates that the method is within the scope of a WebDAV
* transaction
* @param resourceUri
* URI of the resource where the content will be stored
* @param content
* input stream from which the content will be read from
* @param contentType
* content type of the resource or null if unknown
* @param characterEncoding
* character encoding of the resource or null if unknown
* or not applicable
* @return length of the resource
* @throws WebdavException
* if something goes wrong on the store level
*/
long setResourceContent(
ITransaction transaction,
String resourceUri,
InputStream content,
String contentType,
String characterEncoding
) throws WebdavException;
/**
* Gets the names of the children of the folder specified by
* folderUri.
*
* @param transaction
* indicates that the method is within the scope of a WebDAV
* transaction
* @param folderUri
* URI of the folder
* @return a (possibly empty) list of children, or null if the
* uri points to a file
* @throws WebdavException
* if something goes wrong on the store level
*/
String[] getChildrenNames(ITransaction transaction, String folderUri) throws WebdavException;
/**
* Gets the length of the content resource specified by
* resourceUri.
*
* @param transaction
* indicates that the method is within the scope of a WebDAV
* transaction
* @param path
* URI of the content resource
* @return length of the resource in bytes, -1 declares this
* value as invalid and asks the adapter to try to set it from the
* properties if possible
* @throws WebdavException
* if something goes wrong on the store level
*/
long getResourceLength(ITransaction transaction, String path) throws WebdavException;
/**
* Removes the object specified by uri.
*
* @param transaction
* indicates that the method is within the scope of a WebDAV
* transaction
* @param uri
* URI of the object, i.e. content resource or folder
* @throws WebdavException
* if something goes wrong on the store level
*/
void removeObject(ITransaction transaction, String uri) throws WebdavException;
/**
* Gets the storedObject specified by uri
*
* @param transaction
* indicates that the method is within the scope of a WebDAV
* transaction
* @param uri
* URI
* @return StoredObject
*/
StoredObject getStoredObject(ITransaction transaction, String uri);
}