org.opencrx.application.webdav

Class WebDavStore

java.lang.Object

org.opencrx.application.webdav.WebDavStore

All Implemented Interfaces:

WebDavStore

public class WebDavStore
extends Object
implements WebDavStore

WebDavStore

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencrx.application.uses.net.sf.webdav.WebDavStore

WebDavStore.ResourceContent, WebDavStore.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.jdo.PersistenceManagerFactory	pmf

Constructor Summary

Constructors

Constructor and Description
WebDavStore(javax.jdo.PersistenceManagerFactory pmf)

Method Summary

Methods

Modifier and Type	Method and Description
RequestContext	begin(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Indicates that a new request or transaction with this store involved has been started.
void	commit(RequestContext requestContext) Indicates that all changes done inside this request shall be made permanent and any transactions, connections and other temporary resources shall be terminated.
void	createCollection(RequestContext requestContext, String path) Creates a folder at the position specified by folderUri.
Collection<Resource>	getChildren(RequestContext requestContext, Resource res, Date timeRangeStart, Date timeRangeEnd) Gets the names of the children of the folder specified by folderUri.
List<Lock>	getLocksByPath(RequestContext requestContext, String path) Gets the LockedObject on specified path.
String	getMimeType(Resource res) Gets mime type of stored object.
protected String	getParentPath(String path)
static javax.jdo.PersistenceManager	getPersistenceManager(javax.servlet.http.HttpServletRequest req, javax.jdo.PersistenceManagerFactory pmf)
Resource	getResourceByPath(RequestContext requestContext, String path) Path is of the form: {provider.id} "/" {segment.id} ["/user/"] {user.id} ["/profile/"] {profile.name} "/" {feed.name} ["/" {folder.name} ]* "/" {document.name}
WebDavStore.ResourceContent	getResourceContent(RequestContext requestContext, Resource res)
Lock	lock(RequestContext requestContext, String path, String id, String owner, String scope, String type, int depth, int timeout) Tries to lock the resource at "path".
WebDavStore.Status	moveResource(RequestContext requestContext, Resource sourceRes, String sourcePath, String destinationPath) Moves the resource from sourcePath to destinationPath
WebDavStore.Status	putResource(RequestContext requestContext, String path, InputStream content, String contentType)
WebDavStore.Status	removeResource(RequestContext requestContext, String path, Resource res) Removes the object specified by uri.
void	rollback(RequestContext requestContext) Indicates that all changes done inside this request shall be undone and any transactions, connections and other temporary resources shall be terminated.
boolean	unlock(RequestContext requestContext, String path, String id) Unlocks all resources at "path" (and all subfolders if existing) that have the same owner.

Methods inherited from class java.lang.Object

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

Field Detail

pmf

protected javax.jdo.PersistenceManagerFactory pmf

Constructor Detail

WebDavStore

public WebDavStore(javax.jdo.PersistenceManagerFactory pmf)

Parameters:

pmf -

Method Detail

getPersistenceManager

public static javax.jdo.PersistenceManager getPersistenceManager(javax.servlet.http.HttpServletRequest req,
                                                 javax.jdo.PersistenceManagerFactory pmf)

Parameters:

req -

pmf -

Returns:

begin

public RequestContext begin(javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse resp)

Description copied from interface: WebDavStore

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

Specified by:

begin in interface WebDavStore

commit

public void commit(RequestContext requestContext)

Description copied from interface: WebDavStore

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 WebDavStore

Parameters:

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

createCollection

public void createCollection(RequestContext requestContext,
                    String path)

Description copied from interface: WebDavStore

Creates a folder at the position specified by folderUri.

Specified by:

createCollection in interface WebDavStore

Parameters:

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

path - URI of the folder

getChildren

public Collection<Resource> getChildren(RequestContext requestContext,
                               Resource res,
                               Date timeRangeStart,
                               Date timeRangeEnd)

Description copied from interface: WebDavStore

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

Specified by:

getChildren in interface WebDavStore

Parameters:

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

timeRangeStart - include children starting from

timeRangeEnd - include children end at

Returns:

a (possibly empty) list of children

getResourceContent

public WebDavStore.ResourceContent getResourceContent(RequestContext requestContext,
                                             Resource res)

Specified by:

getResourceContent in interface WebDavStore

getResourceByPath

public Resource getResourceByPath(RequestContext requestContext,
                         String path)

Path is of the form: {provider.id} "/" {segment.id} ["/user/"] {user.id} ["/profile/"] {profile.name} "/" {feed.name} ["/" {folder.name} ]* "/" {document.name}

Specified by:

getResourceByPath in interface WebDavStore

Parameters:

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

path - URI

Returns:

StoredObject

removeResource

public WebDavStore.Status removeResource(RequestContext requestContext,
                                String path,
                                Resource res)

Description copied from interface: WebDavStore

Removes the object specified by uri.

Specified by:

removeResource in interface WebDavStore

Parameters:

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

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

moveResource

public WebDavStore.Status moveResource(RequestContext requestContext,
                              Resource sourceRes,
                              String sourcePath,
                              String destinationPath)

Description copied from interface: WebDavStore

Moves the resource from sourcePath to destinationPath

Specified by:

moveResource in interface WebDavStore

rollback

public void rollback(RequestContext requestContext)

Description copied from interface: WebDavStore

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 WebDavStore

Parameters:

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

getMimeType

public String getMimeType(Resource res)

Description copied from interface: WebDavStore

Gets mime type of stored object.

Specified by:

getMimeType in interface WebDavStore

getParentPath

protected String getParentPath(String path)

Parameters:

path -

Returns:

putResource

public WebDavStore.Status putResource(RequestContext requestContext,
                             String path,
                             InputStream content,
                             String contentType)

Specified by:

putResource in interface WebDavStore

getLocksByPath

public List<Lock> getLocksByPath(RequestContext requestContext,
                        String path)

Description copied from interface: WebDavStore

Gets the LockedObject on specified path.

Specified by:

getLocksByPath in interface WebDavStore

path - Path to requested resource

Returns:

LockedObject or null if no LockedObject on specified path exists

lock

public Lock lock(RequestContext requestContext,
        String path,
        String id,
        String owner,
        String scope,
        String type,
        int depth,
        int timeout)
          throws LockFailedException

Description copied from interface: WebDavStore

Tries to lock the resource at "path".

Specified by:

lock in interface WebDavStore

path - what resource to lock

owner - the owner of the lock

depth - depth

timeout - Lock Duration in seconds.

Returns:

true if the resource at path was successfully locked, false if an existing lock prevented this

Throws:

LockFailedException

unlock

public boolean unlock(RequestContext requestContext,
             String path,
             String id)

Description copied from interface: WebDavStore

Unlocks all resources at "path" (and all subfolders if existing)

that have the same owner.

Specified by:

unlock in interface WebDavStore

id - id to the resource to unlock