nl.buildersenperformers.chydav
Class ChyWebdavStore

java.lang.Object
  nl.buildersenperformers.chydav.ChyWebdavStore

All Implemented Interfaces:

IWebdavStore

public class ChyWebdavStore
extends Object
implements IWebdavStore

Author:

Administrator

Constructor Summary

ChyWebdavStore(File root)

Method Summary

ITransaction	begin(Principal principal) Indicates that a new request or transaction with this store involved has been started.
void	checkAuthentication(ITransaction pArg0) Checks if authentication information passed in is valid.
void	commit(ITransaction pArg0) Indicates that all changes done inside this request shall be made permanent and any transactions, connections and other temporary resources shall be terminated.
void	createFolder(ITransaction pArg0, String pArg1) Creates a folder at the position specified by folderUri.
void	createResource(ITransaction pArg0, String path) Creates a content resource at the position specified by resourceUri.
String[]	getChildrenNames(ITransaction trx, String path) Gets the names of the children of the folder specified by folderUri.
InputStream	getResourceContent(ITransaction trx, String path) Gets the content of the resource specified by resourceUri.
long	getResourceLength(ITransaction pArg0, String path) Gets the length of the content resource specified by resourceUri.
StoredObject	getStoredObject(ITransaction trx, String path) Gets the storedObject specified by uri
void	removeObject(ITransaction pArg0, String pArg1) Removes the object specified by uri.
void	rollback(ITransaction pArg0) Indicates that all changes done inside this request shall be undone and any transactions, connections and other temporary resources shall be terminated.
long	setResourceContent(ITransaction trx, String uri, InputStream content, String contentType, String characterEncoding) Sets / stores the content of the resource specified by resourceUri.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChyWebdavStore

public ChyWebdavStore(File root)

Method Detail

begin

public ITransaction begin(Principal principal)

Description copied from interface: IWebdavStore

Indicates that a new request or transaction with this store involved has been started. The request will be terminated by either #commit() or #rollback(). If only non-read methods have been called, the request will be terminated by a #commit(). This method will be called by (@link WebdavStoreAdapter} at the beginning of each request.

Specified by:

begin in interface IWebdavStore

Parameters:

principal - the principal that started this request or null if there is non available

checkAuthentication

public void checkAuthentication(ITransaction pArg0)

Description copied from interface: IWebdavStore

Checks if authentication information passed in is valid. If not throws an exception.

Specified by:

checkAuthentication in interface IWebdavStore

Parameters:

pArg0 - indicates that the method is within the scope of a WebDAV transaction

commit

public void commit(ITransaction pArg0)

Description copied from interface: IWebdavStore

Indicates that all changes done inside this request shall be made permanent and any transactions, connections and other temporary resources shall be terminated.

Specified by:

commit in interface IWebdavStore

Parameters:

pArg0 - indicates that the method is within the scope of a WebDAV transaction

createFolder

public void createFolder(ITransaction pArg0,
                         String pArg1)

Description copied from interface: IWebdavStore

Creates a folder at the position specified by folderUri.

Specified by:

createFolder in interface IWebdavStore

Parameters:

pArg0 - indicates that the method is within the scope of a WebDAV transaction

pArg1 - URI of the folder

createResource

public void createResource(ITransaction pArg0,
                           String path)

Description copied from interface: IWebdavStore

Creates a content resource at the position specified by resourceUri.

Specified by:

createResource in interface IWebdavStore

Parameters:

pArg0 - indicates that the method is within the scope of a WebDAV transaction

path - URI of the content resource

getChildrenNames

public String[] getChildrenNames(ITransaction trx,
                                 String path)

Description copied from interface: IWebdavStore

Gets the names of the children of the folder specified by folderUri.

Specified by:

getChildrenNames in interface IWebdavStore

Parameters:

trx - indicates that the method is within the scope of a WebDAV transaction

path - URI of the folder

Returns:

a (possibly empty) list of children, or null if the uri points to a file

getResourceContent

public InputStream getResourceContent(ITransaction trx,
                                      String path)

Description copied from interface: IWebdavStore

Gets the content of the resource specified by resourceUri.

Specified by:

getResourceContent in interface IWebdavStore

Parameters:

trx - indicates that the method is within the scope of a WebDAV transaction

path - URI of the content resource

Returns:

input stream you can read the content of the resource from

getResourceLength

public long getResourceLength(ITransaction pArg0,
                              String path)

Description copied from interface: IWebdavStore

Gets the length of the content resource specified by resourceUri.

Specified by:

getResourceLength in interface IWebdavStore

Parameters:

pArg0 - indicates that the method is within the scope of a WebDAV transaction

Returns:

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

getStoredObject

public StoredObject getStoredObject(ITransaction trx,
                                    String path)

Description copied from interface: IWebdavStore

Gets the storedObject specified by uri

Specified by:

getStoredObject in interface IWebdavStore

Parameters:

trx - indicates that the method is within the scope of a WebDAV transaction

path - URI

Returns:

StoredObject

removeObject

public void removeObject(ITransaction pArg0,
                         String pArg1)

Description copied from interface: IWebdavStore

Removes the object specified by uri.

Specified by:

removeObject in interface IWebdavStore

Parameters:

pArg0 - indicates that the method is within the scope of a WebDAV transaction

pArg1 - URI of the object, i.e. content resource or folder

rollback

public void rollback(ITransaction pArg0)

Description copied from interface: IWebdavStore

Indicates that all changes done inside this request shall be undone and any transactions, connections and other temporary resources shall be terminated.

Specified by:

rollback in interface IWebdavStore

Parameters:

pArg0 - indicates that the method is within the scope of a WebDAV transaction

setResourceContent

public long setResourceContent(ITransaction trx,
                               String uri,
                               InputStream content,
                               String contentType,
                               String characterEncoding)

Description copied from interface: IWebdavStore

Sets / stores the content of the resource specified by resourceUri.

Specified by:

setResourceContent in interface IWebdavStore

Parameters:

trx - indicates that the method is within the scope of a WebDAV transaction

uri - URI of the resource where the content will be stored

content - input stream from which the content will be read from

contentType - content type of the resource or null if unknown

characterEncoding - character encoding of the resource or null if unknown or not applicable

Returns:

lenght of resource