DAVResource (SAS Foundation Services)

A DAVResource represents a WebDAV (Web-based Distributed Authoring and Versioning) resource as specified in IETF RFC 2518. To create a DAVResource, use a ConnectionInfo object passed to the constructor. ConnectionInfo includes the URL of the resource (containing the host, port and path), user ID, password, proxy host, proxy port, proxy user ID, proxy password. The DAVResource object can then be manipulated using the various methods defined in the Resource interface. After any operation on a resource, check the status on the object using getStatusCode() and getStatusMessage(). For example,

 try
 {
     ConnectionInfo connectionInfo = new ConnectionInfo("http://http-server/path-to-resource",
                                                        "user",
                                                        "pwd");
     // proxy information, if required
     connectionInfo.setProxyHost("myproxy.com");
     connectionInfo.setProxyPort(3100);

     DAVResource davResource1 = new DAVResource(connectionInfo);
     int httpStatusCode = davResource1.getStatusCode();
     if (HttpStatus.SC_NOT_FOUND == httpStatusCode)
     {
         // DAV resource was not found
     }

     davResource1.setProperty(...);
     if (HttpStatus.SC_OK != davResource1.getStatusCode())
     {
         out.println(davResource1.getStatusMessage());
     }
 }
 catch (DAVException e)
 {
     // handle the exception
 }

In order to create a collection use the longer form of the constructor. For example,

 DAVResource davResource2 = new DAVResource(connectionInfo, true);
 int httpStatusCode = davResource2.getStatusCode();
 if (HttpStatus.SC_NOT_FOUND == httpStatusCode)
 {
     // DAV resource was not found
 }

This will ensure that davResource2 is a collection resource (it may contain other resources). Alternatively, do this in two steps

 DAVResource davResource2 = new DAVResource(connectionInfo);
 int httpStatusCode = davResource2.getStatusCode();
 if (HttpStatus.SC_NOT_FOUND == httpStatusCode)
 {
     // DAV resource was not found
 }
 davResource2.makeCollection();

Since:: 1.0

Field Summary

protected ConnectionInfo _connectionInfo
          Connection information.

static int DONT_CARE


static int HTTP_DEFAULT_PORT
          The default port for HTTP is 80.

static int MUST_EXIST


static int MUST_NOT_EXIST


Constructor Summary

DAVResource(ConnectionInfo cInfo)
          Creates a DAVResource using the connection information.

DAVResource(ConnectionInfo cInfo, boolean createCollection)
          Creates a DAVResource using the connection information.

DAVResource(java.lang.String url)
          Creates a DAVResource using a string URL.

DAVResource(java.lang.String url, boolean createCollection)
          Creates a DAVResource using a string URL and boolean flag to indicate whether a collection should be created.

DAVResource(java.lang.String url, java.lang.String userName, java.lang.String password)
          Creates a DAVResource using a string URL, userName and password.

DAVResource(java.net.URL url)
          Creates a DAVResource using a Java URL.

Method Summary

void close()
          Closes the socket used for this connection.

org.apache.http.entity.ContentType contentType()
          Gets the Apache HTTP entity content type of the content for this DAV resource.

DAVResource copy(java.lang.String targetPath)
          Copies resource to the target destination.

void delete()
          Deletes this DAV resource.

void doCheckin()
          Check in this DAV resource.

void doCheckout()
          Checks out this DAV resource.

void doControl()
          Puts the resource under version control.

void doLabel(int labelAction, java.lang.String label)
          Modifies the version label on the resource (if this is supported by the server).

void doLabel(int labelAction, java.lang.String label, int depth)
          Modifies the label on the version resource (if this is supported by the server).

java.util.Properties doOptions()
          Gets the options as Properties representing the header name/value pairs.

DavPropertyResult doReport(org.apache.jackrabbit.webdav.version.report.ReportInfo reportInfo)
          Gets a report on the current DAV resource.

DavPropertyResult doSearch(org.apache.jackrabbit.webdav.search.SearchInfo searchInfo)
          The SEARCH method invokes one of the implemented search grammars on the server to evaluate the query.

void doUncheckout()
          Uncheckout this DAV resource, canceling a previous checkout.

boolean exists()
          Returns whether the resource exists.

static java.lang.String extractPath(java.lang.String url)
          Extract the path (query and fragment identifier from a URL).

com.sas.services.webdav.Acl getAcl()
          Gets the access control list for this DAV resource.

java.lang.String getACL()
          Gets the access control list (ACL) for this DAV resource.

java.lang.String[] getAllowedMethods()
          Returns a list of methods allowed on this resource.

com.sas.services.webdav.Version getCheckedIn()
          Retrieves the currently checked in resource.

com.sas.services.webdav.Version getCheckedOut()
          Retrieves the currently checked out resource.

java.util.List<java.lang.String> getChildrenList(java.lang.String path)
          Gets the list of children.

java.util.Map<java.lang.String,PropertyMap> getChildrenProperties(PropertyName[] properties)
          Get all the properties of a collection's members (depth=1) in as single server request.

byte[] getContents()
          Gets the contents of this DAV resource as a byte array.

void getContents(java.io.File fileData)
          Gets the content of this DAV resource into a file specified as the parameter.

java.lang.String getContentsAsString()
          Gets the contents of this DAV resource as a String.

java.io.InputStream getContentsInputStream()
          Gets the content of this DAV resource as a stream.

java.lang.String getContentType()
          Gets the content type of the content for this DAV resource.

java.lang.String[] getDavCapabilities()
          Returns a list of DAV capabilities.

DavPropertyResult getDavProperties()
          Gets all of the DAV resource's properties using the resource's depth.

DavPropertyResult getDavProperties(org.apache.jackrabbit.webdav.property.DavPropertyNameSet davPropertyNameSet, int depth)
          Gets the properties for the specified DAV property names and search depth.

DavPropertyResult getDavProperties(int depth)
          Gets all of the DAV resource's properties for the specified depth.

DavPropertyResult getDavProperties(PropertyName[] propertyNames)
          Gets all the properties for the specified property names on the DAV resource.

DavPropertyResult getDavProperties(PropertyName[] propertyNames, int depth)
          Gets all the properties for the specified property names on the DAV resource.

DavPropertyResult getDavPropertyNames()
          Gets DAV properties for all of a DAV resource's property names.

DavPropertyResult getDavPropertyNames(int depth)
          Gets DAV properties for all of a DAV resource's property names for the specified depth.

int getDepth()
          Gets the value for depth.

int getExistsRequirement()
          Gets the existence requirement.

java.lang.String getLock(java.lang.String userName)
          Gets this DAV resource's lock token for the specified user.

java.util.Map getMultiStatus()
          Returns the multiple status information for the last operation.

boolean getOverwrite()
          Gets the overwrite flag which specifies whether this DAV resource can be overwritten.

java.lang.String getPath()
          Gets the path for the WebDAV resource that is currently represented by this DAVResource.

java.util.List getPreviousVersionNames()
          Gets a list of previous version names for this DAV resource.

PropertyMap getPropertyMap()
          Returns a property map of the resources properties.

int getStatusCode()
          Gets the HTTP status code for the last operation/method.

java.lang.String getStatusMessage()
          Gets the message associated with the status code for the last operation/method.

java.lang.String getTempDir()
          Returns the current setting for the directory for temporary files.

java.net.URL getURL()
          Gets the URL that this DAV resource represents.

com.sas.services.webdav.Version getVersion(java.lang.String versionName)
          Gets a particular version of this DAV resource.

protected boolean isAuthReqd()
          Returns whether a password is required to connect to this server

boolean isCollection()
          Is this DAV resource a collection?

boolean isLocked()
          Is this DAV resource locked?

java.lang.String lock()
          Locks this DAV resource.

boolean makeCollection()
          Makes a collection.

DAVResource move(java.lang.String targetPath)
          Moves this DAV resource to the location given in the parameter.

void removeProperties(org.w3c.dom.Element[] propNames)
          Removes the properties specified in the parameter.

void removeProperties(PropertyName[] propertyNames)
          Removes the properties specified in the parameter.

void removeProperty(org.w3c.dom.Element propName)
          Removes the property specified in the parameter.

void removeProperty(PropertyName propName)
          Removes the property specified in the parameter.

void removeProperty(java.lang.String propName)
          Removes the property specified in the parameter.

java.lang.String setAcl(com.sas.services.webdav.Acl acl)
          Sets the access control list for this DAV resource.

java.lang.String setACL(java.lang.String acl)
          Set/Update the Access Control List for this DAV resource.

void setContents(byte[] contents)
          Sets the contents of the resource, passing in a byte array.

void setContents(java.io.InputStream is)
          Sets the contents of the resource from an input stream.

void setContents(java.lang.String content)
          Sets the contents of the resource, passing in a URL.

void setContents(java.net.URL url)
          Sets the contents of the resource, passing in a URL.

void setContentType(java.lang.String contentType)
          Sets the contents type for the content of the resource.

void setCredentialsProvider(org.apache.http.client.CredentialsProvider credentialsProvider)
          Sets a credentials provider.

void setDebug(int debug)
          Set the value for debug.

void setDepth(int depth)
          Set the value for depth.

void setExistsRequirement(int requirement)
          Sets the existence requirement.

void setOverwrite(boolean overwrite)
          Sets the overwrite flag which specifies whether this DAV resource can be overwritten.

void setPassword(java.lang.String password)
          Set the value for password.

void setPath(java.lang.String path)
          Sets the path for this DAV resource.

void setProperties(org.w3c.dom.DocumentFragment props)
          Sets the values of properties, as given in the parameter.

void setProperties(org.w3c.dom.Element[] elems)
          Sets the values of properties, as given in the parameter.

void setProperties(PropertyName[] propNames, java.lang.String[] propValues)
          Sets the values of properties, as given in the parameter.

void setProperty(org.w3c.dom.Element prop)
          Sets the value of a property, as given in the parameter.

void setProperty(PropertyName propName, java.lang.String propValue)
          Sets the value of a property, as given in the parameter.

void setTempDir(java.lang.String tempDir)
          Provides a way to set a directory for temporary files.

void setUserName(java.lang.String userName)
          Set the value for userName.

boolean SUCCEEDED()
          Returns whether the last method was successful or not.

protected static boolean SUCCEEDED(int statusCode)


static java.lang.String unencodePath(java.lang.String path)
          Unencode the path.

void unlock()
          Unlocks the resource, if previously locked by the same principal.

void unlock(java.lang.String lockToken)
          Unlocks the resource, with the correct locktoken.

Field Summary
`protected ConnectionInfo`	`_connectionInfo` Connection information.
`static int`	`DONT_CARE`
`static int`	`HTTP_DEFAULT_PORT` The default port for HTTP is `80`.
`static int`	`MUST_EXIST`
`static int`	`MUST_NOT_EXIST`

Constructor Summary
`DAVResource(ConnectionInfo cInfo)` Creates a DAVResource using the connection information.
`DAVResource(ConnectionInfo cInfo, boolean createCollection)` Creates a DAVResource using the connection information.
`DAVResource(java.lang.String url)` Creates a DAVResource using a string URL.
`DAVResource(java.lang.String url, boolean createCollection)` Creates a DAVResource using a string URL and boolean flag to indicate whether a collection should be created.
`DAVResource(java.lang.String url, java.lang.String userName, java.lang.String password)` Creates a DAVResource using a string URL, userName and password.
`DAVResource(java.net.URL url)` Creates a DAVResource using a Java URL.

Method Summary
`void`	`close()` Closes the socket used for this connection.
`org.apache.http.entity.ContentType`	`contentType()` Gets the Apache HTTP entity content type of the content for this DAV resource.
`DAVResource`	`copy(java.lang.String targetPath)` Copies resource to the target destination.
`void`	`delete()` Deletes this DAV resource.
`void`	`doCheckin()` Check in this DAV resource.
`void`	`doCheckout()` Checks out this DAV resource.
`void`	`doControl()` Puts the resource under version control.
`void`	`doLabel(int labelAction, java.lang.String label)` Modifies the version label on the resource (if this is supported by the server).
`void`	`doLabel(int labelAction, java.lang.String label, int depth)` Modifies the label on the version resource (if this is supported by the server).
`java.util.Properties`	`doOptions()` Gets the options as Properties representing the header name/value pairs.
`DavPropertyResult`	`doReport(org.apache.jackrabbit.webdav.version.report.ReportInfo reportInfo)` Gets a report on the current DAV resource.
`DavPropertyResult`	`doSearch(org.apache.jackrabbit.webdav.search.SearchInfo searchInfo)` The SEARCH method invokes one of the implemented search grammars on the server to evaluate the query.
`void`	`doUncheckout()` Uncheckout this DAV resource, canceling a previous checkout.
`boolean`	`exists()` Returns whether the resource exists.
`static java.lang.String`	`extractPath(java.lang.String url)` Extract the path (query and fragment identifier from a URL).
`com.sas.services.webdav.Acl`	`getAcl()` Gets the access control list for this DAV resource.
`java.lang.String`	`getACL()` Gets the access control list (ACL) for this DAV resource.
`java.lang.String[]`	`getAllowedMethods()` Returns a list of methods allowed on this resource.
`com.sas.services.webdav.Version`	`getCheckedIn()` Retrieves the currently checked in resource.
`com.sas.services.webdav.Version`	`getCheckedOut()` Retrieves the currently checked out resource.
`java.util.List<java.lang.String>`	`getChildrenList(java.lang.String path)` Gets the list of children.
`java.util.Map<java.lang.String,PropertyMap>`	`getChildrenProperties(PropertyName[] properties)` Get all the properties of a collection's members (depth=1) in as single server request.
`byte[]`	`getContents()` Gets the contents of this DAV resource as a byte array.
`void`	`getContents(java.io.File fileData)` Gets the content of this DAV resource into a file specified as the parameter.
`java.lang.String`	`getContentsAsString()` Gets the contents of this DAV resource as a String.
`java.io.InputStream`	`getContentsInputStream()` Gets the content of this DAV resource as a stream.
`java.lang.String`	`getContentType()` Gets the content type of the content for this DAV resource.
`java.lang.String[]`	`getDavCapabilities()` Returns a list of DAV capabilities.
`DavPropertyResult`	`getDavProperties()` Gets all of the DAV resource's properties using the resource's depth.
`DavPropertyResult`	`getDavProperties(org.apache.jackrabbit.webdav.property.DavPropertyNameSet davPropertyNameSet, int depth)` Gets the properties for the specified DAV property names and search depth.
`DavPropertyResult`	`getDavProperties(int depth)` Gets all of the DAV resource's properties for the specified depth.
`DavPropertyResult`	`getDavProperties(PropertyName[] propertyNames)` Gets all the properties for the specified property names on the DAV resource.
`DavPropertyResult`	`getDavProperties(PropertyName[] propertyNames, int depth)` Gets all the properties for the specified property names on the DAV resource.
`DavPropertyResult`	`getDavPropertyNames()` Gets DAV properties for all of a DAV resource's property names.
`DavPropertyResult`	`getDavPropertyNames(int depth)` Gets DAV properties for all of a DAV resource's property names for the specified depth.
`int`	`getDepth()` Gets the value for depth.
`int`	`getExistsRequirement()` Gets the existence requirement.
`java.lang.String`	`getLock(java.lang.String userName)` Gets this DAV resource's lock token for the specified user.
`java.util.Map`	`getMultiStatus()` Returns the multiple status information for the last operation.
`boolean`	`getOverwrite()` Gets the overwrite flag which specifies whether this DAV resource can be overwritten.
`java.lang.String`	`getPath()` Gets the path for the WebDAV resource that is currently represented by this DAVResource.
`java.util.List`	`getPreviousVersionNames()` Gets a list of previous version names for this DAV resource.
`PropertyMap`	`getPropertyMap()` Returns a property map of the resources properties.
`int`	`getStatusCode()` Gets the HTTP status code for the last operation/method.
`java.lang.String`	`getStatusMessage()` Gets the message associated with the status code for the last operation/method.
`java.lang.String`	`getTempDir()` Returns the current setting for the directory for temporary files.
`java.net.URL`	`getURL()` Gets the URL that this DAV resource represents.
`com.sas.services.webdav.Version`	`getVersion(java.lang.String versionName)` Gets a particular version of this DAV resource.
`protected boolean`	`isAuthReqd()` Returns whether a password is required to connect to this server
`boolean`	`isCollection()` Is this DAV resource a collection?
`boolean`	`isLocked()` Is this DAV resource locked?
`java.lang.String`	`lock()` Locks this DAV resource.
`boolean`	`makeCollection()` Makes a collection.
`DAVResource`	`move(java.lang.String targetPath)` Moves this DAV resource to the location given in the parameter.
`void`	`removeProperties(org.w3c.dom.Element[] propNames)` Removes the properties specified in the parameter.
`void`	`removeProperties(PropertyName[] propertyNames)` Removes the properties specified in the parameter.
`void`	`removeProperty(org.w3c.dom.Element propName)` Removes the property specified in the parameter.
`void`	`removeProperty(PropertyName propName)` Removes the property specified in the parameter.
`void`	`removeProperty(java.lang.String propName)` Removes the property specified in the parameter.
`java.lang.String`	`setAcl(com.sas.services.webdav.Acl acl)` Sets the access control list for this DAV resource.
`java.lang.String`	`setACL(java.lang.String acl)` Set/Update the Access Control List for this DAV resource.
`void`	`setContents(byte[] contents)` Sets the contents of the resource, passing in a byte array.
`void`	`setContents(java.io.InputStream is)` Sets the contents of the resource from an input stream.
`void`	`setContents(java.lang.String content)` Sets the contents of the resource, passing in a URL.
`void`	`setContents(java.net.URL url)` Sets the contents of the resource, passing in a URL.
`void`	`setContentType(java.lang.String contentType)` Sets the contents type for the content of the resource.
`void`	`setCredentialsProvider(org.apache.http.client.CredentialsProvider credentialsProvider)` Sets a credentials provider.
`void`	`setDebug(int debug)` Set the value for debug.
`void`	`setDepth(int depth)` Set the value for depth.
`void`	`setExistsRequirement(int requirement)` Sets the existence requirement.
`void`	`setOverwrite(boolean overwrite)` Sets the overwrite flag which specifies whether this DAV resource can be overwritten.
`void`	`setPassword(java.lang.String password)` Set the value for password.
`void`	`setPath(java.lang.String path)` Sets the path for this DAV resource.
`void`	`setProperties(org.w3c.dom.DocumentFragment props)` Sets the values of properties, as given in the parameter.
`void`	`setProperties(org.w3c.dom.Element[] elems)` Sets the values of properties, as given in the parameter.
`void`	`setProperties(PropertyName[] propNames, java.lang.String[] propValues)` Sets the values of properties, as given in the parameter.
`void`	`setProperty(org.w3c.dom.Element prop)` Sets the value of a property, as given in the parameter.
`void`	`setProperty(PropertyName propName, java.lang.String propValue)` Sets the value of a property, as given in the parameter.
`void`	`setTempDir(java.lang.String tempDir)` Provides a way to set a directory for temporary files.
`void`	`setUserName(java.lang.String userName)` Set the value for userName.
`boolean`	`SUCCEEDED()` Returns whether the last method was successful or not.
`protected static boolean`	`SUCCEEDED(int statusCode)`
`static java.lang.String`	`unencodePath(java.lang.String path)` Unencode the path.
`void`	`unlock()` Unlocks the resource, if previously locked by the same principal.
`void`	`unlock(java.lang.String lockToken)` Unlocks the resource, with the correct `locktoken`.

Field Detail

HTTP_DEFAULT_PORT

public static final int HTTP_DEFAULT_PORT

The default port for HTTP is 80.

See Also:: Constant Field Values

_connectionInfo

protected ConnectionInfo _connectionInfo

Connection information.

DONT_CARE

public static final int DONT_CARE

See Also:: Constant Field Values

MUST_EXIST

public static final int MUST_EXIST

See Also:: Constant Field Values

MUST_NOT_EXIST

public static final int MUST_NOT_EXIST

See Also:: Constant Field Values

Constructor Detail