WebdavResource (JCMS API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.jalios.jcms.webdav
Class WebdavResource

java.lang.Object
  com.jalios.jcms.webdav.WebdavResource

All Implemented Interfaces:: Comparable

Direct Known Subclasses:: CatWebdavResource, FileWebdavResource

public abstract class WebdavResource
extends Object
implements Comparable
extends Object
implements Comparable

This class is an Abstract Representation of a Webdav Resource doing all webdav specific task or delegating to WebdavFileSystem. It must be overrided by sub level Content Management Implementation.

Since:: jcms-5.5.0
Version:: $Revision: 17598 $
Author:: Jean-Philippe Encausse

Field Summary
`protected boolean`	`possibleFile`
`static String`	`REVISION`
`protected String`	`uri`

Constructor Summary
`protected`	`WebdavResource(String uri, WebdavContext ctxt)` The resource must be a relative URI to the path folders starting and ending by '/'.

Method Summary
`int`	`compareTo(Object obj)`
`boolean`	`equals(Object obj)`
`abstract Collection`	`getChildren(WebdavContext ctxt)` Return all the Children of the resource.
`String`	`getContentLanguage(WebdavContext ctxt)` This method will return the content language Default implementation return null
`abstract long`	`getContentLength(WebdavContext ctxt)` Return the size of the resource or 0 if there is no content
`abstract String`	`getContentType(WebdavContext ctxt)` This method have to return the Content Type of the resource with the Content Encoding ie "text/html; charset=UTF-8" It is the media type defined in section 3.7 of [RFC2068] If no content type then return ""
`abstract long`	`getCreationDate(WebdavContext ctxt)` Return long representing the Creation of the resource It contains a timestamp of the moment when the resource was created (i.e., the moment it had non-null state).
`Collection`	`getDescendantLocks(WebdavContext ctxt)` Convenient method that delegate call to the WebdavFileSystem
`String`	`getETag(boolean strong, WebdavContext ctxt)` Return a etag representation usefull not to be read-only with ms-word
`long`	`getLastAccessed(WebdavContext ctxt)` This method will return a long representing the last time this resource was accessed.
`abstract long`	`getLastModified(WebdavContext ctxt)` Return long representing the LastModified of the resource Note that the last-modified date on a resource may reflect changes in any part of the state of the resource, not necessarily just a change to the response to the GET method.
`WebdavLock`	`getLock(WebdavContext ctxt)` Convenient method that delegate call to the WebdavFileSystem
`Collection`	`getLocks(WebdavContext ctxt)` Convenient method that delegate call to the WebdavFileSystem
`String`	`getName(WebdavContext ctxt)` This method will return the name of the resource ie /my/path/resource.ext -> resource.ext ie /my/path/ -> path
`WebdavResource`	`getParent(WebdavContext ctxt)` This method will return the Parent WebdavResource of the resource.
`String`	`getPath(WebdavContext ctxt)` This method will return the path of the resource ie /my/path/resource.ext -> /my/path/resource.ext ie /my/path/ -> /my/path/
`abstract InputStream`	`getResourceStream(WebdavContext ctxt)` This method have to return an InputStream on the resource.
`boolean`	`hasLock(WebdavContext ctxt, boolean exclusive)` This method will check if this resource has locks for the resource.
`abstract boolean`	`isExisting(WebdavContext ctxt)` Check if the resource exists in the UserFileSystem This method is abstract and must be implemented by the UserFileSystem.
`boolean`	`isFile(WebdavContext ctxt)` This method will check if the resource is a File or a Folder.
`boolean`	`isFolder(WebdavContext ctxt)` This method will check if the resource is a File or a Folder.
`boolean`	`isHidden(WebdavContext ctxt)` This method will return true if the resource isHidden.
`boolean`	`isLocked(WebdavContext ctxt, boolean ifheader, boolean byMe, boolean only)` This method will check if this resource is locked by me or other only or not.
`int`	`isMatchLocked(WebdavContext ctxt, boolean ifheader, boolean byMe, boolean only)` This method will check if this resource is locked by me or other only or not.
`boolean`	`isPossibleFile()`
`boolean`	`isReadable(boolean recursive, WebdavContext ctxt)` This method will return true if the resource can be read by the context.
`boolean`	`isWritable(boolean recursive, boolean overwrite, WebdavContext ctxt)` This method will return true if the resource can be write by the context.
`protected boolean`	`matchLockToken(Collection tokens, String ifHeader)`
`WebdavLock`	`putLock(WebdavLock lock, WebdavContext ctxt)` Convenient method that delegate call to the WebdavFileSystem
`WebdavLock`	`putLocks(WebdavLock lock, WebdavContext ctxt)` Convenient method that delegate call to the WebdavFileSystem
`void`	`setPath(String uri, WebdavContext ctxt)`
`void`	`setPossibleContent(boolean isFile)` Used by creation method to define the content may be a File or a Folder.
`abstract boolean`	`setResourceStream(InputStream in, WebdavContext ctxt)` This method have to return an InputStream on the resource.
`String`	`toString()` Override the toString() method

Methods inherited from class java.lang.Object
`clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

REVISION

public static final String REVISION

See Also:: Constant Field Values

uri

protected String uri

possibleFile

protected boolean possibleFile

Constructor Detail

WebdavResource

protected WebdavResource(String uri,
                         WebdavContext ctxt)

The resource must be a relative URI to the path folders starting and ending by '/'. ie /my/path/resource.ext -> /my/path/resource.ext
ie /my/path/ -> /my/path/

Parameters:: uri - the resource uri; ctxt - the Webdav Context
See Also:: WebdavFileSystem.getResource(String, WebdavContext)

Method Detail