*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.webdav
Interface DAVResourceInterface

All Superinterfaces:

All Known Implementing Classes:

DAVResource

public interface DAVResourceInterface

extends java.rmi.Remote

Provides the interface for a DAV Resource. A DAVResource is a WebDAV (Distributed Authoring and Versioning) resource as specified in IETF RFC 2518.

Method Summary

void	close() Close the socket used for this connection.
DAVResource	copy(String targetUrl) Copy resource to the target destination
void	delete() Delete the resource
void	doCheckin() Check in this resource.
void	doCheckout() Checks out this resource.
void	doControl() Puts the resource until version control.
void	doLabel(int labelAction, String label) Modify the version label on the resource (if this is supported by the server).
void	doUncheckout() Uncheckout this resource, cancelling a previous checkout.
boolean	exists() Returns whether the resource exists or not
String	getACL() Get the Access Control List for this resource.
org.apache.webdav.lib.Lock	getActiveLockFor(String owner) Get an active lock, if it exists, for the owner
Version	getCheckedIn() Retrieves the currently checked in resource.
Version	getCheckedOut() Retrieves the currently checked out resource.
byte[]	getContents() Return the contents of the resource as a byte array
void	getContents(File fileData) Get the content of the resource into a file specified as the parameter
String	getContentsAsString() Return the contents of the resource as a String
InputStream	getContentsInputStream() Return the content of the resource as a stream
String	getContentType() Return the content type of the content for this resource
int	getDepth() Get the current depth value
int	getExistsRequirement()
boolean	getOverwrite() Get the overwrite flag - can this resource be overwritten
String	getPath() Get the path for the WebDAV resource that is currently represented by this DAVResource
List	getPreviousVersionNames() Gets a list of previous version names for this resource.
org.apache.webdav.lib.Property[]	getProperties() Get the properties for the resource.
org.apache.webdav.lib.Property[]	getProperties(Element[] propNames) Get the property values for the properties specified in the parameter
org.apache.webdav.lib.Property[]	getProperties(PropertyName[] propNames) Get the property values for the properties specified in the parameter
org.apache.webdav.lib.Property[]	getProperties(String propNames) Returns a properties for a given set of property names.
org.apache.webdav.lib.Property[]	getProperty(Element propName) Get the property values for the properties specified in the parameter
org.apache.webdav.lib.Property[]	getProperty(PropertyName propName) Get the property value for the property specified in the parameter
org.apache.webdav.lib.Property[]	getProperty(String propName) Get the property value for the property specified in the parameter
org.apache.webdav.lib.Property[]	getPropertyNames() Get all the property names on the resource
int	getStatusCode() Get the status code for the last operation/method
String	getStatusMessage() Get the message associated with the status code for the last operation/method
String	getTempDir() Returns the current setting for the directory for temporary files
URL	getURL() Get the URL that the resource represents
Version	getVersion(String versionName) Gets a particular version of this resource
boolean	isCollection() Is this resource a collection?
boolean	isLocked() Is this resource locked?
String	lock() Lock this resource
boolean	makeCollection() Make a collection.
DAVResource	move(String targetUrl) Move this resource to the location given in the parameter
void	removeProperties(Element[] propNames) Remove the properties specified in the parameter
void	removeProperties(PropertyName[] propNames) Remove the properties specified in the parameter
void	removeProperty(Element propName) Remove the property specified in the parameter
void	removeProperty(PropertyName propName) Remove the property specified in the parameter
void	removeProperty(String propName) Remove the property specified in the parameter
org.apache.webdav.lib.Property[]	report(String reportBody) Run a report on the current resource.
org.apache.webdav.lib.Property[]	search(Element searchQuery) Using the XML representation of the search query, perform the search on the server
org.apache.webdav.lib.Property[]	search(String searchString) Using the search query provided as a string, perform the search on this server
String	setACL(String acl) Set/Update the Access Control List for this resource.
void	setContents(byte[] contents) Set the contents of the resource, passing in a byte array
void	setContents(InputStream is) Set the contents of the resource from an input stream.
void	setContents(String content) Set the contents of the resource, passing in a URL
void	setContents(URL url) Set the contents of the resource, passing in a URL
void	setContentType(String contentType) Set the contents type for the content of the resource
void	setDepth(int depth) Set the depth that will be used for the following operations DEPTH_0, DEPTH_1 and DEPTH_INFINITY from DepthSupport are valid values
void	setExistsRequirement(int requirement)
void	setOverwrite(boolean overwrite) Set the overwrite flag - can this resource be overwritten
void	setPath(String path) Set the path for this resource.
void	setPathNoAction(String path) Set the path for this resource.
void	setProperties(DocumentFragment props) Set the values of properties, as given in the parameter
void	setProperties(Element[] props) Set the values of properties, as given in the parameter
void	setProperties(PropertyName[] propNames, String[] props) Set the values of properties, as given in the parameter
void	setProperty(Element prop) Set the value of a property, as given in the parameter
void	setProperty(PropertyName propName, String prop) Set the value of a property, as given in the parameter
void	setSessionContext(SessionContextInterface sessionContext) Set the session context for this DAVResource.
void	setTempDir(String tempDir) Provides a way to set a directory for temporary files.
boolean	SUCCEEDED() Returns whether the last method was successful or not.
void	unlock() Unlock the resource, if previously locked by the same principal
void	unlock(String lockToken) Unlock the resource, with the correct locktoken

Method Detail

delete

public void delete()
            throws DAVException,
                   RemoteException

Delete the resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getActiveLockFor

public org.apache.webdav.lib.Lock getActiveLockFor(String owner)
                                            throws DAVException,
                                                   RemoteException

Get an active lock, if it exists, for the owner

Parameters:

owner - The owner for which the lock is being sought

Returns:

Lock The lock for this owner if it exists

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getContents

public void getContents(File fileData)
                 throws DAVException,
                        RemoteException

Get the content of the resource into a file specified as the parameter

Parameters:

fileData - The file into which the contents of the resource should be written

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getContents

public byte[] getContents()
                   throws DAVException,
                          RemoteException

Return the contents of the resource as a byte array

Returns:

byte[] The contents of the resource as a byte array

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getContentsAsString

public String getContentsAsString()
                           throws DAVException,
                                  RemoteException

Return the contents of the resource as a String

Returns:

String The contents of the resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getContentType

public String getContentType()
                      throws DAVException,
                             RemoteException

Return the content type of the content for this resource

Returns:

String The content type for this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getContentsInputStream

public InputStream getContentsInputStream()
                                   throws DAVException,
                                          RemoteException

Return the content of the resource as a stream

Returns:

InputStream The stream representing the content of the resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getProperties

public org.apache.webdav.lib.Property[] getProperties()
                                               throws DAVException,
                                                      RemoteException

Get the properties for the resource. This will attempt to find all the properties.

Returns:

Property[] An array of properties for this resource.

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getProperties

public org.apache.webdav.lib.Property[] getProperties(Element[] propNames)
                                               throws DAVException,
                                                      RemoteException

Get the property values for the properties specified in the parameter

Returns:

Property[] The property values requested

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getProperty

public org.apache.webdav.lib.Property[] getProperty(Element propName)
                                             throws DAVException,
                                                    RemoteException

Get the property values for the properties specified in the parameter

Returns:

Property[] The property values requested

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getProperties

public org.apache.webdav.lib.Property[] getProperties(PropertyName[] propNames)
                                               throws DAVException,
                                                      RemoteException

Get the property values for the properties specified in the parameter

Returns:

Property[] The property values requested

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getProperty

public org.apache.webdav.lib.Property[] getProperty(String propName)
                                             throws DAVException,
                                                    RemoteException

Get the property value for the property specified in the parameter

Returns:

Property[] The property values requested

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getProperty

public org.apache.webdav.lib.Property[] getProperty(PropertyName propName)
                                             throws DAVException,
                                                    RemoteException

Get the property value for the property specified in the parameter

Returns:

Property The property value requested

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getPropertyNames

public org.apache.webdav.lib.Property[] getPropertyNames()
                                                  throws DAVException,
                                                         RemoteException

Get all the property names on the resource

Returns:

Property[] A property array containing the names of all the properties on the resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getStatusCode

public int getStatusCode()
                  throws DAVException,
                         RemoteException

Get the status code for the last operation/method

Returns:

int The status code for the last request on the resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getStatusMessage

public String getStatusMessage()
                        throws DAVException,
                               RemoteException

Get the message associated with the status code for the last operation/method

Returns:

String The status message for the last request on the resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getURL

public URL getURL()
           throws DAVException,
                  RemoteException

Get the URL that the resource represents

Returns:

URL The java.net.URL for this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

isCollection

public boolean isCollection()
                     throws DAVException,
                            RemoteException

Is this resource a collection?

Returns:

boolean True if it is a collection, false otherwise

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

isLocked

public boolean isLocked()
                 throws DAVException,
                        RemoteException

Is this resource locked?

Returns:

boolean True if it is locked, false otherwise

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

lock

public String lock()
            throws DAVException,
                   RemoteException

Lock this resource

Returns:

String The lock token if the resource is successfully locked

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

move

public DAVResource move(String targetUrl)
                 throws DAVException,
                        RemoteException

Move this resource to the location given in the parameter

Parameters:

targetUrl - The destination URL for this copy

Returns:

DAVResource A DAVResource that represents the new resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

removeProperties

public void removeProperties(PropertyName[] propNames)
                      throws DAVException,
                             RemoteException

Remove the properties specified in the parameter

Parameters:

propNames - An array of property names that should be removed

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

removeProperties

public void removeProperties(Element[] propNames)
                      throws DAVException,
                             RemoteException

Remove the properties specified in the parameter

Parameters:

propNames - An array of property names that should be removed

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

removeProperty

public void removeProperty(Element propName)
                    throws DAVException,
                           RemoteException

Remove the property specified in the parameter

Parameters:

propName - The name of a property that should be removed from this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

removeProperty

public void removeProperty(String propName)
                    throws DAVException,
                           RemoteException

Remove the property specified in the parameter

Parameters:

propName - The name of a property that should be removed from this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

removeProperty

public void removeProperty(PropertyName propName)
                    throws DAVException,
                           RemoteException

Remove the property specified in the parameter

Parameters:

propName - The name of a property that should be removed from this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setContents

public void setContents(byte[] contents)
                 throws DAVException,
                        RemoteException

Set the contents of the resource, passing in a byte array

Parameters:

contents - The byte array containing the content for this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setContents

public void setContents(URL url)
                 throws DAVException,
                        RemoteException

Set the contents of the resource, passing in a URL

Parameters:

url - A url that represents the content for this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setContents

public void setContents(String content)
                 throws DAVException,
                        RemoteException

Set the contents of the resource, passing in a URL

Parameters:

content - The string containing the content for this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setContents

public void setContents(InputStream is)
                 throws DAVException,
                        RemoteException

Set the contents of the resource from an input stream. For remote deployment the InputStream should be wrapped in an InputStreamAdapter

Parameters:

is - An input stream representing the content for this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setContentType

public void setContentType(String contentType)
                    throws DAVException,
                           RemoteException

Set the contents type for the content of the resource

Parameters:

contentType - The content type for this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setProperties

public void setProperties(Element[] props)
                   throws DAVException,
                          RemoteException

Set the values of properties, as given in the parameter

Parameters:

props - An array of properties to be set on this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setProperties

public void setProperties(PropertyName[] propNames,
                          String[] props)
                   throws DAVException,
                          RemoteException

Set the values of properties, as given in the parameter

Parameters:

propNames - An array of property names to be set on this resource

props - An array of property values to be set on this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setProperties

public void setProperties(DocumentFragment props)
                   throws DAVException,
                          RemoteException

Set the values of properties, as given in the parameter

Parameters:

props - An XML document fragment that defines the properties to be set on this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setProperty

public void setProperty(PropertyName propName,
                        String prop)
                 throws DAVException,
                        RemoteException

Set the value of a property, as given in the parameter

Parameters:

propName - An property name to be set on this resource

prop - A property value to be set on this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setProperty

public void setProperty(Element prop)
                 throws DAVException,
                        RemoteException

Set the value of a property, as given in the parameter

Parameters:

prop - An XML element that represents a property to be set on this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

unlock

public void unlock()
            throws DAVException,
                   RemoteException

Unlock the resource, if previously locked by the same principal

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

unlock

public void unlock(String lockToken)
            throws DAVException,
                   RemoteException

Unlock the resource, with the correct locktoken

Parameters:

lockToken - The lock token for this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getOverwrite

public boolean getOverwrite()
                     throws DAVException,
                            RemoteException

Get the overwrite flag - can this resource be overwritten

Returns:

boolean True if the overwrite flag is set, false otherwise

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setOverwrite

public void setOverwrite(boolean overwrite)
                  throws DAVException,
                         RemoteException

Set the overwrite flag - can this resource be overwritten

Parameters:

overwrite - The value of the overwrite flag to set on the resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setDepth

public void setDepth(int depth)
              throws DAVException,
                     RemoteException

Set the depth that will be used for the following operations DEPTH_0, DEPTH_1 and DEPTH_INFINITY from DepthSupport are valid values

Parameters:

depth - The depth for operations on this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getDepth

public int getDepth()
             throws DAVException,
                    RemoteException

Get the current depth value

Returns:

depth The depth for operations on this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

search

public org.apache.webdav.lib.Property[] search(String searchString)
                                        throws DAVException,
                                               RemoteException

Using the search query provided as a string, perform the search on this server

Parameters:

searchString - A string containing an XML DASL search request

Returns:

Property[] A list of properties from the resources that satisfied the search criteria

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

search

public org.apache.webdav.lib.Property[] search(Element searchQuery)
                                        throws DAVException,
                                               RemoteException

Using the XML representation of the search query, perform the search on the server

Parameters:

searchQuery - An XML document containing a DASL search request

Returns:

Property[] A list of properties from the resources that satisfied the search criteria

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

close

public void close()
           throws RemoteException

Close the socket used for this connection. This can be useful for servers that have a limit on the number of connections (eg. IIS), and provides a way to control network resources.

Throws:

RemoteException - in the event of network failure.

setTempDir

public void setTempDir(String tempDir)
                throws RemoteException

Provides a way to set a directory for temporary files. The java.io.tmp system property can be used to set this value at JVM invocation. If the system property is not set "/temp/" is the default, but can be overridden with this method.

Parameters:

tempDir - Temp directory for temporary files

Throws:

RemoteException - in the event of network failure.

getTempDir

public String getTempDir()
                  throws RemoteException

Returns the current setting for the directory for temporary files

Returns:

String The temp directory for temporary files

Throws:

RemoteException - in the event of network failure.

exists

public boolean exists()
               throws RemoteException

Returns whether the resource exists or not

Returns:

boolean true if resource exists, false otherwise

Throws:

RemoteException - in the event of network failure.

report

public org.apache.webdav.lib.Property[] report(String reportBody)
                                        throws DAVException,
                                               RemoteException

Run a report on the current resource. The report body is the body of the request sent to the server, using the REPORT method.

Parameters:

reportBody - An XML document string that represents the report request

Returns:

Property[]. A list of the results from the report.

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

getACL

public String getACL()
              throws DAVException,
                     RemoteException

Get the Access Control List for this resource.

Returns:

String An XML serialized document describing the ACL for this resource

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setACL

public String setACL(String acl)
              throws DAVException,
                     RemoteException

Set/Update the Access Control List for this resource.

Parameters:

acl - An XML serialized document describing the ACL for this resource

Returns:

Document The result document from the ACL method

Throws:

DAVException - in the event of a WebDAV failure.

RemoteException - in the event of network failure.

setSessionContext

public void setSessionContext(SessionContextInterface sessionContext)
                       throws RemoteException

Set the session context for this DAVResource.

Parameters:

sessionContext - The session context for this DAVResource

Throws:

RemoteException - in the event of network failure.

getPath

public String getPath()
               throws RemoteException

Get the path for the WebDAV resource that is currently represented by this DAVResource

Returns:

String The current path for this WebDAV resource

Throws:

RemoteException - in the event of a network failure

setPath

public void setPath(String path)
             throws RemoteException

Set the path for this resource. If the resource was originally created as http://server/origpath, then calling this method will change the resource path to http://server/path. This allows the same DAVResource object to be used for any WebDAV resource.

Parameters:

path - The new path for the WebDAV resource

Throws:

RemoteException - in the event of a network failure

setPathNoAction

public void setPathNoAction(String path)
                     throws RemoteException

Set the path for this resource. If the resource was originally created as http://server/origpath, then calling this method will change the resource path to http://server/path. This allows the same DAVResource object to be used for any WebDAV resource.

Parameters:

path - The new path for the WebDAV resource

Throws:

RemoteException - in the event of a network failure

makeCollection

public boolean makeCollection()
                       throws DAVException,
                              RemoteException

Make a collection. This method only works on a null resource (one that doesn't exist yet). One would normally call this method immediately after creating the DAVResource.

Returns:

boolean True is make collection successful, false otherwise

Throws:

DAVException - in the case of a WebDAV error

SUCCEEDED

public boolean SUCCEEDED()
                  throws RemoteException

Returns whether the last method was successful or not. The HTTP status codes in the range 200-299 are successful. All others indicate some sort of unsuccessful attempt.

Returns:

boolean - true if last method was successful, false otherwise

getProperties

public org.apache.webdav.lib.Property[] getProperties(String propNames)
                                               throws DAVException,
                                                      RemoteException

Returns a properties for a given set of property names.

Parameters:

propNames - names of properties for which values should be returned

Returns:

Array of DAV properties

copy

public DAVResource copy(String targetUrl)
                 throws DAVException,
                        RemoteException

Copy resource to the target destination

Parameters:

targetUrl - location to which current resource is to be copied.

Returns:

If successful, then a new DAVResource representing the new destination is created and returned

doControl

public void doControl()
               throws DAVException,
                      RemoteException

Puts the resource until version control.

Throws:

DAVException - in the case of a WebDAV error

RemoteException - in the case of network failures

doLabel

public void doLabel(int labelAction,
                    String label)
             throws DAVException,
                    RemoteException

Modify the version label on the resource (if this is supported by the server).

Parameters:

labelAction - Specify whether the label should be set (specify 1), added (specify 2), removed (specify 3)

label - The value of the label

Throws:

DAVException - in the case of a WebDAV error

RemoteException - in the case of network failures

getPreviousVersionNames

public List getPreviousVersionNames()
                             throws DAVException,
                                    RemoteException

Gets a list of previous version names for this resource.

Returns:

List(String) The version names for this resource

Throws:

DAVException - in the case of a WebDAV error

RemoteException - in the case of network failures

doCheckout

public void doCheckout()
                throws DAVException,
                       RemoteException

Checks out this resource.

Throws:

DAVException - in the case of a WebDAV error

RemoteException - in the case of network failures

doCheckin

public void doCheckin()
               throws DAVException,
                      RemoteException

Check in this resource.

Throws:

DAVException - in the case of a WebDAV error

RemoteException - in the case of network failures

doUncheckout

public void doUncheckout()
                  throws DAVException,
                         RemoteException

Uncheckout this resource, cancelling a previous checkout.

Throws:

DAVException - in the case of a WebDAV error

RemoteException - in the case of network failures

getVersion

public Version getVersion(String versionName)
                   throws DAVException,
                          RemoteException

Gets a particular version of this resource

Parameters:

versionName - Which version to retrieve for this resource

Returns:

Version An object describing the version of this resource

Throws:

DAVException - in the case of a WebDAV error

RemoteException - in the case of network failures

getCheckedIn

public Version getCheckedIn()
                     throws DAVException,
                            RemoteException

Retrieves the currently checked in resource.

Returns:

Version An object describing the version that is checked in

Throws:

DAVException - in the case of a WebDAV error

RemoteException - in the case of network failures

getCheckedOut

public Version getCheckedOut()
                      throws DAVException,
                             RemoteException

Retrieves the currently checked out resource.

Returns:

Version An object describing the version that is checked out

Throws:

DAVException - in the case of a WebDAV error

RemoteException - in the case of network failures

setExistsRequirement

public void setExistsRequirement(int requirement)
                          throws RemoteException

getExistsRequirement

public int getExistsRequirement()
                         throws RemoteException

*** This API provides Binary Compatibility only, not Source Compatibility ***