| com.ibm.webdav.impl.IRCollection
All known Subclasses: com.ibm.webdav.protocol.http.CollectionHTTPStub, com.ibm.webdav.impl.CollectionImpl,
| IRCollection | | public interface IRCollection extends IRResource(Code) | | A Collection is a Resource that contains other
resources including other Collections following the composite pattern.
It is useful for managing logically
related groups of resources for authorization, permissions, move, copy, group properties,
location, etc. by clients.
See Also: com.ibm.webdav.CollectionP
See Also: com.ibm.webdav.ResourceP
See Also: com.ibm.webdav.Precondition.addStateTokenCondition
author:
Jim Amsden <jamsden@us.ibm.com> |
| Method Summary | |
| public MultiStatus | copy(ResourceContext context, String destinationURL, boolean overwrite, Vector propertiesToCopy, String depth)
Copy this resource to the destination URL.
Partial results are possible, check the returned status for details.
Parameters:
destinationURL - the destination
Parameters:
depth - an indicator for immediate members or recursively all children.- shallow: copy only this resource
- deep: copy this resource and recursively all of its children
Parameters:
overwrite - true implies overrite the destination if it exists
Parameters:
propertiesToCopy - a collection of properties that must be copied orthe method will fail. | | public MultiStatus | createCollection(ResourceContext context, Document contents)
Actually create the collection in the repository. | | public MultiStatus | delete(ResourceContext context)
Delete this resouce collection and all its members from the server. | | public MultiStatus | getProperties(ResourceContext context, PropertyName names, String depth)
Get the named properties for this resource and (potentially) its children.
Parameters:
names - an arrary of property names to retrieve. | | public MultiStatus | getProperties(ResourceContext context, String depth)
Get all the properties for this resource and (potentially) its children. | | public MultiStatus | getPropertyNames(ResourceContext context, String depth)
Get the names of all properties for this resource and (potentially) its children. | | public MultiStatus | lock(ResourceContext context, String scope, String type, int timeout, Element owner, String depth)
Lock this resource collection and potentially all its members
based on the given parameters. |
| copy | | public MultiStatus copy(ResourceContext context, String destinationURL, boolean overwrite, Vector propertiesToCopy, String depth) throws WebDAVException(Code) | | Copy this resource to the destination URL.
Partial results are possible, check the returned status for details.
Parameters:
destinationURL - the destination
Parameters:
depth - an indicator for immediate members or recursively all children.- shallow: copy only this resource
- deep: copy this resource and recursively all of its children
Parameters:
overwrite - true implies overrite the destination if it exists
Parameters:
propertiesToCopy - a collection of properties that must be copied orthe method will fail. propertiesToCopy may have one of the following values:- null - ignore properties that cannot be copied
- empty collection - all properties must be copied or the method will fail
- a collection of URIs - a list of the properties that must be copied or the method will fail
the status of the copy operation for each resource copied
exception:
com.ibm.webdav.WebDAVException - |
| createCollection | | public MultiStatus createCollection(ResourceContext context, Document contents) throws WebDAVException(Code) | | Actually create the collection in the repository. The resource indicated
by the URL must not already exist. All ancestors of this URL must already
exist.
Parameters:
contents - an XML Document describing the members of this collection, bodiesof members, and properties on the collections or members. Not completely defined in version 10 of the WebDAV specification Multistatus describing the resultof the operation
exception:
com.ibm.webdav.WebDAVException - |
| delete | | public MultiStatus delete(ResourceContext context) throws WebDAVException(Code) | | Delete this resouce collection and all its members from the server.
The actual effect of the delete operation is determined by the underlying
repository manager. The visible effect to WebDAV is that the resource
is no longer available.
a MultiStatus containing the status of the delete method on eacheffected resource.
exception:
com.ibm.webdav.WebDAVException - |
| getProperties | | public MultiStatus getProperties(ResourceContext context, PropertyName names, String depth) throws WebDAVException(Code) | | Get the named properties for this resource and (potentially) its children.
Parameters:
names - an arrary of property names to retrieve.
Parameters:
depth - an indicator for immediate members or recursively all children.- immediateMembers: propeprties of this resource and its immediate children
- allMembers: properties of this resource and recursively all its children
a MultiStatus of PropertyResponses
exception:
com.ibm.webdav.WebDAVException - |
| getProperties | | public MultiStatus getProperties(ResourceContext context, String depth) throws WebDAVException(Code) | | Get all the properties for this resource and (potentially) its children.
Parameters:
depth - an indicator for immediate members or recursively all children.- thisResource: propeprties of this resource
- immediateMembers: propeprties of this resource and its immediate children
- allMembers: properties of this resource and recursively all its children
a MultiStatus of PropertyResponses
exception:
com.ibm.webdav.WebDAVException - |
| getPropertyNames | | public MultiStatus getPropertyNames(ResourceContext context, String depth) throws WebDAVException(Code) | | Get the names of all properties for this resource and (potentially) its children.
Parameters:
depth - an indicator for immediate members or recursively all children.- thisResource: propeprties of this resource
- immediateMembers: propeprties of this resource and its immediate children
- allMembers: properties of this resource and recursively all its children
a MultiStatus of PropertyResponses(PropertyValue.value is always null, PropertyValue.status contains the status)
exception:
com.ibm.webdav.WebDAVException - |
| lock | | public MultiStatus lock(ResourceContext context, String scope, String type, int timeout, Element owner, String depth) throws WebDAVException(Code) | | Lock this resource collection and potentially all its members
based on the given parameters. This allows control of the lock
scope (exclusive or shared) the lock type (write), owner information, etc.
Parameters:
scope - the scope of the lock, exclusive or shared
Parameters:
type - the type of the lock, currently only write
Parameters:
depth - - shallow lock only this resource
- deep lock this resource and all its children
Parameters:
timeout - the number of seconds before the lock times out or0 for infinite timeout.
Parameters:
owner - an XML element containing useful information that can beused to identify the owner of the lock. An href to a home page, anemail address, phone number, etc. Can be null if no owner informationis provided. a MultiStatus containing a lockdiscovery property indicatingthe results of the lock operation.
exception:
com.ibm.webdav.WebDAVException - |
|
|