org.apache.jackrabbit.webdav.jcr

Class EventJournalResourceImpl

java.lang.Object

org.apache.jackrabbit.webdav.jcr.EventJournalResourceImpl

All Implemented Interfaces:

org.apache.jackrabbit.webdav.DavResource, org.apache.jackrabbit.webdav.search.SearchResource, org.apache.jackrabbit.webdav.transaction.TransactionResource, org.apache.jackrabbit.webdav.version.DeltaVResource

public class EventJournalResourceImpl
extends Object

Implements a JCR EventJournal in terms of an RFC 4287 Atom feed.

Each feed entry represents either a single event, or, if the repository supports the Event.PERSIST event, an event bundle. The actual event data is sent in the Atom <content> element and uses the same XML serialization as the one used for subscriptions.

Skipping is implemented by specifying the desired time offset (represented as hexadecimal long in ms since the epoch) disguised as ETag in the HTTP "If-None-Match" header field.

The generated feed may not be complete; the total number of events is limited in order not to overload the client.

Furthermore, the number of events is limited by going up to 2000 ms into the future (based on the request time). This is supposed to limit the wait time for the client).

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENTMEDIATYPE
protected boolean	initedProps
protected org.apache.jackrabbit.webdav.property.DavPropertyNameSet	names
protected org.apache.jackrabbit.webdav.property.DavPropertySet	properties
static String	RELURIFROMWORKSPACE
protected org.apache.jackrabbit.webdav.lock.SupportedLock	supportedLock
protected org.apache.jackrabbit.webdav.version.report.SupportedReportSetProperty	supportedReports

Fields inherited from interface org.apache.jackrabbit.webdav.transaction.TransactionResource

METHODS

Fields inherited from interface org.apache.jackrabbit.webdav.version.DeltaVResource

METHODS, METHODS_INCL_MKWORKSPACE

Fields inherited from interface org.apache.jackrabbit.webdav.search.SearchResource

METHODS

Method Summary

Methods

Modifier and Type	Method and Description
void	addLockManager(org.apache.jackrabbit.webdav.lock.LockManager lockMgr)
void	addMember(org.apache.jackrabbit.webdav.DavResource resource, org.apache.jackrabbit.webdav.io.InputContext inputContext)
void	addWorkspace(org.apache.jackrabbit.webdav.DavResource workspace) The JCR api does not provide methods to create new workspaces.
org.apache.jackrabbit.webdav.MultiStatusResponse	alterProperties(List<? extends org.apache.jackrabbit.webdav.property.PropEntry> changeList) Throws HttpServletResponse.SC_METHOD_NOT_ALLOWED
void	copy(org.apache.jackrabbit.webdav.DavResource destination, boolean shallow) Throws HttpServletResponse.SC_METHOD_NOT_ALLOWED
protected org.apache.jackrabbit.webdav.DavResource	createResourceFromLocator(org.apache.jackrabbit.webdav.DavResourceLocator loc) Create a new DavResource from the given locator.
boolean	exists()
org.apache.jackrabbit.webdav.DavResource	getCollection()
String	getComplianceClass() Returns a string listing the compliance classes for this resource as it is required for the DAV response header.
protected String	getCreationDate() Returns the creation date which is used for the DavPropertyName.CREATIONDATE property.
protected String	getCreatorDisplayName() Returns the display name of the creator which is used for the protected DeltaVConstants.CREATOR_DISPLAYNAME property.
String	getDisplayName()
org.apache.jackrabbit.webdav.DavResourceFactory	getFactory()
String	getHref()
org.apache.jackrabbit.webdav.DavResourceLocator	getLocator()
protected org.apache.jackrabbit.webdav.DavResourceLocator	getLocatorFromItem(Item repositoryItem) Build a new DavResourceLocator from the given repository item.
protected org.apache.jackrabbit.webdav.DavResourceLocator	getLocatorFromItemPath(String itemPath) Build a DavResourceLocator from the given itemPath path.
org.apache.jackrabbit.webdav.lock.ActiveLock	getLock(org.apache.jackrabbit.webdav.lock.Type type, org.apache.jackrabbit.webdav.lock.Scope scope)
org.apache.jackrabbit.webdav.lock.ActiveLock[]	getLocks()
org.apache.jackrabbit.webdav.DavResourceIterator	getMembers()
long	getModificationTime()
org.apache.jackrabbit.webdav.version.OptionsResponse	getOptionResponse(org.apache.jackrabbit.webdav.version.OptionsInfo optionsInfo)
org.apache.jackrabbit.webdav.property.DavPropertySet	getProperties()
org.apache.jackrabbit.webdav.property.DavProperty<?>	getProperty(org.apache.jackrabbit.webdav.property.DavPropertyName name)
org.apache.jackrabbit.webdav.property.DavPropertyName[]	getPropertyNames()
org.apache.jackrabbit.webdav.search.QueryGrammerSet	getQueryGrammerSet()
org.apache.jackrabbit.webdav.DavResource[]	getReferenceResources(org.apache.jackrabbit.webdav.property.DavPropertyName hrefPropertyName) Return an array of DavResource objects that are referenced by the property with the specified name.
org.apache.jackrabbit.webdav.version.report.Report	getReport(org.apache.jackrabbit.webdav.version.report.ReportInfo reportInfo)
protected Session	getRepositorySession() Shortcut for getSession().getRepositorySession()
String	getResourcePath() Returns the path of the underlying repository item or the item to be created (PUT/MKCOL).
org.apache.jackrabbit.webdav.DavSession	getSession()
String	getSupportedMethods()
String	getTransactionId()
protected String	getWorkspaceHref() Retrieve the href of the workspace the current session belongs to.
boolean	hasLock(org.apache.jackrabbit.webdav.lock.Type type, org.apache.jackrabbit.webdav.lock.Scope scope) Returns true if this resource has a lock applied with the given type and scope.
void	init(org.apache.jackrabbit.webdav.transaction.TxLockManager txMgr, String transactionId)
protected void	initLockSupport() Define the set of locks supported by this resource.
protected void	initProperties() Fill the set of default properties
protected void	initPropertyNames() Property names common to all resources.
protected void	initSupportedReports() Define the set of reports supported by this resource.
boolean	isCollection()
boolean	isLockable(org.apache.jackrabbit.webdav.lock.Type type, org.apache.jackrabbit.webdav.lock.Scope scope) Returns true, if the SupportedLock property contains an entry with the given type and scope.
org.apache.jackrabbit.webdav.lock.ActiveLock	lock(org.apache.jackrabbit.webdav.lock.LockInfo reqLockInfo)
void	move(org.apache.jackrabbit.webdav.DavResource destination) Throws HttpServletResponse.SC_METHOD_NOT_ALLOWED
org.apache.jackrabbit.webdav.lock.ActiveLock	refreshLock(org.apache.jackrabbit.webdav.lock.LockInfo info, String lockToken) Only transaction lock may be available on this resource.
void	removeMember(org.apache.jackrabbit.webdav.DavResource member)
void	removeProperty(org.apache.jackrabbit.webdav.property.DavPropertyName propertyName) Throws HttpServletResponse.SC_METHOD_NOT_ALLOWED
org.apache.jackrabbit.webdav.MultiStatus	search(org.apache.jackrabbit.webdav.search.SearchInfo sInfo)
void	setProperty(org.apache.jackrabbit.webdav.property.DavProperty<?> property) Throws HttpServletResponse.SC_METHOD_NOT_ALLOWED
void	spool(org.apache.jackrabbit.webdav.io.OutputContext outputContext)
void	unlock(String lockToken) Throws HttpServletResponse.SC_METHOD_NOT_ALLOWED since only transaction locks may be present on this resource, that need to be released by calling TransactionResource.unlock(String, org.apache.jackrabbit.webdav.transaction.TransactionInfo).
void	unlock(String lockToken, org.apache.jackrabbit.webdav.transaction.TransactionInfo tInfo)

Methods inherited from class java.lang.Object

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

Field Detail

RELURIFROMWORKSPACE

public static final String RELURIFROMWORKSPACE

See Also:

Constant Field Values

EVENTMEDIATYPE

public static final String EVENTMEDIATYPE

See Also:

Constant Field Values

initedProps

protected boolean initedProps

properties

protected org.apache.jackrabbit.webdav.property.DavPropertySet properties

names

protected org.apache.jackrabbit.webdav.property.DavPropertyNameSet names

supportedLock

protected org.apache.jackrabbit.webdav.lock.SupportedLock supportedLock

supportedReports

protected org.apache.jackrabbit.webdav.version.report.SupportedReportSetProperty supportedReports

Method Detail

getSupportedMethods

public String getSupportedMethods()

exists

public boolean exists()

isCollection

public boolean isCollection()

getDisplayName

public String getDisplayName()

getModificationTime

public long getModificationTime()

spool

public void spool(org.apache.jackrabbit.webdav.io.OutputContext outputContext)
           throws IOException

Throws:

IOException

getCollection

public org.apache.jackrabbit.webdav.DavResource getCollection()

addMember

public void addMember(org.apache.jackrabbit.webdav.DavResource resource,
             org.apache.jackrabbit.webdav.io.InputContext inputContext)
               throws org.apache.jackrabbit.webdav.DavException

Throws:

org.apache.jackrabbit.webdav.DavException

getMembers

public org.apache.jackrabbit.webdav.DavResourceIterator getMembers()

removeMember

public void removeMember(org.apache.jackrabbit.webdav.DavResource member)
                  throws org.apache.jackrabbit.webdav.DavException

Throws:

org.apache.jackrabbit.webdav.DavException

initLockSupport

protected void initLockSupport()

Define the set of locks supported by this resource.

See Also:

SupportedLock

getWorkspaceHref

protected String getWorkspaceHref()

Retrieve the href of the workspace the current session belongs to.

Returns:

href of the workspace

getComplianceClass

public String getComplianceClass()

Returns a string listing the compliance classes for this resource as it is required for the DAV response header. This includes DAV 1, 2 which is supported by all derived classes as well as a subset of the classes defined by DeltaV: version-control, version-history, checkout-in-place, label, merge, update and workspace.
Those compliance classes are added as required by RFC3253 since all all resources in the jcr-server support at least the reporting and some basic versioning functionality.

Specified by:

getComplianceClass in interface org.apache.jackrabbit.webdav.DavResource

Returns:

string listing the compliance classes.

See Also:

DavResource.getComplianceClass()

getLocator

public org.apache.jackrabbit.webdav.DavResourceLocator getLocator()

Specified by:

getLocator in interface org.apache.jackrabbit.webdav.DavResource

See Also:

DavResource.getLocator()

getResourcePath

public String getResourcePath()

Returns the path of the underlying repository item or the item to be created (PUT/MKCOL). If the resource exists but does not represent a repository item null is returned.

Specified by:

getResourcePath in interface org.apache.jackrabbit.webdav.DavResource

Returns:

path of the underlying repository item.

See Also:

DavResource.getResourcePath(), DavResourceLocator.getResourcePath()

getHref

public String getHref()

Specified by:

getHref in interface org.apache.jackrabbit.webdav.DavResource

See Also:

DavResource.getHref(), DavResourceLocator.getHref(boolean)

getPropertyNames

public org.apache.jackrabbit.webdav.property.DavPropertyName[] getPropertyNames()

Specified by:

getPropertyNames in interface org.apache.jackrabbit.webdav.DavResource

See Also:

DavResource.getPropertyNames()

getProperty

public org.apache.jackrabbit.webdav.property.DavProperty<?> getProperty(org.apache.jackrabbit.webdav.property.DavPropertyName name)

Specified by:

getProperty in interface org.apache.jackrabbit.webdav.DavResource

See Also:

DavResource.getProperty(org.apache.jackrabbit.webdav.property.DavPropertyName)

getProperties

public org.apache.jackrabbit.webdav.property.DavPropertySet getProperties()

Specified by:

getProperties in interface org.apache.jackrabbit.webdav.DavResource

See Also:

DavResource.getProperties()

setProperty

public void setProperty(org.apache.jackrabbit.webdav.property.DavProperty<?> property)
                 throws org.apache.jackrabbit.webdav.DavException

Throws HttpServletResponse.SC_METHOD_NOT_ALLOWED

Specified by:

setProperty in interface org.apache.jackrabbit.webdav.DavResource

Parameters:

property -

Throws:

org.apache.jackrabbit.webdav.DavException - Always throws HttpServletResponse.SC_METHOD_NOT_ALLOWED

See Also:

DavResource.setProperty(org.apache.jackrabbit.webdav.property.DavProperty)

removeProperty

public void removeProperty(org.apache.jackrabbit.webdav.property.DavPropertyName propertyName)
                    throws org.apache.jackrabbit.webdav.DavException

Throws HttpServletResponse.SC_METHOD_NOT_ALLOWED

Specified by:

removeProperty in interface org.apache.jackrabbit.webdav.DavResource

Parameters:

propertyName -

Throws:

org.apache.jackrabbit.webdav.DavException - Always throws HttpServletResponse.SC_METHOD_NOT_ALLOWED

See Also:

DavResource.removeProperty(org.apache.jackrabbit.webdav.property.DavPropertyName)

alterProperties

public org.apache.jackrabbit.webdav.MultiStatusResponse alterProperties(List<? extends org.apache.jackrabbit.webdav.property.PropEntry> changeList)
                                                                 throws org.apache.jackrabbit.webdav.DavException

Throws HttpServletResponse.SC_METHOD_NOT_ALLOWED

Specified by:

alterProperties in interface org.apache.jackrabbit.webdav.DavResource

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

DavResource.alterProperties(List)

move

public void move(org.apache.jackrabbit.webdav.DavResource destination)
          throws org.apache.jackrabbit.webdav.DavException

Throws HttpServletResponse.SC_METHOD_NOT_ALLOWED

Specified by:

move in interface org.apache.jackrabbit.webdav.DavResource

Parameters:

destination -

Throws:

org.apache.jackrabbit.webdav.DavException - Always throws HttpServletResponse.SC_METHOD_NOT_ALLOWED

See Also:

DavResource.move(org.apache.jackrabbit.webdav.DavResource)

copy

public void copy(org.apache.jackrabbit.webdav.DavResource destination,
        boolean shallow)
          throws org.apache.jackrabbit.webdav.DavException

Throws HttpServletResponse.SC_METHOD_NOT_ALLOWED

Specified by:

copy in interface org.apache.jackrabbit.webdav.DavResource

Parameters:

destination -

shallow -

Throws:

org.apache.jackrabbit.webdav.DavException - Always throws HttpServletResponse.SC_METHOD_NOT_ALLOWED

See Also:

DavResource.copy(org.apache.jackrabbit.webdav.DavResource, boolean)

isLockable

public boolean isLockable(org.apache.jackrabbit.webdav.lock.Type type,
                 org.apache.jackrabbit.webdav.lock.Scope scope)

Returns true, if the SupportedLock property contains an entry with the given type and scope. By default resources allow for transaction lock only.

Specified by:

isLockable in interface org.apache.jackrabbit.webdav.DavResource

Parameters:

type -

scope -

Returns:

true if this resource may be locked by the given type and scope.

See Also:

DavResource.isLockable(org.apache.jackrabbit.webdav.lock.Type, org.apache.jackrabbit.webdav.lock.Scope)

hasLock

public boolean hasLock(org.apache.jackrabbit.webdav.lock.Type type,
              org.apache.jackrabbit.webdav.lock.Scope scope)

Returns true if this resource has a lock applied with the given type and scope.

Specified by:

hasLock in interface org.apache.jackrabbit.webdav.DavResource

Parameters:

type -

scope -

Returns:

true if this resource has a lock applied with the given type and scope.

See Also:

DavResource.hasLock(Type, Scope)

getLock

public org.apache.jackrabbit.webdav.lock.ActiveLock getLock(org.apache.jackrabbit.webdav.lock.Type type,
                                                   org.apache.jackrabbit.webdav.lock.Scope scope)

Specified by:

getLock in interface org.apache.jackrabbit.webdav.DavResource

See Also:

DavResource.getLock(Type, Scope)

getLocks

public org.apache.jackrabbit.webdav.lock.ActiveLock[] getLocks()

Specified by:

getLocks in interface org.apache.jackrabbit.webdav.DavResource

See Also:

todo improve....

lock

public org.apache.jackrabbit.webdav.lock.ActiveLock lock(org.apache.jackrabbit.webdav.lock.LockInfo reqLockInfo)
                                                  throws org.apache.jackrabbit.webdav.DavException

Specified by:

lock in interface org.apache.jackrabbit.webdav.DavResource

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

DavResource.lock(org.apache.jackrabbit.webdav.lock.LockInfo)

refreshLock

public org.apache.jackrabbit.webdav.lock.ActiveLock refreshLock(org.apache.jackrabbit.webdav.lock.LockInfo info,
                                                       String lockToken)
                                                         throws org.apache.jackrabbit.webdav.DavException

Only transaction lock may be available on this resource.

Specified by:

refreshLock in interface org.apache.jackrabbit.webdav.DavResource

Parameters:

info -

lockToken -

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

DavResource.refreshLock(org.apache.jackrabbit.webdav.lock.LockInfo, String)

unlock

public void unlock(String lockToken)
            throws org.apache.jackrabbit.webdav.DavException

Throws HttpServletResponse.SC_METHOD_NOT_ALLOWED since only transaction locks may be present on this resource, that need to be released by calling TransactionResource.unlock(String, org.apache.jackrabbit.webdav.transaction.TransactionInfo).

Specified by:

unlock in interface org.apache.jackrabbit.webdav.DavResource

Parameters:

lockToken -

Throws:

org.apache.jackrabbit.webdav.DavException - Always throws HttpServletResponse.SC_METHOD_NOT_ALLOWED

addLockManager

public void addLockManager(org.apache.jackrabbit.webdav.lock.LockManager lockMgr)

Specified by:

addLockManager in interface org.apache.jackrabbit.webdav.DavResource

See Also:

DavResource.addLockManager(org.apache.jackrabbit.webdav.lock.LockManager)

getFactory

public org.apache.jackrabbit.webdav.DavResourceFactory getFactory()

Specified by:

getFactory in interface org.apache.jackrabbit.webdav.DavResource

See Also:

DavResource.getFactory()

getSession

public org.apache.jackrabbit.webdav.DavSession getSession()

Specified by:

getSession in interface org.apache.jackrabbit.webdav.DavResource

See Also:

DavResource.getSession(), DavResource.getSession()

init

public void init(org.apache.jackrabbit.webdav.transaction.TxLockManager txMgr,
        String transactionId)

Specified by:

init in interface org.apache.jackrabbit.webdav.transaction.TransactionResource

See Also:

TransactionResource.init(TxLockManager, String)

unlock

public void unlock(String lockToken,
          org.apache.jackrabbit.webdav.transaction.TransactionInfo tInfo)
            throws org.apache.jackrabbit.webdav.DavException

Specified by:

unlock in interface org.apache.jackrabbit.webdav.transaction.TransactionResource

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

TransactionResource.unlock(String, org.apache.jackrabbit.webdav.transaction.TransactionInfo)

getTransactionId

public String getTransactionId()

Specified by:

getTransactionId in interface org.apache.jackrabbit.webdav.transaction.TransactionResource

See Also:

TransactionResource.getTransactionId()

getOptionResponse

public org.apache.jackrabbit.webdav.version.OptionsResponse getOptionResponse(org.apache.jackrabbit.webdav.version.OptionsInfo optionsInfo)

Specified by:

getOptionResponse in interface org.apache.jackrabbit.webdav.version.DeltaVResource

Parameters:

optionsInfo -

Returns:

object to be used in the OPTIONS response body or null

See Also:

DeltaVResource.getOptionResponse(org.apache.jackrabbit.webdav.version.OptionsInfo)

getReport

public org.apache.jackrabbit.webdav.version.report.Report getReport(org.apache.jackrabbit.webdav.version.report.ReportInfo reportInfo)
                                                             throws org.apache.jackrabbit.webdav.DavException

Specified by:

getReport in interface org.apache.jackrabbit.webdav.version.DeltaVResource

Parameters:

reportInfo -

Returns:

the requested report

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

DeltaVResource.getReport(org.apache.jackrabbit.webdav.version.report.ReportInfo)

addWorkspace

public void addWorkspace(org.apache.jackrabbit.webdav.DavResource workspace)
                  throws org.apache.jackrabbit.webdav.DavException

The JCR api does not provide methods to create new workspaces. Calling addWorkspace on this resource will always fail.

Specified by:

addWorkspace in interface org.apache.jackrabbit.webdav.version.DeltaVResource

Parameters:

workspace -

Throws:

org.apache.jackrabbit.webdav.DavException - Always throws.

See Also:

DeltaVResource.addWorkspace(org.apache.jackrabbit.webdav.DavResource)

getReferenceResources

public org.apache.jackrabbit.webdav.DavResource[] getReferenceResources(org.apache.jackrabbit.webdav.property.DavPropertyName hrefPropertyName)
                                                                 throws org.apache.jackrabbit.webdav.DavException

Return an array of DavResource objects that are referenced by the property with the specified name.

Specified by:

getReferenceResources in interface org.apache.jackrabbit.webdav.version.DeltaVResource

Parameters:

hrefPropertyName -

Returns:

array of DavResources

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

DeltaVResource.getReferenceResources(org.apache.jackrabbit.webdav.property.DavPropertyName)

getQueryGrammerSet

public org.apache.jackrabbit.webdav.search.QueryGrammerSet getQueryGrammerSet()

Specified by:

getQueryGrammerSet in interface org.apache.jackrabbit.webdav.search.SearchResource

Returns:

See Also:

SearchResource.getQueryGrammerSet()

search

public org.apache.jackrabbit.webdav.MultiStatus search(org.apache.jackrabbit.webdav.search.SearchInfo sInfo)
                                                throws org.apache.jackrabbit.webdav.DavException

Specified by:

search in interface org.apache.jackrabbit.webdav.search.SearchResource

Parameters:

sInfo -

Returns:

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

SearchResource.search(org.apache.jackrabbit.webdav.search.SearchInfo)

initPropertyNames

protected void initPropertyNames()

Property names common to all resources.

initProperties

protected void initProperties()

Fill the set of default properties

createResourceFromLocator

protected org.apache.jackrabbit.webdav.DavResource createResourceFromLocator(org.apache.jackrabbit.webdav.DavResourceLocator loc)
                                                                      throws org.apache.jackrabbit.webdav.DavException

Create a new DavResource from the given locator.

Parameters:

loc -

Returns:

new DavResource

Throws:

org.apache.jackrabbit.webdav.DavException

getLocatorFromItemPath

protected org.apache.jackrabbit.webdav.DavResourceLocator getLocatorFromItemPath(String itemPath)

Build a DavResourceLocator from the given itemPath path.

Parameters:

itemPath -

Returns:

a new DavResourceLocator

See Also:

DavLocatorFactory.createResourceLocator(String, String, String)

getLocatorFromItem

protected org.apache.jackrabbit.webdav.DavResourceLocator getLocatorFromItem(Item repositoryItem)

Build a new DavResourceLocator from the given repository item.

Parameters:

repositoryItem -

Returns:

a new locator for the specified item.

See Also:

getLocatorFromItemPath(String)

getRepositorySession

protected Session getRepositorySession()

Shortcut for getSession().getRepositorySession()

Returns:

repository session present in the AbstractResource.session.

initSupportedReports

protected void initSupportedReports()

Define the set of reports supported by this resource.

See Also:

SupportedReportSetProperty, AbstractResource.initSupportedReports()

getCreatorDisplayName

protected String getCreatorDisplayName()

Returns the display name of the creator which is used for the protected DeltaVConstants.CREATOR_DISPLAYNAME property.

Returns:

always null; subclasses may provide a regular value.

getCreationDate

protected String getCreationDate()

Returns the creation date which is used for the DavPropertyName.CREATIONDATE property.

Returns:

a dummy date; subclasses may provide a reasonable value.