Package org.apache.jackrabbit.webdav.jcr
Class DefaultItemResource
- java.lang.Object
-
- org.apache.jackrabbit.webdav.jcr.DefaultItemResource
-
- All Implemented Interfaces:
JcrRemotingConstants
,DavResource
,ItemResourceConstants
,ObservationResource
,SearchResource
,TransactionResource
,DeltaVResource
public class DefaultItemResource extends Object
DefaultItemResource
represents JCR property item.- See Also:
Property
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
initedProps
protected Item
item
protected DavPropertyNameSet
names
protected DavPropertySet
properties
protected SupportedLock
supportedLock
protected SupportedReportSetProperty
supportedReports
-
Fields inherited from interface org.apache.jackrabbit.webdav.DavResource
METHODS
-
Fields inherited from interface org.apache.jackrabbit.webdav.version.DeltaVResource
METHODS, METHODS_INCL_MKWORKSPACE
-
Fields inherited from interface org.apache.jackrabbit.webdav.jcr.ItemResourceConstants
EXCLUSIVE_SESSION, JCR_DEFINITION, JCR_DEPTH, JCR_GET_STRING, JCR_INDEX, JCR_ISMODIFIED, JCR_ISNEW, JCR_LENGTH, JCR_LENGTHS, JCR_MIXINNODETYPES, JCR_NAME, JCR_NAMESPACES, JCR_NODETYPES_CND, JCR_PARENT, JCR_PATH, JCR_PRIMARYITEM, JCR_PRIMARYNODETYPE, JCR_REFERENCES, JCR_SELECTOR_NAME, JCR_TYPE, JCR_UUID, JCR_VALUE, JCR_VALUES, JCR_VERSIONABLEUUID, JCR_WEAK_REFERENCES, JCR_WORKSPACE_NAME, METHODS, NAMESPACE, PRIVILEGE_JCR_ADD_NODE, PRIVILEGE_JCR_READ, PRIVILEGE_JCR_REMOVE, PRIVILEGE_JCR_SET_PROPERTY
-
Fields inherited from interface org.apache.jackrabbit.commons.webdav.JcrRemotingConstants
ATTR_VALUE_TYPE, IMPORT_UUID_BEHAVIOR, JCR_DEFINITION_LN, JCR_DEPTH_LN, JCR_GET_STRING_LN, JCR_INDEX_LN, JCR_ISMODIFIED_LN, JCR_ISNEW_LN, JCR_LENGTH_LN, JCR_LENGTHS_LN, JCR_MIXINNODETYPES_LN, JCR_NAME_LN, JCR_NAMESPACES_LN, JCR_NODETYPES_CND_LN, JCR_PARENT_LN, JCR_PATH_LN, JCR_PRIMARYITEM_LN, JCR_PRIMARYNODETYPE_LN, JCR_QUERY_RESULT_LN, JCR_REFERENCES_LN, JCR_SELECTOR_NAME_LN, JCR_TYPE_LN, JCR_UUID_LN, JCR_VALUE_LN, JCR_VALUES_LN, JCR_VERSIONABLEUUID_LN, JCR_WEAK_REFERENCES_LN, JCR_WORKSPACE_NAME_LN, NS_PREFIX, NS_URI, RELATION_REMOTE_SESSION_ID, RELATION_USER_DATA, REPORT_EXPORT_VIEW, REPORT_LOCATE_BY_UUID, REPORT_LOCATE_CORRESPONDING_NODE, REPORT_NODETYPES, REPORT_PRIVILEGES, REPORT_REGISTERED_NAMESPACES, REPORT_REPOSITORY_DESCRIPTORS, ROOT_ITEM_PATH, ROOT_ITEM_RESOURCEPATH, VERSIONSTORAGE_PATH, XML_ALLOWUPDATE, XML_CND, XML_DESCRIPTOR, XML_DESCRIPTORKEY, XML_DESCRIPTORVALUE, XML_EXCLUSIVE_SESSION_SCOPED, XML_LENGTH, XML_NAMESPACE, XML_NODETYPENAME, XML_PREFIX, XML_PRIMARYNODETYPE, XML_QUERY_RESULT_COLUMN, XML_RELPATH, XML_REMOVEEXISTING, XML_URI, XML_VALUE
-
Fields inherited from interface org.apache.jackrabbit.webdav.observation.ObservationResource
METHODS
-
Fields inherited from interface org.apache.jackrabbit.webdav.search.SearchResource
METHODS
-
Fields inherited from interface org.apache.jackrabbit.webdav.transaction.TransactionResource
METHODS
-
-
Constructor Summary
Constructors Constructor Description DefaultItemResource(DavResourceLocator locator, JcrDavSession session, DavResourceFactory factory, Item item)
Create a newDefaultItemResource
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addLockManager(LockManager lockMgr)
Add an externalLockManager
to this resource.void
addMember(DavResource resource, InputContext inputContext)
Method is not allowed.void
addWorkspace(DavResource workspace)
The JCR api does not provide methods to create new workspaces.MultiStatusResponse
alterProperties(List<? extends PropEntry> changeList)
Loops over the givenList
and alters the properties accordingly.void
copy(DavResource destination, boolean shallow)
Copies the underlying repository item to the indicated destination.protected DavResource
createResourceFromLocator(DavResourceLocator loc)
Create a newDavResource
from the given locator.boolean
exists()
Returns true if there exists arepository item
with the given resource path, false otherwise.DavResource
getCollection()
Returns the resource representing the parent item of the repository item represented by this resource.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 theDavPropertyName.CREATIONDATE
property.protected String
getCreatorDisplayName()
Returns the display name of the creator which is used for the protectedDeltaVConstants.CREATOR_DISPLAYNAME
property.String
getDisplayName()
Retrieves the last segment of the item path (or the resource path if this resource does not exist).DavResourceFactory
getFactory()
Return theDavResourceFactory
that created this resource.String
getHref()
Returns the absolute href of this resource as returned in the multistatus response body.protected static String
getItemName(String itemPath)
Retrieves the last segment of the given path and removes the index if present.DavResourceLocator
getLocator()
Returns thelocator
object for this webdav resource, which encapsulates the information for building the complete 'href'.protected DavResourceLocator
getLocatorFromItem(Item repositoryItem)
Build a newDavResourceLocator
from the given repository item.protected DavResourceLocator
getLocatorFromItemPath(String itemPath)
Build aDavResourceLocator
from the given itemPath path.ActiveLock
getLock(Type type, Scope scope)
JCR properties
are locked if their parent node is locked; thus this method will always return thelock
object from the collection this resource is internal member of.ActiveLock[]
getLocks()
Returns an array of all locks applied to the given resource.DavResourceIterator
getMembers()
Always returns an empty iterator for a non-collection resource might not have internal members.long
getModificationTime()
Always returns 'now'OptionsResponse
getOptionResponse(OptionsInfo optionsInfo)
Retrieves the information requested in the OPTIONS request body and returns the corresponding values.DavPropertySet
getProperties()
Returns all webdav properties present on this resource that will be return upon aDavConstants.PROPFIND_ALL_PROP
request.DavProperty<?>
getProperty(DavPropertyName name)
Return the webdav property with the specified name.DavPropertyName[]
getPropertyNames()
Returns an array of allproperty names
available on this resource.QueryGrammerSet
getQueryGrammerSet()
Returns the protected DAV:supported-method-set property which is defined mandatory by RTF 3253.DavResource[]
getReferenceResources(DavPropertyName hrefPropertyName)
Return an array ofDavResource
objects that are referenced by the property with the specified name.Report
getReport(ReportInfo reportInfo)
Runs the report specified by the givenReportInfo
.protected Session
getRepositorySession()
Shortcut forgetSession().getRepositorySession()
String
getResourcePath()
Returns the path of the underlying repository item or the item to be created (PUT/MKCOL).DavSession
getSession()
Retrieve theDavSession
associated with this resource.String
getSupportedMethods()
Returns a comma separated list of all METHODS supported by the given resource.String
getTransactionId()
The TransactionId ornull
according to the value of the corresponding requestheader
field.protected String
getWorkspaceHref()
Retrieve the href of the workspace the current session belongs to.boolean
hasLock(Type type, Scope scope)
Returns true if this resource has a lock applied with the given type and scope.void
init(SubscriptionManager subsMgr)
Initializes this resource.void
init(TxLockManager txMgr, String transactionId)
Initializes theTransactionResource
.protected void
initLockSupport()
Initialize theSupportedLock
property with entries that are valid for any type item resources.protected void
initProperties()
Add resource specific properties.protected void
initPropertyNames()
Property names common to all resources.protected void
initSupportedReports()
Define the set of reports supported by this resource.boolean
isCollection()
Returns false.boolean
isLockable(Type type, Scope scope)
Returns true, if theSupportedLock
property contains an entry with the given type and scope.ActiveLock
lock(LockInfo reqLockInfo)
Lock this webdav resource with the information retrieve from the request and return the resulting lockdiscovery object.void
move(DavResource destination)
Moves the underlying repository item to the indicated destination.protected String
normalizeResourceHref(String href)
Normalize the resourcehref
.EventDiscovery
poll(String subscriptionId, long timeout)
Retrieve the list of events that where recorded for the event listener with the given SubscriptionId.ActiveLock
refreshLock(LockInfo info, String lockToken)
Only transaction lock may be available on this resource.void
removeMember(DavResource member)
Method is not allowed.void
removeProperty(DavPropertyName propertyName)
Removing properties is not allowed, for a single-value JCR-property without a value does not exist.MultiStatus
search(SearchInfo sInfo)
Runs a search with the language and query defined in theSearchInfo
object specified and returns aMultiStatus
object listing the results.void
setProperty(DavProperty<?> property)
Sets the given property.void
spool(OutputContext outputContext)
In case an underlying repositoryproperty
exists the following logic is applied to spool the property content: Property is not multi valued: Return thestream representation
of the property value. Property is multivalue: Return the xml representation of the values.Subscription
subscribe(SubscriptionInfo info, String subscriptionId)
Subscribe this resource for event listening defined by the specified subscription info.void
unlock(String lockToken)
ThrowsHttpServletResponse.SC_METHOD_NOT_ALLOWED
since only transaction locks may be present on this resource, that need to be released by callingTransactionResource.unlock(String, org.apache.jackrabbit.webdav.transaction.TransactionInfo)
.void
unlock(String lockToken, TransactionInfo tInfo)
Overloads theunlock
method of theDavResource
interface.void
unsubscribe(String subscriptionId)
Unsubscribe the event listener with the given SubscriptionId.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.jackrabbit.webdav.DavResource
addLockManager, getFactory, getHref, getLocator, getLocks, getProperties, getPropertyNames, getResourcePath, getSession, hasLock, isLockable, lock, refreshLock, unlock
-
-
-
-
Field Detail
-
item
protected final Item item
-
initedProps
protected boolean initedProps
-
properties
protected DavPropertySet properties
-
names
protected DavPropertyNameSet names
-
supportedLock
protected SupportedLock supportedLock
-
supportedReports
protected SupportedReportSetProperty supportedReports
-
-
Constructor Detail
-
DefaultItemResource
public DefaultItemResource(DavResourceLocator locator, JcrDavSession session, DavResourceFactory factory, Item item)
Create a newDefaultItemResource
.- Parameters:
locator
-session
-
-
-
Method Detail
-
isCollection
public boolean isCollection()
Returns false.- Returns:
- false
- See Also:
DavResource.isCollection()
-
getModificationTime
public long getModificationTime()
Always returns 'now'- Returns:
- See Also:
DavResource.getModificationTime()
-
spool
public void spool(OutputContext outputContext) throws IOException
In case an underlying repositoryproperty
exists the following logic is applied to spool the property content:- Property is not multi valued: Return the
stream representation
of the property value. - Property is multivalue: Return the xml representation of the values.
- Specified by:
spool
in interfaceDavResource
- Parameters:
outputContext
-- Throws:
IOException
- If an error occurs.- See Also:
DavResource.spool(OutputContext)
- Property is not multi valued: Return the
-
getProperty
public DavProperty<?> getProperty(DavPropertyName name)
Description copied from interface:DavResource
Return the webdav property with the specified name.- Specified by:
getProperty
in interfaceDavResource
- Parameters:
name
- name of the webdav property- Returns:
- the
DavProperty
with the given name ornull
if the property does not exist. - See Also:
DavResource.getProperty(org.apache.jackrabbit.webdav.property.DavPropertyName)
-
setProperty
public void setProperty(DavProperty<?> property) throws DavException
Sets the given property. Note, thatItemResourceConstants.JCR_VALUE
andItemResourceConstants.JCR_VALUES
are the only resource properties that are allowed to be modified. Any other property is read-only and will throw an exception ('Conflict').- Specified by:
setProperty
in interfaceDavResource
- Parameters:
property
-- Throws:
DavException
- See Also:
DavResource.setProperty(org.apache.jackrabbit.webdav.property.DavProperty)
-
removeProperty
public void removeProperty(DavPropertyName propertyName) throws DavException
Removing properties is not allowed, for a single-value JCR-property without a value does not exist. For multivalue properties an emptyvalues array
may be specified with by setting the'values' webdav property
.- Specified by:
removeProperty
in interfaceDavResource
- Parameters:
propertyName
-- Throws:
DavException
- See Also:
DavResource.removeProperty(org.apache.jackrabbit.webdav.property.DavPropertyName)
-
alterProperties
public MultiStatusResponse alterProperties(List<? extends PropEntry> changeList) throws DavException
Loops over the givenList
and alters the properties accordingly. Changes are persisted at the end only according to the rules defined with thecomplete()
method.Please note: since there is only a single property than can be set from a client (i.e. jcr:value OR jcr:values) this method either succeeds or throws an exception, even if this violates RFC 2518.
- Specified by:
alterProperties
in interfaceDavResource
- Parameters:
changeList
-- 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
- See Also:
DavResource.alterProperties(List)
-
addMember
public void addMember(DavResource resource, InputContext inputContext) throws DavException
Method is not allowed.- 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
- See Also:
DavResource.addMember(org.apache.jackrabbit.webdav.DavResource, InputContext)
-
getMembers
public DavResourceIterator getMembers()
Always returns an empty iterator for a non-collection resource might not have internal members.- Returns:
- an empty iterator
- See Also:
DavResource.getMembers()
-
removeMember
public void removeMember(DavResource member) throws DavException
Method is not allowed.- Throws:
DavException
- See Also:
DavResource.removeMember(DavResource)
-
getLock
public ActiveLock getLock(Type type, Scope scope)
JCR properties
are locked if their parent node is locked; thus this method will always return thelock
object from the collection this resource is internal member of.- Specified by:
getLock
in interfaceDavResource
- Parameters:
type
-scope
-- Returns:
- lock present on this resource or
null
if this resource has no lock. - See Also:
DavResource.getLock(Type, Scope)
-
initPropertyNames
protected void initPropertyNames()
Property names common to all resources.
-
initProperties
protected void initProperties()
Add resource specific properties.
-
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 interfaceDavResource
- Returns:
- string listing the compliance classes.
- See Also:
DavResource.getComplianceClass()
-
getSupportedMethods
public String getSupportedMethods()
Description copied from interface:DavResource
Returns a comma separated list of all METHODS supported by the given resource.- Specified by:
getSupportedMethods
in interfaceDavResource
- Returns:
- METHODS supported by this resource.
- See Also:
DavResource.getSupportedMethods()
-
exists
public boolean exists()
Returns true if there exists arepository item
with the given resource path, false otherwise.- Specified by:
exists
in interfaceDavResource
- Returns:
- true, if the resource represents an existing repository item.
- See Also:
DavResource.exists()
-
getDisplayName
public String getDisplayName()
Retrieves the last segment of the item path (or the resource path if this resource does not exist). An item path is in addition first translated to the corresponding resource path.
NOTE: the display name is not equivalent toitem name
which is exposed with the{http://www.day.com/jcr/webdav/1.0}name
property.- Specified by:
getDisplayName
in interfaceDavResource
- Returns:
- display name.
- See Also:
DavResource.getDisplayName()
-
getCollection
public DavResource getCollection()
Returns the resource representing the parent item of the repository item represented by this resource. If this resoure represents the root item aRootCollection
is returned.- Specified by:
getCollection
in interfaceDavResource
- Returns:
- the collection this resource is internal member of. Except for the repository root, the returned collection always represent the parent repository node.
- See Also:
DavResource.getCollection()
-
move
public void move(DavResource destination) throws DavException
Moves the underlying repository item to the indicated destination.- Specified by:
move
in interfaceDavResource
- Parameters:
destination
-- Throws:
DavException
- See Also:
DavResource.move(DavResource)
,Session.move(String, String)
-
copy
public void copy(DavResource destination, boolean shallow) throws DavException
Copies the underlying repository item to the indicated destination. If the locator of the specified destination resource indicates a different workspace,Workspace.copy(String, String, String)
is used to perform the copy operation,Workspace.copy(String, String)
otherwise.Note, that this implementation does not support shallow copy.
- Specified by:
copy
in interfaceDavResource
- Parameters:
destination
-shallow
-- Throws:
DavException
- See Also:
DavResource.copy(DavResource, boolean)
,Workspace.copy(String, String)
,Workspace.copy(String, String, String)
-
init
public void init(SubscriptionManager subsMgr)
Description copied from interface:ObservationResource
Initializes this resource.- Specified by:
init
in interfaceObservationResource
- Parameters:
subsMgr
- subscription manager object- See Also:
ObservationResource.init(SubscriptionManager)
-
subscribe
public Subscription subscribe(SubscriptionInfo info, String subscriptionId) throws DavException
Description copied from interface:ObservationResource
Subscribe this resource for event listening defined by the specified subscription info. A subscriptionId may be specified in case an existing subscription should be modified.- Specified by:
subscribe
in interfaceObservationResource
- Parameters:
info
-SubscriptionInfo
object as defined by the request body and headers.subscriptionId
- ornull
if theSubscriptionId
header is missing.- Returns:
Subscription
object in case the subscription was successful.- Throws:
DavException
- See Also:
ObservationResource.subscribe(org.apache.jackrabbit.webdav.observation.SubscriptionInfo, String)
,SubscriptionManager.subscribe(org.apache.jackrabbit.webdav.observation.SubscriptionInfo, String, org.apache.jackrabbit.webdav.observation.ObservationResource)
-
unsubscribe
public void unsubscribe(String subscriptionId) throws DavException
Description copied from interface:ObservationResource
Unsubscribe the event listener with the given SubscriptionId.- Specified by:
unsubscribe
in interfaceObservationResource
- Parameters:
subscriptionId
- as present in theSubscriptionId
header.- Throws:
DavException
- See Also:
ObservationResource.unsubscribe(String)
,SubscriptionManager.unsubscribe(String, org.apache.jackrabbit.webdav.observation.ObservationResource)
-
poll
public EventDiscovery poll(String subscriptionId, long timeout) throws DavException
Description copied from interface:ObservationResource
Retrieve the list of events that where recorded for the event listener with the given SubscriptionId.- Specified by:
poll
in interfaceObservationResource
- Parameters:
subscriptionId
- as present in theSubscriptionId
header.timeout
- as present in theObservationConstants.HEADER_POLL_TIMEOUT
header or 0 (zero) if none is present.- Returns:
EventDiscovery
object- Throws:
DavException
- See Also:
ObservationResource.poll(String, long)
,SubscriptionManager.poll(String, long, org.apache.jackrabbit.webdav.observation.ObservationResource)
-
initLockSupport
protected void initLockSupport()
Initialize theSupportedLock
property with entries that are valid for any type item resources.- See Also:
SupportedLock
,TxLockEntry
,AbstractResource.initLockSupport()
-
getWorkspaceHref
protected String getWorkspaceHref()
Retrieve the href of the workspace the current session belongs to.- Returns:
- href of the workspace or
null
if this resource does not represent a repository item. - See Also:
AbstractResource.getWorkspaceHref()
-
getItemName
protected static String getItemName(String itemPath)
Retrieves the last segment of the given path and removes the index if present.- Parameters:
itemPath
-- Returns:
- valid jcr item name
-
getLocator
public DavResourceLocator getLocator()
Description copied from interface:DavResource
Returns thelocator
object for this webdav resource, which encapsulates the information for building the complete 'href'.- Specified by:
getLocator
in interfaceDavResource
- Returns:
- the locator for this resource.
- 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 itemnull
is returned.- Specified by:
getResourcePath
in interfaceDavResource
- Returns:
- path of the underlying repository item.
- See Also:
DavResource.getResourcePath()
,DavResourceLocator.getResourcePath()
-
getHref
public String getHref()
Description copied from interface:DavResource
Returns the absolute href of this resource as returned in the multistatus response body.- Specified by:
getHref
in interfaceDavResource
- Returns:
- href
- See Also:
DavResource.getHref()
,DavResourceLocator.getHref(boolean)
-
getPropertyNames
public DavPropertyName[] getPropertyNames()
Description copied from interface:DavResource
Returns an array of allproperty names
available on this resource.- Specified by:
getPropertyNames
in interfaceDavResource
- Returns:
- an array of property names.
- See Also:
DavResource.getPropertyNames()
-
getProperties
public DavPropertySet getProperties()
Description copied from interface:DavResource
Returns all webdav properties present on this resource that will be return upon aDavConstants.PROPFIND_ALL_PROP
request. The implementation may in addition expose other (protected or calculated) properties which should be marked accordingly (see alsoDavProperty.isInvisibleInAllprop()
.- Specified by:
getProperties
in interfaceDavResource
- Returns:
- a
DavPropertySet
containing at least all properties of this resource that are exposed in 'allprop' PROPFIND request. - See Also:
DavResource.getProperties()
-
isLockable
public boolean isLockable(Type type, Scope scope)
Returns true, if theSupportedLock
property contains an entry with the given type and scope. By default resources allow fortransaction
lock only.- Specified by:
isLockable
in interfaceDavResource
- 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(Type type, Scope scope)
Returns true if this resource has a lock applied with the given type and scope.- Specified by:
hasLock
in interfaceDavResource
- Parameters:
type
-scope
-- Returns:
- true if this resource has a lock applied with the given type and scope.
- See Also:
DavResource.hasLock(Type, Scope)
-
getLocks
public ActiveLock[] getLocks()
Description copied from interface:DavResource
Returns an array of all locks applied to the given resource.- Specified by:
getLocks
in interfaceDavResource
- Returns:
- array of locks. The array is empty if there are no locks applied to this resource.
- See Also:
todo improve....
-
lock
public ActiveLock lock(LockInfo reqLockInfo) throws DavException
Description copied from interface:DavResource
Lock this webdav resource with the information retrieve from the request and return the resulting lockdiscovery object.- Specified by:
lock
in interfaceDavResource
- Parameters:
reqLockInfo
- lock info as retrieved from the request.- Returns:
- lockdiscovery 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.- See Also:
DavResource.lock(org.apache.jackrabbit.webdav.lock.LockInfo)
-
refreshLock
public ActiveLock refreshLock(LockInfo info, String lockToken) throws DavException
Only transaction lock may be available on this resource.- Specified by:
refreshLock
in interfaceDavResource
- Parameters:
info
-lockToken
-- Returns:
- lockdiscovery object to be returned in the response body. If the lock
could not be refreshed a
DavException
is thrown. - Throws:
DavException
- See Also:
DavResource.refreshLock(org.apache.jackrabbit.webdav.lock.LockInfo, String)
-
unlock
public void unlock(String lockToken) throws DavException
ThrowsHttpServletResponse.SC_METHOD_NOT_ALLOWED
since only transaction locks may be present on this resource, that need to be released by callingTransactionResource.unlock(String, org.apache.jackrabbit.webdav.transaction.TransactionInfo)
.- Specified by:
unlock
in interfaceDavResource
- Parameters:
lockToken
-- Throws:
DavException
- Always throwsHttpServletResponse.SC_METHOD_NOT_ALLOWED
-
addLockManager
public void addLockManager(LockManager lockMgr)
Description copied from interface:DavResource
Add an externalLockManager
to this resource. This method may throwUnsupportedOperationException
if the resource does handle locking itself.- Specified by:
addLockManager
in interfaceDavResource
- See Also:
DavResource.addLockManager(org.apache.jackrabbit.webdav.lock.LockManager)
-
getFactory
public DavResourceFactory getFactory()
Description copied from interface:DavResource
Return theDavResourceFactory
that created this resource.- Specified by:
getFactory
in interfaceDavResource
- Returns:
- the factory that created this resource.
- See Also:
DavResource.getFactory()
-
getSession
public DavSession getSession()
Description copied from interface:DavResource
Retrieve theDavSession
associated with this resource.- Specified by:
getSession
in interfaceDavResource
- Returns:
- session object associated with this resource.
- See Also:
DavResource.getSession()
,DavResource.getSession()
-
init
public void init(TxLockManager txMgr, String transactionId)
Description copied from interface:TransactionResource
Initializes theTransactionResource
.- Specified by:
init
in interfaceTransactionResource
- See Also:
TransactionResource.init(TxLockManager, String)
-
unlock
public void unlock(String lockToken, TransactionInfo tInfo) throws DavException
Description copied from interface:TransactionResource
Overloads theunlock
method of theDavResource
interface.- Specified by:
unlock
in interfaceTransactionResource
- Parameters:
lockToken
- lock token as present in the request header.tInfo
- transaction info object as present in the UNLOCK request body.- Throws:
DavException
- if an error occurs- See Also:
TransactionResource.unlock(String, org.apache.jackrabbit.webdav.transaction.TransactionInfo)
-
getTransactionId
public String getTransactionId()
Description copied from interface:TransactionResource
The TransactionId ornull
according to the value of the corresponding requestheader
field.- Specified by:
getTransactionId
in interfaceTransactionResource
- Returns:
- TransactionId header or
null
- See Also:
TransactionResource.getTransactionId()
-
getOptionResponse
public OptionsResponse getOptionResponse(OptionsInfo optionsInfo)
Description copied from interface:DeltaVResource
Retrieves the information requested in the OPTIONS request body and returns the corresponding values.- Specified by:
getOptionResponse
in interfaceDeltaVResource
- 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 Report getReport(ReportInfo reportInfo) throws DavException
Description copied from interface:DeltaVResource
Runs the report specified by the givenReportInfo
.- Specified by:
getReport
in interfaceDeltaVResource
- Parameters:
reportInfo
-- Returns:
- the requested report
- Throws:
DavException
- See Also:
DeltaVResource.getReport(org.apache.jackrabbit.webdav.version.report.ReportInfo)
-
addWorkspace
public void addWorkspace(DavResource workspace) throws DavException
The JCR api does not provide methods to create new workspaces. CallingaddWorkspace
on this resource will always fail.- Specified by:
addWorkspace
in interfaceDeltaVResource
- Parameters:
workspace
-- Throws:
DavException
- Always throws.- See Also:
DeltaVResource.addWorkspace(org.apache.jackrabbit.webdav.DavResource)
-
getReferenceResources
public DavResource[] getReferenceResources(DavPropertyName hrefPropertyName) throws DavException
Return an array ofDavResource
objects that are referenced by the property with the specified name.- Specified by:
getReferenceResources
in interfaceDeltaVResource
- Parameters:
hrefPropertyName
-- Returns:
- array of
DavResource
s - Throws:
DavException
- See Also:
DeltaVResource.getReferenceResources(org.apache.jackrabbit.webdav.property.DavPropertyName)
-
getQueryGrammerSet
public QueryGrammerSet getQueryGrammerSet()
Description copied from interface:SearchResource
Returns the protected DAV:supported-method-set property which is defined mandatory by RTF 3253. This method call is a shortcut forDavResource.getProperty(SearchConstants.QUERY_GRAMMER_SET)
.- Specified by:
getQueryGrammerSet
in interfaceSearchResource
- Returns:
- See Also:
SearchResource.getQueryGrammerSet()
-
search
public MultiStatus search(SearchInfo sInfo) throws DavException
Description copied from interface:SearchResource
Runs a search with the language and query defined in theSearchInfo
object specified and returns aMultiStatus
object listing the results.- Specified by:
search
in interfaceSearchResource
- Parameters:
sInfo
-- Returns:
- Throws:
DavException
- See Also:
SearchResource.search(org.apache.jackrabbit.webdav.search.SearchInfo)
-
createResourceFromLocator
protected DavResource createResourceFromLocator(DavResourceLocator loc) throws DavException
Create a newDavResource
from the given locator.- Parameters:
loc
-- Returns:
- new
DavResource
- Throws:
DavException
-
getLocatorFromItemPath
protected DavResourceLocator getLocatorFromItemPath(String itemPath)
Build aDavResourceLocator
from the given itemPath path.- Parameters:
itemPath
-- Returns:
- a new
DavResourceLocator
- See Also:
DavLocatorFactory.createResourceLocator(String, String, String)
-
getLocatorFromItem
protected DavResourceLocator getLocatorFromItem(Item repositoryItem)
Build a newDavResourceLocator
from the given repository item.- Parameters:
repositoryItem
-- Returns:
- a new locator for the specified item.
- See Also:
getLocatorFromItemPath(String)
-
getRepositorySession
protected Session getRepositorySession()
Shortcut forgetSession().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 protectedDeltaVConstants.CREATOR_DISPLAYNAME
property.- Returns:
- always
null
; subclasses may provide a regular value.
-
getCreationDate
protected String getCreationDate()
Returns the creation date which is used for theDavPropertyName.CREATIONDATE
property.- Returns:
- a dummy date; subclasses may provide a reasonable value.
-
-