com.aspc.webdav

Class STDavResource

java.lang.Object

com.aspc.webdav.STDavResource

public class STDavResource
extends java.lang.Object

Web dav
THREAD MODE: SINGLE-THREADED

Since:

3 Oct 2008

Author:

Lahav

Constructor Summary

Constructors

Constructor and Description
STDavResource(DavResourceLocator davResourceLocator, DavResourceFactory davResourceFactory, LockManager lockManager, STDavSession davSession)

Method Summary

Modifier and Type	Method and Description
void	addLockManager(LockManager lockmgr) Add an external LockManager to this resource.
void	addMember(DavResource resource, InputContext inputContext) Add the given resource as an internal member to this resource.
MultiStatusResponse	alterProperties(DavPropertySet setProperties, DavPropertyNameSet removePropertyNames) Deprecated. use alterProperties(List) instead
MultiStatusResponse	alterProperties(java.util.List changeList) Set/add and remove the specified properties from this resource.
void	copy(DavResource destination, boolean shallow) Copy this DavResource to the given destination resource
static STDavResource	createSimpleResource(DavResourceLocator davResourceLocator, DavResourceFactory davResourceFactory) simple resource is used for OPTIONS request only, it doesn't link with any DBFile or DBFolder
DBFile	createVirtualFile(MutableDataSource mds, java.lang.String fileName, java.lang.String encodedPath)
boolean	exists() Returns true if this webdav resource represents an existing repository item.
DavResource	getCollection() Retrieve the resource this resource is internal member of.
java.lang.String	getComplianceClass() Returns a comma separated list of all compliance classes the given resource is fulfilling.
java.io.InputStream	getContent()
long	getContentLength() get the length of the content
java.lang.String	getContentType() the content type
protected long	getCreationtTime()
DBObject	getDBObject()
Session	getDBSession()
java.lang.String	getDisplayName() Returns the display name of this resource.
java.lang.String	getEtag()
DavResourceFactory	getFactory() Return the DavResourceFactory that created this resource.
java.lang.String	getHref() Returns the absolute href of this resource as returned in the multistatus response body.
DavResourceLocator	getLocator() Returns the locator object for this webdav resource, which encapsulates the information for building the complete 'href'.
ActiveLock	getLock(Type type, Scope scope) Return the lock present on this webdav resource or null if the resource is either not locked or not lockable at all.
LockManager	getLockManager()
ActiveLock[]	getLocks() Returns an array of all locks applied to the given resource.
Login	getLogin()
DavResourceIterator	getMembers() Returns an iterator over all internal members.
long	getModificationTime() Return the time of the last modification or -1 if the modification time could not be retrieved.
protected java.lang.String	getParentResourcePath()
STDavResource	getParentSource() get parent source
DavPropertySet	getProperties() Returns all webdav properties present on this resource.
DavProperty	getProperty(DavPropertyName name) Return the webdav property with the specified name.
DavPropertyName[]	getPropertyNames() Returns an array of all property names available on this resource.
java.lang.String	getResourcePath() Returns the path of the hierarchy element defined by this DavResource.
DavSession	getSession() Retrieve the DavSession associated with this resource.
protected SupportedLock	getSupportedLock()
java.lang.String	getSupportedMethods() Returns a comma separated list of all METHODS supported by the given resource.
protected java.lang.String	getWorkspaceHref()
boolean	hasLock(Type type, Scope scope) Returns true if a lock applies to this resource.
protected void	initProperties(DavPropertySet propertySet)
boolean	isCollection() Returns true if this webdav resource has the resource type 'collection'.
boolean	isLockable(Type type, Scope scope) Returns true, if the this resource allows locking.
java.util.ArrayList	listFiles(DBFolder dbFolder) Returns an array of strings path files in the folder denoted by this path.
java.util.ArrayList	listFolders() Returns an array of strings path folders in the folder denoted by this path.
ActiveLock	lock(LockInfo reqLockInfo) Lock this webdav resource with the information retrieve from the request and return the resulting lock discovery object.
void	move(DavResource destination) Move this DavResource to the given destination resource
ActiveLock	refreshLock(LockInfo reqLockInfo, java.lang.String lockToken) Refresh an existing lock by resetting the timeout.
void	removeMember(DavResource member) Removes the specified member from this resource.
void	removeProperty(DavPropertyName propertyName) Remove the specified property from this resource.
void	setAsVirtualFile(MutableDataSource mds, java.lang.String encodedPath, DBFile file, java.lang.String fileName)
void	setFile(DBFile afile)
void	setLockManager(LockManager lockManager)
void	setProperty(DavProperty property) Add/Set the specified property on this resource.
void	setVirtualName(java.lang.String virtualName)
void	spool(OutputContext outputContext) Spools the resource properties and ev.
java.lang.String	toString()
void	unlock(java.lang.String lockToken) Remove the lock identified by the included lock token from this resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

STDavResource

public STDavResource(DavResourceLocator davResourceLocator,
                     DavResourceFactory davResourceFactory,
                     LockManager lockManager,
                     STDavSession davSession)

Parameters:

davResourceLocator - the locator

davResourceFactory - the factory

lockManager - the lock manager

davSession - the session

Method Detail

createSimpleResource

public static STDavResource createSimpleResource(DavResourceLocator davResourceLocator,
                                                 DavResourceFactory davResourceFactory)

simple resource is used for OPTIONS request only, it doesn't link with any DBFile or DBFolder

Parameters:

davResourceLocator -

davResourceFactory -

Returns:

the value

getDBObject

public DBObject getDBObject()

getDBSession

public Session getDBSession()

Returns:

the session

getLogin

public Login getLogin()

Returns:

the login

getComplianceClass

public java.lang.String getComplianceClass()

Returns a comma separated list of all compliance classes the given resource is fulfilling.

Returns:

compliance classes

getSupportedMethods

public java.lang.String getSupportedMethods()

Returns a comma separated list of all METHODS supported by the given resource.

Returns:

METHODS supported by this resource.

exists

public boolean exists()

Returns true if this webdav resource represents an existing repository item.

Returns:

true, if the resource represents an existing repository item.

isCollection

public boolean isCollection()

Returns true if this webdav resource has the resource type 'collection'.

Returns:

true if the resource represents a collection resource.

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of this resource.

Returns:

display name.

getLocator

public DavResourceLocator getLocator()

Returns the locator object for this webdav resource, which encapsulates the information for building the complete 'href'.

Returns:

the locator for this resource.

See Also:

getResourcePath(), getHref()

getResourcePath

public java.lang.String getResourcePath()

Returns the path of the hierarchy element defined by this DavResource. This method is a shortcut for DavResource.getLocator().getResourcePath().

Returns:

path of the element defined by this DavResource.

getHref

public java.lang.String getHref()

Returns the absolute href of this resource as returned in the multistatus response body.

Returns:

href

getModificationTime

public long getModificationTime()

Return the time of the last modification or -1 if the modification time could not be retrieved.

Returns:

time of last modification or -1.

spool

public void spool(OutputContext outputContext)
           throws java.io.IOException

Spools the resource properties and ev. content to the specified context (e.g. to respond to a 'GET' or 'HEAD' request). The context could e.g. wrap the servlet response.

Parameters:

outputContext - the context

Throws:

java.io.IOException - a problem

getContent

public java.io.InputStream getContent()

Returns:

the content

getContentLength

public long getContentLength()

get the length of the content

Returns:

the length

getContentType

public java.lang.String getContentType()

the content type

Returns:

the type

getEtag

public java.lang.String getEtag()

getPropertyNames

public DavPropertyName[] getPropertyNames()

Returns an array of all property names available on this resource.

Returns:

an array of property names.

getProperty

public DavProperty getProperty(DavPropertyName name)

Return the webdav property with the specified name.

Parameters:

name - name of the webdav property

Returns:

the DavProperty with the given name or null if the property does not exist.

getProperties

public DavPropertySet getProperties()

Returns all webdav properties present on this resource.

Returns:

a DavPropertySet containing all webdav property of this resource.

initProperties

protected void initProperties(DavPropertySet propertySet)
                       throws java.lang.Exception

Parameters:

propertySet - the properties

Throws:

java.lang.Exception - a serious problem.

setProperty

public void setProperty(DavProperty property)
                 throws DavException

Add/Set the specified property on this resource.

Parameters:

property - the property

Throws:

DavException - if an error occurs

removeProperty

public void removeProperty(DavPropertyName propertyName)
                    throws DavException

Remove the specified property from this resource.

Parameters:

propertyName - the name

Throws:

DavException - if an error occurs

alterProperties

public MultiStatusResponse alterProperties(DavPropertySet setProperties,
                                           DavPropertyNameSet removePropertyNames)
                                    throws DavException

Deprecated. use alterProperties(List) instead

Set/add the specified properties and remove the properties with the given names from this resource respectively.

Parameters:

setProperties - Set of properties to be added or modified

removePropertyNames - Set of property names to be removed

Returns:

multistatus response listing the status resulting from setting and/or removing the specified properties, in order to allow a detailed multistatus response.

Throws:

DavException - if an error occurred. This may be the case if the general state of the resource prevents any properties to be set or removed (e.g. due to a lock).

alterProperties

public MultiStatusResponse alterProperties(java.util.List changeList)
                                    throws DavException

Set/add and remove the specified properties from this resource.

Parameters:

changeList - list containing DavPropertyName objects (for properties to be removed) and DavProperty objects (for properties to be added/set).

Returns:

multistatus response listing the status resulting from setting and/or removing the specified properties, in order to allow a detailed multi status response.

Throws:

DavException - if an error occurred. This may be the case if the general state of the resource prevents any properties to be set or removed (e.g. due to a lock).

getCollection

public DavResource getCollection()

Retrieve the resource this resource is internal member of.

Returns:

resource this resource is an internal member of. In case this resource is the root null is returned.

getParentResourcePath

protected java.lang.String getParentResourcePath()

Returns:

the resource path

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the string

addMember

public void addMember(DavResource resource,
                      InputContext inputContext)
               throws DavException

Add the given resource as an internal member to this resource.

Parameters:

resource - DavResource to be added as internal member.

inputContext - Context providing the properties and content for the internal member to be created or replaced.

Throws:

DavException - a problem

getMembers

public DavResourceIterator getMembers()

Returns an iterator over all internal members.

Returns:

a DavResourceIterator over all internal members.

removeMember

public void removeMember(DavResource member)
                  throws DavException

Removes the specified member from this resource.

Parameters:

member - the member

Throws:

DavException - a problem

getParentSource

public STDavResource getParentSource()
                              throws DavException

get parent source

Returns:

parent source, null if no parent

Throws:

DavException

move

public void move(DavResource destination)
          throws DavException

Move this DavResource to the given destination resource

Parameters:

destination - the destination

Throws:

DavException - a problem

copy

public void copy(DavResource destination,
                 boolean shallow)
          throws DavException

Copy this DavResource to the given destination resource

Parameters:

destination - the destination

shallow - shallow only

Throws:

DavException - a problem

isLockable

public boolean isLockable(Type type,
                          Scope scope)

Returns true, if the this resource allows locking. NOTE, that this method does not define, whether a lock/unlock can be successfully executed.

Parameters:

type - the type

scope - the scope

Returns:

true, if this resource supports any locking.

hasLock

public boolean hasLock(Type type,
                       Scope scope)

Returns true if a lock applies to this resource. This may be either a lock on this resource itself or a deep lock inherited from a collection above this resource.
Note, that true is returned whenever a lock applies to that resource even if the lock is expired or not effective due to the fact that the request provides the proper lock token.

Parameters:

type - the type

scope - the scope

Returns:

true if a lock applies to this resource.

getLock

public ActiveLock getLock(Type type,
                          Scope scope)

Return the lock present on this webdav resource or null if the resource is either not locked or not lockable at all. Note, that a resource may have a lock that is inherited by a deep lock enforced on one of its 'parent' resources.

Parameters:

type - the type

scope - the scope

Returns:

lock information of this resource or null if this resource has no lock applying it. If an error occurs while retrieving the lock information null is returned as well.

getLocks

public ActiveLock[] getLocks()

Returns an array of all locks applied to the given resource.

Returns:

array of locks. The array is empty if there are no locks applied to this resource.

lock

public ActiveLock lock(LockInfo reqLockInfo)
                throws DavException

Lock this webdav resource with the information retrieve from the request and return the resulting lock discovery object.

Parameters:

reqLockInfo - lock info as retrieved from the request.

Returns:

lock discovery object to be returned in the response. If the lock could not be obtained a DavException is thrown.

Throws:

DavException - if the lock could not be obtained.

refreshLock

public ActiveLock refreshLock(LockInfo reqLockInfo,
                              java.lang.String lockToken)
                       throws DavException

Refresh an existing lock by resetting the timeout.

Parameters:

reqLockInfo - lock info as retrieved from the request.

lockToken - identifying the lock to be refreshed.

Returns:

lock discovery object to be returned in the response body. If the lock could not be refreshed a DavException is thrown.

Throws:

DavException - if the lock could not be refreshed.

unlock

public void unlock(java.lang.String lockToken)
            throws DavException

Remove the lock identified by the included lock token from this resource. This method will return false if the unlocking did not succeed.

Parameters:

lockToken - identifying the lock to be removed.

Throws:

DavException - if the lock could not be removed.

addLockManager

public void addLockManager(LockManager lockmgr)

Add an external LockManager to this resource. This method may throw UnsupportedOperationException if the resource does handle locking itself.

Parameters:

lockmgr - the manager

See Also:

LockManager

getFactory

public DavResourceFactory getFactory()

Return the DavResourceFactory that created this resource.

Returns:

the factory that created this resource.

getSession

public DavSession getSession()

Retrieve the DavSession associated with this resource.

Returns:

session object associated with this resource.

setLockManager

public void setLockManager(LockManager lockManager)

Parameters:

lockManager - the manager

getLockManager

public LockManager getLockManager()

Returns:

the manager

getCreationtTime

protected long getCreationtTime()

Returns:

the time

getWorkspaceHref

protected java.lang.String getWorkspaceHref()

Returns:

the ref

getSupportedLock

protected SupportedLock getSupportedLock()

Returns:

the supported locks

listFolders

public java.util.ArrayList listFolders()
                                throws java.lang.Exception

Returns an array of strings path folders in the folder denoted by this path.

Returns:

an array of strings naming the folders in the folder denoted by this path.

Throws:

java.lang.Exception - Exception A serious problem

listFiles

public java.util.ArrayList listFiles(DBFolder dbFolder)
                              throws java.lang.Exception

Returns an array of strings path files in the folder denoted by this path.

Parameters:

dbFolder - the folder.

Returns:

an array of strings naming the files in the folder denoted by this path.

Throws:

java.lang.Exception - a problem

setVirtualName

public void setVirtualName(java.lang.String virtualName)

setFile

public void setFile(DBFile afile)

createVirtualFile

public DBFile createVirtualFile(MutableDataSource mds,
                                java.lang.String fileName,
                                java.lang.String encodedPath)
                         throws java.lang.Exception

Throws:

java.lang.Exception

setAsVirtualFile

public void setAsVirtualFile(MutableDataSource mds,
                             java.lang.String encodedPath,
                             DBFile file,
                             java.lang.String fileName)
                      throws java.lang.Exception

Throws:

java.lang.Exception