Package | Description |
---|---|
org.apache.jackrabbit.webdav | |
org.apache.jackrabbit.webdav.bind | |
org.apache.jackrabbit.webdav.client.methods |
This package contains classes and utilities used to build a WebDAV client
implementation.
Currently it consists of DAV-specific extensions to the Jakarta Commons HttpClient, namely a set of methods. |
org.apache.jackrabbit.webdav.lock |
Provides interfaces and classes for locking related issues.
|
org.apache.jackrabbit.webdav.observation |
Contains interfaces and classes related to observation, which is not covered
by the WebDAV protocol.
|
org.apache.jackrabbit.webdav.ordering |
Contains interfaces and classes used to cover the functionality defined by the
RFC 3648: Web Distributed Authoring
and Versioning (WebDAV) Ordered Collections Protocol .
|
org.apache.jackrabbit.webdav.search |
Contains interfaces and classes used to cover the functionality defined by the
Internet
Draft WebDAV Search.
|
org.apache.jackrabbit.webdav.security | |
org.apache.jackrabbit.webdav.security.report | |
org.apache.jackrabbit.webdav.server | |
org.apache.jackrabbit.webdav.transaction |
Contains interfaces and classes related to transaction locks.
|
org.apache.jackrabbit.webdav.version |
Interfaces and classes used to cover functionality defined by
RFC 3253: Versioning Extensions to WebDAV.
|
org.apache.jackrabbit.webdav.version.report |
Report interface and inplementation for default reports defined by RFC 3253.
|
Modifier and Type | Method and Description |
---|---|
void |
WebdavResponseImpl.sendError(DavException exception)
If the specifid exception provides an error condition an Xml response body
is sent providing more detailed information about the error.
|
void |
DavServletResponse.sendError(DavException error)
Send a response body given more detailed information about the error
occurred.
|
Modifier and Type | Method and Description |
---|---|
void |
DavResource.addMember(DavResource resource,
InputContext inputContext)
Add the given resource as an internal member to this resource.
|
MultiStatusResponse |
DavResource.alterProperties(List<? extends PropEntry> changeList)
Set/add and remove the specified properties from this resource.
|
boolean |
DavSessionProvider.attachSession(WebdavRequest request)
Acquires a DavSession.
|
void |
DavResource.copy(DavResource destination,
boolean shallow)
Copy this DavResource to the given destination resource
|
DavResource |
DavResourceFactory.createResource(DavResourceLocator locator,
DavServletRequest request,
DavServletResponse response)
Create a
DavResource object from the given locator, request and response
objects. |
DavResource |
DavResourceFactory.createResource(DavResourceLocator locator,
DavSession session)
Create a new
DavResource object from the given locator and session. |
BindInfo |
WebdavRequestImpl.getBindInfo() |
DavResourceLocator |
DavServletRequest.getDestinationLocator()
Parse the
Destination header
and return the locator of the corresponding resource . |
DavResourceLocator |
WebdavRequestImpl.getDestinationLocator()
Parse the destination header field and return the path of the destination
resource.
|
DavResourceLocator |
WebdavRequestImpl.getHrefLocator(String href)
Parse a href and return the path of the resource.
|
LabelInfo |
WebdavRequestImpl.getLabelInfo() |
LockInfo |
DavServletRequest.getLockInfo()
Return the parsed 'lockinfo' request body, the
Timeout header and the Depth header
of a LOCK request as LockInfo object. |
LockInfo |
WebdavRequestImpl.getLockInfo()
LockInfo object encapsulating the information passed with a LOCK
request if the LOCK request body was valid. |
MergeInfo |
WebdavRequestImpl.getMergeInfo() |
OptionsInfo |
WebdavRequestImpl.getOptionsInfo() |
OrderPatch |
WebdavRequestImpl.getOrderPatch() |
DavPropertyNameSet |
DavServletRequest.getPropFindProperties()
Return the set of properties the client requested with a PROPFIND request
or an empty set if the type of PROPFIND request was
DavConstants.PROPFIND_ALL_PROP
or DavConstants.PROPFIND_PROPERTY_NAMES . |
DavPropertyNameSet |
WebdavRequestImpl.getPropFindProperties()
Returns the set of properties requested by the PROPFIND body or an
empty set if the
type is either 'allprop' or
'propname'. |
int |
DavServletRequest.getPropFindType()
Return the type of PROPFIND request as indicated by the PROPFIND request
body.
|
int |
WebdavRequestImpl.getPropFindType()
Returns the type of PROPFIND as indicated by the request body.
|
List<? extends PropEntry> |
DavServletRequest.getPropPatchChangeList()
Return a
List of property change operations. |
List<? extends PropEntry> |
WebdavRequestImpl.getPropPatchChangeList()
Return a
List of property change operations. |
RebindInfo |
WebdavRequestImpl.getRebindInfo() |
ReportInfo |
WebdavRequestImpl.getReportInfo() |
Document |
DavServletRequest.getRequestDocument()
Parse the Xml request body and return a
Document . |
Document |
WebdavRequestImpl.getRequestDocument() |
SubscriptionInfo |
WebdavRequestImpl.getSubscriptionInfo() |
TransactionInfo |
WebdavRequestImpl.getTransactionInfo() |
UnbindInfo |
WebdavRequestImpl.getUnbindInfo() |
UpdateInfo |
WebdavRequestImpl.getUpdateInfo() |
ActiveLock |
DavResource.lock(LockInfo reqLockInfo)
Lock this webdav resource with the information retrieve from the request
and return the resulting lockdiscovery object.
|
void |
DavResource.move(DavResource destination)
Move this DavResource to the given destination resource
|
ActiveLock |
DavResource.refreshLock(LockInfo reqLockInfo,
String lockToken)
Refresh an existing lock by resetting the timeout.
|
void |
DavResource.removeMember(DavResource member)
Removes the specified member from this resource.
|
void |
DavResource.removeProperty(DavPropertyName propertyName)
Remove the specified property from this resource.
|
void |
DavResource.setProperty(DavProperty<?> property)
Add/Set the specified property on this resource.
|
void |
DavResource.unlock(String lockToken)
Remove the lock identified by the included lock token from this resource.
|
Modifier and Type | Method and Description |
---|---|
void |
BindableResource.bind(DavResource collection,
DavResource newBinding)
Will add a new binding to the given collection referencing this resource.
|
static ParentElement |
ParentElement.createFromXml(Element root)
Build an
ParentElement object from an XML element DAV:parent |
static RebindInfo |
RebindInfo.createFromXml(Element root)
Build an
RebindInfo object from the root element present
in the request body. |
static BindInfo |
BindInfo.createFromXml(Element root)
Build an
BindInfo object from the root element present
in the request body. |
static UnbindInfo |
UnbindInfo.createFromXml(Element root)
Build an
UnbindInfo object from the root element present
in the request body. |
BindInfo |
BindServletRequest.getBindInfo()
Returns the
BindInfo present with the request |
DavResourceLocator |
BindServletRequest.getHrefLocator(String href)
Parses a href and returns the path of the resource.
|
RebindInfo |
BindServletRequest.getRebindInfo()
Returns the
RebindInfo present with the request |
UnbindInfo |
BindServletRequest.getUnbindInfo()
Returns the
UnbindInfo present with the request |
void |
BindableResource.rebind(DavResource collection,
DavResource newBinding)
Will rebind the resource to the given collection.
|
Modifier and Type | Method and Description |
---|---|
DavException |
PropPatchMethod.getResponseException() |
DavException |
DavMethod.getResponseException()
Builds a DavException for the status line and the DAV:error element that
may be present in the response body.
|
DavException |
DavMethodBase.getResponseException() |
Modifier and Type | Method and Description |
---|---|
void |
DavMethod.checkSuccess() |
void |
DavMethodBase.checkSuccess() |
EventDiscovery |
PollMethod.getResponseAsEventDiscovery() |
LockDiscovery |
LockMethod.getResponseAsLockDiscovery() |
SubscriptionDiscovery |
SubscribeMethod.getResponseAsSubscriptionDiscovery() |
MultiStatus |
DavMethod.getResponseBodyAsMultiStatus()
Return the response body as
MultiStatus object. |
MultiStatus |
DavMethodBase.getResponseBodyAsMultiStatus() |
Modifier and Type | Method and Description |
---|---|
ActiveLock |
SimpleLockManager.createLock(LockInfo lockInfo,
DavResource resource)
Adds the lock for the given resource, replacing any existing lock.
|
ActiveLock |
LockManager.createLock(LockInfo lockInfo,
DavResource resource)
Create a new lock for the given
resource . |
ActiveLock |
SimpleLockManager.refreshLock(LockInfo lockInfo,
String lockToken,
DavResource resource) |
ActiveLock |
LockManager.refreshLock(LockInfo lockInfo,
String lockToken,
DavResource resource)
Refresh the lock identified by the given lockToken and initially created
on the specified resource.
|
void |
SimpleLockManager.releaseLock(String lockToken,
DavResource resource)
Remove the lock hold by the given resource.
|
void |
LockManager.releaseLock(String lockToken,
DavResource resource)
Release the lock identified by the given lockToken and initially created
on the specified resource.
|
Constructor and Description |
---|
LockInfo(Element liElement,
long timeout,
boolean isDeep)
Create a new
LockInfo object from the given information. |
Modifier and Type | Method and Description |
---|---|
SubscriptionInfo |
ObservationDavServletRequest.getSubscriptionInfo()
Return a
SubscriptionInfo object representing the subscription
info present in the SUBSCRIBE request body or null if
retrieving the subscription info fails. |
EventDiscovery |
ObservationResource.poll(String subscriptionId,
long timeout)
Retrieve the list of events that where recorded for the event listener
with the given SubscriptionId.
|
EventDiscovery |
SubscriptionManager.poll(String subscriptionId,
long timeout,
ObservationResource resource)
Retrieve the list of events that occurred since the last poll.
|
Subscription |
ObservationResource.subscribe(SubscriptionInfo info,
String subscriptionId)
Subscribe this resource for event listening defined by the specified
subscription info.
|
Subscription |
SubscriptionManager.subscribe(SubscriptionInfo info,
String subscriptionId,
ObservationResource resource)
Create a new
Subscription or update an existing Subscription .. |
void |
ObservationResource.unsubscribe(String subscriptionId)
Unsubscribe the event listener with the given SubscriptionId.
|
void |
SubscriptionManager.unsubscribe(String subscriptionId,
ObservationResource resource)
Unsubscribe the
Subscription with the given id. |
Constructor and Description |
---|
SubscriptionInfo(Element reqInfo,
long timeout,
boolean isDeep)
|
Modifier and Type | Method and Description |
---|---|
static OrderPatch |
OrderPatch.createFromXml(Element orderPatchElement)
Create a new
OrderPath object. |
OrderPatch |
OrderingDavServletRequest.getOrderPatch()
Return a
OrderPatch object encapsulating the request body
of an ORDERPATCH request or null if the request body was
either missing or could not be parsed. |
void |
OrderingResource.orderMembers(OrderPatch orderPatch)
Reorders the internal members of this resource according to the
instructions present in the specified
OrderPatch object. |
Modifier and Type | Method and Description |
---|---|
static SearchInfo |
SearchInfo.createFromXml(Element searchRequest)
Create a new
SearchInfo from the specifying document
retrieved from the request body. |
MultiStatus |
SearchResource.search(SearchInfo sInfo)
Runs a search with the language and query defined in the
SearchInfo
object specified and returns a MultiStatus object listing the
results. |
Modifier and Type | Method and Description |
---|---|
void |
AclResource.alterAcl(AclProperty aclProperty)
Modify the DAV:acl property of this resource object.
Note: RFC 3744 limits modification of access control elements (ACEs) to elements that are neither inherited nor protected. |
static AclProperty |
AclProperty.createFromXml(Element aclElement)
Build a new
AclProperty object from the request body of the
ACL method call. |
static Principal |
Principal.createFromXml(Element principalElement) |
static Privilege |
Privilege.getPrivilege(Element privilege)
Factory method to create/retrieve a
Privilege from the given
DAV:privilege element. |
Report |
AclResource.getReport(ReportInfo reportInfo)
Same as
DeltaVResource.getReport(ReportInfo) . |
Constructor and Description |
---|
CurrentUserPrivilegeSetProperty(DavProperty<?> xmlDavProperty)
Create a new
CurrentUserPrivilegeSetProperty from a DavProperty
as obtained from a MultiStatusResponse. |
Modifier and Type | Method and Description |
---|---|
void |
SearchablePropertyReport.init(DavResource resource,
ReportInfo info) |
void |
AbstractSecurityReport.init(DavResource resource,
ReportInfo info)
Checks if the given resource and report info are not
null ,
that the requested report type matches this implementation and that no
other Depth header than 0 is present. |
void |
AclPrincipalReport.init(DavResource resource,
ReportInfo info) |
void |
PrincipalMatchReport.init(DavResource resource,
ReportInfo info) |
void |
PrincipalSearchReport.init(DavResource resource,
ReportInfo info) |
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractWebdavServlet.sendUnauthorized(WebdavRequest request,
WebdavResponse response,
DavException error)
Sets the "WWW-Authenticate" header and writes the appropriate error
to the given webdav response.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractWebdavServlet.doAcl(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The ACL method
|
protected void |
AbstractWebdavServlet.doBaselineControl(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The BASELINECONTROL method
|
protected void |
AbstractWebdavServlet.doBind(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The BIND method
|
protected void |
AbstractWebdavServlet.doCheckin(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The CHECKIN method
|
protected void |
AbstractWebdavServlet.doCheckout(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The CHECKOUT method
|
protected void |
AbstractWebdavServlet.doCopy(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The COPY method
|
protected void |
AbstractWebdavServlet.doDelete(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The DELETE method
|
protected void |
AbstractWebdavServlet.doGet(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The GET method
|
protected void |
AbstractWebdavServlet.doLabel(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The LABEL method
|
protected void |
AbstractWebdavServlet.doLock(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The LOCK method
|
protected void |
AbstractWebdavServlet.doMerge(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The MERGE method
|
protected void |
AbstractWebdavServlet.doMkActivity(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The MKACTIVITY method
|
protected void |
AbstractWebdavServlet.doMkCol(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The MKCOL method
|
protected void |
AbstractWebdavServlet.doMkWorkspace(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The MKWORKSPACE method
|
protected void |
AbstractWebdavServlet.doMove(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The MOVE method
|
protected void |
AbstractWebdavServlet.doOptions(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The OPTION method
|
protected void |
AbstractWebdavServlet.doOrderPatch(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The ORDERPATCH method
|
protected void |
AbstractWebdavServlet.doPoll(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The POLL method
|
protected void |
AbstractWebdavServlet.doPost(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The POST method.
|
protected void |
AbstractWebdavServlet.doPropFind(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The PROPFIND method
|
protected void |
AbstractWebdavServlet.doPropPatch(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The PROPPATCH method
|
protected void |
AbstractWebdavServlet.doPut(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The PUT method
|
protected void |
AbstractWebdavServlet.doRebind(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The REBIND method
|
protected void |
AbstractWebdavServlet.doReport(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The REPORT method
|
protected void |
AbstractWebdavServlet.doSearch(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The SEARCH method
|
protected void |
AbstractWebdavServlet.doSubscribe(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The SUBSCRIBE method
|
protected void |
AbstractWebdavServlet.doUnbind(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The UNBIND method
|
protected void |
AbstractWebdavServlet.doUncheckout(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The UNCHECKOUT method
|
protected void |
AbstractWebdavServlet.doUnlock(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The UNLOCK method
|
protected void |
AbstractWebdavServlet.doUnsubscribe(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The UNSUBSCRIBE method
|
protected void |
AbstractWebdavServlet.doUpdate(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The UPDATE method
|
protected void |
AbstractWebdavServlet.doVersionControl(WebdavRequest request,
WebdavResponse response,
DavResource resource)
The VERSION-CONTROL method
|
protected boolean |
AbstractWebdavServlet.execute(WebdavRequest request,
WebdavResponse response,
int method,
DavResource resource)
Executes the respective method in the given webdav context
|
protected int |
AbstractWebdavServlet.validateDestination(DavResource destResource,
WebdavRequest request,
boolean checkHeader)
Validate the given destination resource and return the proper status
code: Any return value greater/equal than
HttpServletResponse.SC_NO_CONTENT
indicates an error. |
Modifier and Type | Method and Description |
---|---|
TransactionInfo |
TransactionDavServletRequest.getTransactionInfo()
Retrieve the 'transactioninfo' request body that must be included with
the UNLOCK request of a transaction lock.
|
void |
TxLockManager.releaseLock(TransactionInfo lockInfo,
String lockToken,
TransactionResource resource)
Release the lock identified by the given lock token.
|
void |
TransactionResource.unlock(String lockToken,
TransactionInfo info)
Overloads the
unlock method of the DavResource
interface. |
Constructor and Description |
---|
TransactionInfo(Element transactionInfo)
Creates a
TransactionInfo object from the given 'transactionInfo'
element. |
Modifier and Type | Method and Description |
---|---|
void |
VersionableResource.addVersionControl()
Converts this versionable resource into a version-controlled resource.
|
void |
DeltaVResource.addWorkspace(DavResource workspace)
Add a new member to this resource, that represents a workspace.
Please note that no resource must exist at the location of the new workspace. |
String |
VersionControlledResource.checkin()
Perform a checkin on the version controlled resource.
|
void |
VersionControlledResource.checkout()
Perform a checkout on the version controlled resource.
|
static OptionsInfo |
OptionsInfo.createFromXml(Element optionsElement)
Build an
OptionsInfo object from the root element present
in the request body. |
DavResource |
BaselineResource.getBaselineCollection()
Return the resource that represents the baseline-collection of this
baseline, which is identified the href present in the
BaselineResource.BASELINE_COLLECTION
property. |
LabelInfo |
DeltaVServletRequest.getLabelInfo()
Return the request body as
LabelInfo object or null
if parsing the request body or the creation of the label info failed. |
MergeInfo |
DeltaVServletRequest.getMergeInfo()
Return the request body as
MergeInfo object or null
if the creation failed due to invalid format. |
OptionsInfo |
DeltaVServletRequest.getOptionsInfo()
Returns the
OptionsInfo present with the request or null . |
DavResource[] |
DeltaVResource.getReferenceResources(DavPropertyName hrefPropertyName)
Returns an array of
DavResource objects that are referenced
by the HrefProperty with
the specified name . |
Report |
DeltaVResource.getReport(ReportInfo reportInfo)
Runs the report specified by the given
ReportInfo . |
ReportInfo |
DeltaVServletRequest.getReportInfo()
Returns the request body and the Depth header as
ReportInfo
object. |
UpdateInfo |
DeltaVServletRequest.getUpdateInfo()
Parses the UPDATE request body a build the corresponding
UpdateInfo
object. |
VersionHistoryResource |
VersionControlledResource.getVersionHistory()
Returns the
VersionHistoryResource , that is referenced in the
'version-history ' property. |
VersionHistoryResource |
VersionResource.getVersionHistory()
Returns the
VersionHistoryResource , that is referenced in the
DAV:version-history property. |
VersionResource[] |
VersionHistoryResource.getVersions()
Returns an array of
VersionResource s containing all versions
that are a member of this resource. |
void |
VersionControlledResource.label(LabelInfo labelInfo)
Modify the labels of the version referenced by the DAV:checked-in property
of this checked-in version-controlled resource.
|
void |
VersionResource.label(LabelInfo labelInfo)
Modify the labels of this version resource.
|
MultiStatus |
VersionControlledResource.merge(MergeInfo mergeInfo)
Perform a merge on this resource using the specified
MergeInfo . |
void |
VersionControlledResource.uncheckout()
Perform an uncheckout on the version controlled resource.
|
MultiStatus |
VersionControlledResource.update(UpdateInfo updateInfo)
Perform an update on this resource using the specified
UpdateInfo . |
Constructor and Description |
---|
LabelInfo(Element labelElement)
Create a new
LabelInfo from the given element. |
LabelInfo(Element labelElement,
int depth)
Create a new
LabelInfo from the given element and depth
integer. |
MergeInfo(Element mergeElement)
Create a new
MergeInfo |
UpdateInfo(Element updateElement)
Create a new
UpdateInfo object. |
Modifier and Type | Method and Description |
---|---|
Report |
ReportType.createReport(DeltaVResource resource,
ReportInfo info)
Creates a new
Report with this type. |
void |
VersionTreeReport.init(DavResource resource,
ReportInfo info)
Validates the specified resource and info objects.
|
void |
ExpandPropertyReport.init(DavResource resource,
ReportInfo info) |
void |
LocateByHistoryReport.init(DavResource resource,
ReportInfo info) |
void |
Report.init(DavResource resource,
ReportInfo info)
Set the
DeltaVResource for which this report was requested
and the ReportInfo as specified by the REPORT request body,
that defines the details for this report.Please note that this methods should perform basic validation checks in order to prevent exceptional situations during the xml serialization. |
void |
LatestActivityVersionReport.init(DavResource resource,
ReportInfo info)
Check all the preconditions for this report.
|
void |
CompareBaselineReport.init(DavResource resource,
ReportInfo info) |
Constructor and Description |
---|
ReportInfo(Element reportElement,
int depth)
Create a new
ReportInfo object from the given Xml element. |
Copyright © 2004-2012 Apache Software Foundation. All Rights Reserved.