| com.ibm.webdav.impl.IRResource
All known Subclasses: com.ibm.webdav.protocol.http.ResourceHTTPStub, com.ibm.webdav.impl.ResourceImpl,
| IRResource | | public interface IRResource extends java.rmi.Remote(Code) | | A Resource represents any network data object or service that can be
identified by a URL. Resources may be available in multiple
representations (e.g., multiple languages, data formats, size, resolutions)
or vary in other ways.
Resources may have arbitrary properties consisting of name/value pairs that
define additional meta-data about the resource. A resource may be locked
in order to serialize updates by multiple users in a distributed environment.
Resources may be copied and moved in the network, and may be deleted when
no longer needed.
Resources may be logically grouped into collections for content management.
A resource collection may have properties of its own, and can be moved and
copied just like any other resource.
The Resource methods correspond to the capabilities defined
by the WebDAV extensions to HTTP. These methods allow clients to perform
remote web content authoring operations.
Note: all methods that may modify a locked resource (either this resource or one
of its collaborators) must include the lock token of the effected resources
as a Precondition in the resource request context before the method is called. See
Precondition.addStateTokenCondition() for a method that provides a convenient
way to set these preconditions.
See Also: com.ibm.webdav.Collection
See Also: com.ibm.webdav.ResourceP
See Also: com.ibm.webdav.Precondition.addStateTokenCondition
author:
Jim Amsden <jamsden@us.ibm.com> |
| Method Summary | |
| public void | closeContentsOutputStream(ResourceContext context)
This method must be called after the client has completed writing to the contents
output stream that was obtained from getContentsOutputStream(). | | public void | closeContentsOutputStream(ResourceContext context, String sContentType)
| | public MultiStatus | copy(ResourceContext context, String destinationURL, boolean overwrite, Vector propertiesToCopy)
Copy this resource to the destination URL.
Partial results are possible, check the returned status for details.
Parameters:
destinationURL - the destination
Parameters:
overwrite - true implies overwrite the destination if it exists
Parameters:
propertiesToCopy - a collection of properties that must be copied orthe method will fail. | | public MultiStatus | delete(ResourceContext context)
Delete this resouce from the server. | | public InputStream | getContentsInputStream(ResourceContext context)
Get an InputStream for accessing the contents of this resource. | | public OutputStream | getContentsOutputStream(ResourceContext context)
Get an OutputStream for setting the contents of this resource. | | public void | getMetaInformation(ResourceContext context)
This method can be used for obtaining meta-information about this resource without
actually reading the resource contents. | | public MultiStatus | getProperties(ResourceContext context)
Get all the properties of this resource.
a MultiStatus of PropertyResponses. | | public MultiStatus | getProperties(ResourceContext context, PropertyName names)
Get the named properties of this resource. | | public MultiStatus | getPropertyNames(ResourceContext context)
Get the names of all properties for this resource. | | public MultiStatus | lock(ResourceContext context, String scope, String type, int timeout, Element owner)
Lock this resource based on the given parameters. | | public MultiStatus | move(ResourceContext context, String destinationURL, boolean overwrite, Vector propertiesToMove)
Move this resource to the destination URL.
Partial results are possible, check the returned status for details
Parameters:
destinationURL - the destination
Parameters:
overwrite - true implies overrite the destination if it exists
Parameters:
propertiesToMove - a collection of properties that must be moved orthe method will fail. | | public byte[] | performWith(ResourceContext context, String args)
This method treats this resource as a method or service, and sends its parameter to
this resource where it is handled in a resource-specific way. | | public MultiStatus | refreshLock(ResourceContext context, String lockToken, int timeout)
Refresh the lock on this resource by resetting the lock timeout.
The context must contain the proper authorization for the requesting
principal.
Parameters:
lockToken - the lock token identifying the lock.
Parameters:
timeout - the new timeout in seconds. | | public MultiStatus | setProperties(ResourceContext context, Document updates)
Edit the properties of a resource. | | public MultiStatus | unlock(ResourceContext context, String lockToken)
Unlock the lock identified by the lockToken on this resource. |
| copy | | public MultiStatus copy(ResourceContext context, String destinationURL, boolean overwrite, Vector propertiesToCopy) 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:
overwrite - true implies overwrite 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 - |
| delete | | public MultiStatus delete(ResourceContext context) throws WebDAVException(Code) | | Delete this resouce 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 - |
| getContentsInputStream | | public InputStream getContentsInputStream(ResourceContext context) throws WebDAVException(Code) | | Get an InputStream for accessing the contents of this resource. This method may provide
more efficient access for resources that have large contents. Clients may want to create
a Reader to perform appropriate character conversions on this stream.
an InputStream on the contents
exception:
com.ibm.webdav.WebDAVException - |
| getContentsOutputStream | | public OutputStream getContentsOutputStream(ResourceContext context) throws WebDAVException(Code) | | Get an OutputStream for setting the contents of this resource. This method may provide
more efficient access for resources that have large contents. Remember to call
closeContentsOutputStream() when all the data has been written.
an OutputStream to set the contents
exception:
com.ibm.webdav.WebDAVException - |
| getMetaInformation | | public void getMetaInformation(ResourceContext context) throws WebDAVException(Code) | | This method can be used for obtaining meta-information about this resource without
actually reading the resource contents. This meta-information is maintained by the server
in addition to the resource properties.
After this call, the resource context has been updated and
getStatusCode(), getStatusMessage(), and getResponseContext()
as well as all the ResourceContext methods return updated values based on the current
state of the resource.
This methods corresponds to the HTTP HEAD method.
exception:
com.ibm.webdav.WebDAVException - |
| lock | | public MultiStatus lock(ResourceContext context, String scope, String type, int timeout, Element owner) throws WebDAVException(Code) | | Lock this resource 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:
timeout - the number of seconds before the lock times out or-1 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 - |
| move | | public MultiStatus move(ResourceContext context, String destinationURL, boolean overwrite, Vector propertiesToMove) throws WebDAVException(Code) | | Move this resource to the destination URL.
Partial results are possible, check the returned status for details
Parameters:
destinationURL - the destination
Parameters:
overwrite - true implies overrite the destination if it exists
Parameters:
propertiesToMove - a collection of properties that must be moved orthe method will fail. propertiesToMove may have one of the following values:- null - ignore properties that cannot be moved
- empty collection - all properties must be moved or the method will fail
- a collection of URIs - a list of the properties that must be moved or the method will fail
the status of the move operation for each resource moved
exception:
com.ibm.webdav.WebDAVException - |
| performWith | | public byte[] performWith(ResourceContext context, String args) throws WebDAVException(Code) | | This method treats this resource as a method or service, and sends its parameter to
this resource where it is handled in a resource-specific way. For example,
sending data from an HTML form to a URL representing a Servlet or CGI script that processes
the form data to produce some result.
Parameters:
args - a string representing the arguments to the method represented by this URL. Thearguments are in the form ?parameterName1=value1¶meterName2=value2... as specifiedfor URL queries. the results of sending the arguments to the URL
exception:
com.ibm.webdav.WebDAVException - |
| refreshLock | | public MultiStatus refreshLock(ResourceContext context, String lockToken, int timeout) throws WebDAVException(Code) | | Refresh the lock on this resource by resetting the lock timeout.
The context must contain the proper authorization for the requesting
principal.
Parameters:
lockToken - the lock token identifying the lock.
Parameters:
timeout - the new timeout in seconds. -1 means infinite timeout. updated information about the lock status of this resource
exception:
com.ibm.webdav.WebDAVException - |
| setProperties | | public MultiStatus setProperties(ResourceContext context, Document updates) throws WebDAVException(Code) | | Edit the properties of a resource. The updates must refer to a Document containing a WebDAV
DAV:propertyupdates element as the document root.
Parameters:
updates - an XML Document containing DAV:propertyupdate elements describing the edits to be made a MultiStatus indicating the status of the updates
exception:
com.ibm.webdav.WebDAVException - |
| unlock | | public MultiStatus unlock(ResourceContext context, String lockToken) throws WebDAVException(Code) | | Unlock the lock identified by the lockToken on this resource. The request context
must contain the proper authorization.
Parameters:
lockToken - the lock token obtained from the ActiveLock of a previous lock() or getLocks(). a MultiStatus containing any responses on resources that could notbe unlocked.
exception:
com.ibm.webdav.WebDAVException - |
|
|