Class WebdavResource
WebdavResource
is an abstract representation
for WebDAV resource.
A functional comparison of WebdavResource and JDK(It's different a lot). ----------------------------------+------------------------------------- File class (JDK 1.3.x) | WebdavResource class ----------------------------------+------------------------------------- File(String) | WebdavResource(HttpURL) File(String, String) | X (need to escape) File(File, String) | WebdavResource(HttpURL, String) getName() | getName() getParent() | *see getHttpURL() and HttpURL getParentFile() | X (not yet) getPath() | getPath() isAbsolute() | X getAbsolutePath() | getAbsoluteFile() | X getCanonicalPath() | getCanonicalFile() | X toURL() | *see HttpURL canRead() | !canWrite() | !isLocked() exists() | exists() isDirectory() | isCollection() isFile() | !isCollection() isHidden() | getIsHidden() lastModified() | getGetLastModified() length() | getGetContentLength() createNewFile() | putMethod(String) delete() | deleteMethod() deleteOnExit() | X list() | list() list(FilenameFilter) | X listFiles() | listWebdavResources() listFiles(FilenameFilter) | X listFiles(FileFilter) | X mkdir() | mkcolMethod() mkdirs() | mkcolMethod() renameTo(File) | moveMethod(String) setLastModified() | X setReadOnly() | setOverwrite(boolean) listRoots() | *see WebdavSession generateFile() | createTempFile(...) | setGetTempDir(String) compareTo(Object) | compareTo(Object) equals(Object) | equals(Object) hashCode() | X ----------------------------------+------------------------------------- URL class (JDK 1.3.x) | Webdavresource and HttpURL classes ----------------------------------+------------------------------------- getQuery() | getQuery() getPath() | getPath() getUserInfo() | getUserInfo() getAuthority() | getAuthority() getPort() | getPort() getProtocol() | getScheme() getHost() | getHost() getFile() | getPath() getRef() | getFragmenet() hashCode() | X sameFile() | toExternalForm() | toExternalForm() openConnection() | openStream() | getContent() | getMethodDataAsString() ----------------------------------+------------------------------------- URLConnection class (JDK 1.3.x) | HttpClient Library and more ----------------------------------+------------------------------------- getFileNameMap() | X setFileNameMap() | X connect() | getURL() | HttpURL#getURL() getContenetLength()() | getContentType() | getContentEncoding() | getExpiration() | getDate() | getLastModified() | getHeaderField() | getHeaderFieldInt() | X getHeaderFielDate() | X getHeaderFieldKey() | X getHeaderFiled(int) | X getContenet() | getInputStream() | WebdavResource#getMethodData() getOutputStream() | WebdavResource#putMethod(...) setDoInput() | X getDoInput() | X setAllowUserInteraction() | *see WebdavException and WebdavStatus getAllowUserInteraction() | *see WebdavException and WebdavStatus setUseCaches() | getUseCaches() | getIfModifiedSince() | X setIfModifiedSince(boolean) | X setRequestProperty(...) | X getRequestProperty(...) | X guessContentTypeFromStream(...) | X ----------------------------------+-------------------------------------
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The action setting the all properties for this resource.protected Enumeration
The allowed HTTP methods.static final int
The action setting the basic properties for this resource.protected WebdavResources
Table of the hrefs gotten in a collection.protected long
An WebDAV property, creationdate.static final String
The creationdate property.protected Enumeration
The capabilities of the WebDAV server.static final int
The action setting the default DAV properties for this resource.protected static int
The default action to find properties.protected static int
The default depth for WebDAV methods.static final String
Owner information for locking and unlocking.protected String
An WebDAV property, displayname.static final String
The displayname property.protected boolean
An WebdavResource flag to check its existence;static final String
The false constant string.protected boolean
static final SimpleDateFormat[]
Date formats using for Date parsing.static final String
The getcontentlanguage property.protected long
An WebDAV property, getcontentlength.static final String
The getcontentlength property.protected String
An WebDAV property, getcontenttype.static final String
The getcontenttype property.protected String
An WebDAV property, getetag.static final String
The getetag property.protected long
An WebDAV property, getlastmodified.static final String
The getlastmodifed property.protected static final TimeZone
GMT timezone.protected Map
Map of additional headersprotected org.apache.commons.httpclient.HttpURL
The HttpURL to represent a WebDAV resource.protected boolean
An WebDAV property, iscollection.static final String
The iscollection property.protected boolean
An WebDAV property, ishidden.static final String
The ishidden property.static final int
static final int
static final int
protected int
An status code performed by HTTP methods at the most recent.protected String
An status message performed by HTTP methods at the most recent.protected LockDiscoveryProperty
An WebDAV property, lockdiscovery.static final String
The lockdiscovery property.static final int
The action setting only the displayname for this resource.static final int
No action to find properties for this resource.static final int
static final int
protected boolean
An WebdavResource flag to check overwriting;protected String
Owner information for locking and unlocking.protected ResourceTypeProperty
An WebDAV property, resourcetype.static final String
The resourcetype property.static final String
The source property.protected String
An WebDAV property, supportedlock.static final String
The supportedlock property.protected static String
Deprecated.The client is responsible for disk I/O.protected boolean
The flag to set the status code by propfind.static final String
The true constant string.protected static boolean
Deprecated.The client is responsible for disk I/O.Fields inherited from class org.apache.webdav.lib.WebdavSession
client, debug, hostCredentials, proxyCredentials, proxyHost, proxyPort
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
The default constructor.WebdavResource
(String escapedHttpURL) The constructor.WebdavResource
(String escapedHttpURL, boolean followRedirects) WebdavResource
(String escapedHttpURL, String proxyHost, int proxyPort) The constructor.WebdavResource
(String escapedHttpURL, String proxyHost, int proxyPort, org.apache.commons.httpclient.Credentials proxyCredentials) The constructor.WebdavResource
(String escapedHttpURL, org.apache.commons.httpclient.Credentials credentials) The constructor.WebdavResource
(String escapedHttpURL, org.apache.commons.httpclient.Credentials credentials, boolean followRedirects) protected
WebdavResource
(org.apache.commons.httpclient.HttpClient client) The constructor.WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL) The constructor.WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL, boolean followRedirects) The constructor.WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL, int depth) The constructor.WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL, int depth, boolean followRedirects) The constructor.WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL, int action, int depth) The constructor.WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL, int action, int depth, boolean followRedirects) The constructor.WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL, String additionalPath) The constructor.WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL, String additionalPath, boolean followRedirects) The constructor.WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL, String proxyHost, int proxyPort) The constructor.WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL, String proxyHost, int proxyPort, boolean followRedirects) WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL, String proxyHost, int proxyPort, org.apache.commons.httpclient.Credentials proxyCredentials) The constructor.WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL, String proxyHost, int proxyPort, org.apache.commons.httpclient.Credentials proxyCredentials, boolean followRedirects) WebdavResource
(org.apache.commons.httpclient.HttpURL httpURL, org.apache.commons.httpclient.Credentials credentials, int action, int depth) The constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Aborts - i.e.Return theAclProperty
for the current resourceaclfindMethod
(String path) Return theAclProperty
for the resource at the given pathboolean
Updates the resource with a new set of aces.aclReportMethod
(String path, Collection properties, int reportType) Execute REPORT method.void
addRequestHeader
(String header, String value) Add a header in the request sent to the webdav serverboolean
bindMethod
(String newBinding) Execute the BIND method for this WebdavResource, given an existing path to bind with.boolean
bindMethod
(String existingBinding, String newBinding) Execute the BIND method given the new path to bind to an existing path.boolean
Execute the CHECKIN method for this WebdavResource.boolean
checkinMethod
(String path) Execute the CHECKIN method for the given path.boolean
Execute the CHECKOUT method for this WebdavResource.boolean
checkoutMethod
(String path) Execute the CHECKOUT method for the given path.void
close()
Close the session of this clientboolean
Commits the transaction started bystartTransaction(String, int)
and resets the transaction handle.int
Compare to the given another object.int
compareToWebdavResource
(WebdavResource another) Compare to the WebdavResource object.boolean
copyMethod
(String destination) Execute the COPY method for the given destination path.boolean
copyMethod
(String source, String destination) Execute the COPY method the given source and destination.protected WebdavResource
createWebdavResource
(org.apache.commons.httpclient.HttpClient client) Create a new WebdavResource object (as a seperate method so that it can be overridden by subclasses.boolean
Execute the DELETE method for this WebdavResource.boolean
deleteMethod
(String path) Execute the DELETE method for the given path.protected WebdavState
discoverLock
(String owner, String path, WebdavState state) Discover the given owner and locktoken and set the locktokenvoid
Discover and refresh lock tokens.void
discoverOwnLocks
(String owner) Discover and refresh lock tokens for a specific owner.protected boolean
endTransaction
(String path, int transactionStatus) boolean
Test the object.int
executeHttpRequestMethod
(org.apache.commons.httpclient.HttpClient client, org.apache.commons.httpclient.HttpMethod method) Execute the http request method.boolean
exists()
Returns the last known information about the existence of this resource.protected void
generateAdditionalHeaders
(org.apache.commons.httpclient.HttpMethod method) Add all additionals headers that have been previously registered with addRequestHeader to the methodprotected void
generateIfHeader
(org.apache.commons.httpclient.HttpMethod method) Generate and add the If header to the specified HTTP method.protected void
generateTransactionHeader
(org.apache.commons.httpclient.HttpMethod method) Generates and adds the "Transaction" header if this method is part of an externally controlled transaction.Get the activelock owners for this resource.Get the allowed methods, checked by HTTP OPTIONS.Get all resources in this collection with the depth 1.long
Get the value of DAV property, creationdate.Get the WebDAV capabilities, checked by HTTP OPTIONS.static int
Get the default action.static int
Get the default action.Get the value of DAV property, displayname.boolean
Returns the last known information about the existence of this resource.boolean
Returns the current "follow redirects" flag.long
Get the value of DAV property, getcontentlength.Get the value of DAV property, getcontenttype.Get the value of DAV property, getetag.long
Get the value of DAV property, getlastmodified.static String
Deprecated.The returned directory is not used by the GET method.static boolean
Deprecated.This method always returns false.getHost()
Get the hostname of this WebdavResource.org.apache.commons.httpclient.HttpURL
Get the HttpURL of this WebdavResource.org.apache.commons.httpclient.HttpURL
Get the HttpURL except for userinfo.boolean
Get the value of DAV property, iscollectionboolean
Get the value of DAV property, ishidden.Get the value of DAV property, lockdiscovery.boolean
Execute the GET method for this WebdavResource path.boolean
Execute the GET method for the given path.Get InputStream for the GET method.getMethodData
(String path) Get InputStream for the GET method for the given path.Get data as a String for the GET method.getMethodDataAsString
(String path) Get data as a String for the GET method for the given path.getName()
Get the name of this WebdavResource.boolean
Get the current value of the overwrite flag for COPY, MOVE, BIND and REBIND.getOwner()
Get the owner string, as used for locking purposes.getPath()
Get the path part of this WebdavResource.Get the value of DAV property, resourcetype.int
Get the lastest value of the status code by HTTP methods.Get the lastest value of the status message by HTTP methods.Get the value of DAV property, supportedlock.Returns the transaction handle set bystartTransaction(String, int)
.boolean
Execute the HEAD method for this WebdavResource.boolean
headMethod
(String path) Execute the HEAD method for the given path.boolean
Get the value of DAV property, resourcetypeboolean
isLocked()
Test that this resource is locked.protected boolean
Test that the httpURL is the same with the client.boolean
labelMethod
(String labelname, int type) Execute a LABEL method on the current path, setting the given labelboolean
labelMethod
(String path, String labelname, int type) Execute a LABEL method on the given path, setting the given labelString[]
list()
Get an array of pathnames denoting the WebDAV resources in the collection denoted by this pathname.Get an array of pathnames and basic information denoting the WebDAV resources in the denoted by this pathname.Get an array of resources denoting the WebDAV child resources in the collection of this resources.Return the LockDiscoveryProperty for the current resourceReturn the LockDiscoveryProperty for the resource at the given pathboolean
Execute the LOCK method for this WebdavResource.boolean
lockMethod
(String path) Execute the LOCK method for the given path.boolean
lockMethod
(String owner, int timeout) Execute the LOCK method for this WebdavResource.boolean
lockMethod
(String owner, short timeout) Deprecated.The timeout value MUST NOT be greater than 2^32-1.boolean
lockMethod
(String path, String owner, int timeout) Execute the LOCK method for the given path.boolean
lockMethod
(String path, String owner, int timeout, short lockType) Execute the LOCK method for the given path.boolean
lockMethod
(String path, String owner, int timeout, short lockType, int depth) Execute the LOCK method for the given path.boolean
lockMethod
(String path, String owner, short timeout) Deprecated.The timeout value MUST NOT be greater than 2^32-1.boolean
Execute the MKCOL method for this WebdavResource.boolean
mkcolMethod
(String path) Execute the MKCOL method for the given path.boolean
Execute the MKWORKSPACE method for this WebdavResource.boolean
mkWorkspaceMethod
(String path) Execute the MKCOL method for the given path.boolean
moveMethod
(String destination) Execute the MOVE method for this WebdavReource.boolean
moveMethod
(String source, String destination) Execute the MOVE method for the given source and destination.boolean
Execute OPTIONS method for this WebdavResource.boolean
optionsMethod
(String path) Execute OPTIONS method for the given path.optionsMethod
(String path, int type) Execute OPTIONS method for the given path.boolean
optionsMethod
(String path, String aMethod) Execute OPTIONS method for the given path.optionsMethod
(org.apache.commons.httpclient.HttpURL httpURL) Execute OPTIONS method for the given http URL.optionsMethod
(org.apache.commons.httpclient.HttpURL httpURL, int type) Execute OPTIONS method for the given http URL, DELTAVprotected Date
Parse thejava.util.Date
string for HTTP-date.boolean
pollMethod
(String contentLocation, int subscriptionId) Asks the server whether events for a given subscription are fired.boolean
pollMethod
(Subscription subscription) Asks the server whether events for a given subscription are fired.Get thePrincipalCollectionSetProperty
for the current resource.Get thePrincipalCollectionSetProperty
for the resource.protected void
processProperty
(Property property) Process a property, setting various member variables depending on what the property is.propfindMethod
(int depth) Execute PROPFIND method with allprop for this WebdavResource.propfindMethod
(int depth, Vector properties) Execute PROPFIND method with by propname for this resource.propfindMethod
(String propertyName) Execute PROPFIND method for this WebdavResource.propfindMethod
(String path, int depth) Execute PROPFIND method with allprop for the given path.propfindMethod
(String path, int depth, Vector properties) Execute PROPFIND method with by propname for the given path.propfindMethod
(String path, String propertyName) Execute PROPFIND method for the given WebdavResource path.propfindMethod
(String path, Vector properties) Execute PROPFIND method for the given path and properties.propfindMethod
(Vector properties) Execute PROPFIND method for this WebdavResource.boolean
proppatchMethod
(String propertyName, String propertyValue) Deprecated.it could be removed after the major version changesboolean
proppatchMethod
(String propertyName, String propertyValue, boolean action) Execute PROPATCH method for this resource with the given property.boolean
proppatchMethod
(String path, String propertyName, String propertyValue) Deprecated.it could be removed after the major version changesboolean
proppatchMethod
(String path, String propertyName, String propertyValue, boolean action) Execute PROPATCH method for the specified resource with the given property.boolean
proppatchMethod
(String path, Hashtable properties) Deprecated.it could be removed after the major version changesboolean
proppatchMethod
(String path, Hashtable properties, boolean action) Execute PROPATCH method for the specified resource with the given properties.boolean
proppatchMethod
(String path, PropertyName propertyName, String propertyValue) Deprecated.it could be removed after the major version changesboolean
proppatchMethod
(String path, PropertyName propertyName, String propertyValue, boolean action) Execute PROPATCH method for the given resource with the given properties.boolean
proppatchMethod
(Hashtable properties) Deprecated.it could be removed after the major version changesboolean
proppatchMethod
(Hashtable properties, boolean action) Execute PROPATCH method for this resource with the given properties.boolean
proppatchMethod
(PropertyName propertyName, String propertyValue) Deprecated.it could be removed after the major version changesboolean
proppatchMethod
(PropertyName propertyName, String propertyValue, boolean action) Execute PROPATCH method for this resource with the given property.boolean
putMethod
(byte[] data) Execute the PUT method for this resource.boolean
Execute the PUT method for this WebdavResource.boolean
putMethod
(InputStream is) Execute the PUT method for this resource.boolean
Execute the PUT method for this WebdavResource.boolean
Execute the PUT method for the given path.boolean
Execute the PUT method for the given path.boolean
putMethod
(String path, InputStream is) Execute the PUT method for the given path.boolean
Execute the PUT method for the given path.boolean
Execute the PUT method for the given path from the given url.boolean
Execute the PUT method for this resource from the given url.boolean
rebindMethod
(String newBinding) Execute the Rebind method for this WebdavResource given the new Resource to bind with.boolean
rebindMethod
(String existingBinding, String newBinding) Execute the Rebind method given a resource to rebind and the new Resource to bind with.protected void
refresh()
Refresh the properties of this resource without changing the status of the previous commandreportMethod
(org.apache.commons.httpclient.HttpURL httpURL, int depth) Execute the REPORT method.reportMethod
(org.apache.commons.httpclient.HttpURL httpURL, String sQuery, int depth) reportMethod
(org.apache.commons.httpclient.HttpURL httpURL, Vector properties) reportMethod
(org.apache.commons.httpclient.HttpURL httpURL, Vector properties, int depth) reportMethod
(org.apache.commons.httpclient.HttpURL httpURL, Vector properties, Vector histUri, int depth) org.apache.commons.httpclient.HttpClient
Retrieve the current http client for this resource.protected void
setAllProp
(int depth) Set all properties for this resource.protected void
setBasicProperties
(int depth) Sets the basic properties on a resource by indirectly issuing a PROPFIND on the resource.protected void
Set the client for this resource.protected void
setClient
(org.apache.commons.httpclient.HttpURL httpURL) Set the client for this resource and the given http URL.void
setContentType
(String contentType) Set the content-type to use for this resource, for PUTs.protected void
setCreationDate
(long creationDate) Set the value of DAV property, creationdate.protected void
setCreationDate
(String creationDate) Set the value of DAV property, creationdate.static void
setDefaultAction
(int action) Set the default action for this resource.static void
setDefaultDepth
(int depth) Set the default action for this resource.protected void
setDefaultProperties
(int depth) Set the default properties on the resource by indirectly issuing a PROPFIND request for a default set of properties.protected void
setDisplayName
(String displayName) Set the value of DAV property, displayname.void
setEncodeURLs
(boolean encodeURLs) Deprecated.No longer has any effect.protected void
setExistence
(boolean exists) Set its existence.void
setFollowRedirects
(boolean value) Sets a flag indicating that redirect responses from the server shall be followed.protected void
setGetContentLength
(long getContentLength) Set the value of DAV property, getcontentlength.protected void
setGetContentLength
(String getContentLength) Set the value of DAV property, getcontentlength.protected void
setGetContentType
(String getContentType) Set the value of DAV property, getcontenttype.protected void
setGetEtag
(String getEtag) Set the value of DAV property, getetag.protected void
setGetLastModified
(long getLastModified) Set the value of DAV property, getlastmodified.protected void
setGetLastModified
(String getLastModified) Set the value of DAV property, getlastmodified.static void
setGetTempDir
(String tempDir) Deprecated.The given directory will not be used.static void
setGetUseDisk
(boolean useDisk) Deprecated.This method has no effect.void
setHttpURL
(String escapedHttpURL) Set the HttpURL of this WebdavResource.void
setHttpURL
(org.apache.commons.httpclient.HttpURL httpURL) Set the HttpURL for this WebdavResource.void
setHttpURL
(org.apache.commons.httpclient.HttpURL httpURL, int depth) Set the HttpURL for this WebdavResource.void
setHttpURL
(org.apache.commons.httpclient.HttpURL httpURL, int action, int depth) Set the HttpURL for this WebdavResource.void
setHttpURL
(org.apache.commons.httpclient.HttpURL httpURL, String additionalPath) Set the HttpURL for this WebdavResource.void
setHttpURL
(org.apache.commons.httpclient.HttpURL httpURL, String additionalPath, int action) Set the HttpURL for this WebdavResource.void
setHttpURL
(org.apache.commons.httpclient.HttpURL httpURL, String additionalPath, int action, int depth) Set the HttpURL for this WebdavResource.protected void
setIsCollection
(boolean isCollection) Set the value of DAV property, iscollectionprotected void
setIsCollection
(String isCollection) Set the value of DAV property, iscollectionprotected void
setIsHidden
(boolean isHidden) Set the value of DAV property, ishidden.protected void
setIsHidden
(String isHidden) Set the value of DAV property, ishidden.protected void
setLockDiscovery
(LockDiscoveryProperty lockDiscovery) Set the value of DAV property, lockdiscovery.protected void
setNamedProp
(int depth, Vector propertyNames) Set the named properties for this resource.protected void
setNameProperties
(int depth) Set only the displayname property for this resource.void
setOverwrite
(boolean overwrite) Set the overwrite flag for COPY, MOVE, BIND and REBIND.void
Set the path part of this WebdavResource.void
setProperties
(int depth) Set the properties for this resource.void
setProperties
(int action, int depth) Set the properties for this resource.protected void
setResourceType
(ResourceTypeProperty resourceType) Set the value of DAV property, resourcetype.protected void
setStatusCode
(int statusCode) Set the lastest value of the status code by HTTP methods.protected void
setStatusCode
(int statusCode, String message) Set the lastest value of the status code by HTTP methods.protected void
setSupportedLock
(String supportedLock) Set the value of DAV property, supportedlock.void
setUserInfo
(String userName, String password) Set the userinfo part of this WebdavResource.protected void
setWebdavProperties
(Enumeration responses) Set WebDAV properties following to the given http URL.boolean
startTransaction
(String owner, int timeout) Begins a new transaction.boolean
subscribeMethod
(String path, int subscriptionId) Refreshes a subscription.subscribeMethod
(String path, String notificationType, String callback, long notificationDelay, int depth, long lifetime) Subscribes for notifications for modifications of WebDAV resources.boolean
subscribeMethod
(Subscription subscription) Refreshes a subscription.toString()
Return the http URL string.boolean
Execute the UNBIND method for this WebdavResource.boolean
unbindMethod
(String binding) Execute the UNBIND method given the resource to Unbind.boolean
Execute the CHECKOUT method for this WebdavResource.boolean
uncheckoutMethod
(String path) Execute the CHECKOUT method for the given path.boolean
Execute the Unlock method for this WebdavResource.boolean
unlockMethod
(String path) Execute the Unlock method for the given path.boolean
unlockMethod
(String path, String owner) Execute the Unlock method for the given path.boolean
unsubscribeMethod
(String path, int subscriptionId) Cancels a subscription.boolean
unsubscribeMethod
(Subscription subscription) Cancels a subscription.boolean
updateMethod
(String target) Update this resource to the specified targetboolean
updateMethod
(String path, String target) Update the specified resource to the specified targetboolean
versionControlMethod
(String path) boolean
versionControlMethod
(String path, String target) Methods inherited from class org.apache.webdav.lib.WebdavSession
closeSession, closeSession, getSessionInstance, getSessionInstance, setCredentials, setDebug, setProxy, setProxyCredentials
-
Field Details
-
DISPLAYNAME
The displayname property.- See Also:
-
GETCONTENTLANGUAGE
The getcontentlanguage property.- See Also:
-
GETCONTENTLENGTH
The getcontentlength property.- See Also:
-
GETLASTMODIFIED
The getlastmodifed property.- See Also:
-
CREATIONDATE
The creationdate property.- See Also:
-
RESOURCETYPE
The resourcetype property.- See Also:
-
SOURCE
The source property.- See Also:
-
GETCONTENTTYPE
The getcontenttype property.- See Also:
-
GETETAG
The getetag property.- See Also:
-
ISHIDDEN
The ishidden property.- See Also:
-
ISCOLLECTION
The iscollection property.- See Also:
-
SUPPORTEDLOCK
The supportedlock property.- See Also:
-
LOCKDISCOVERY
The lockdiscovery property.- See Also:
-
NOACTION
public static final int NOACTIONNo action to find properties for this resource.- See Also:
-
NAME
public static final int NAMEThe action setting only the displayname for this resource.- See Also:
-
BASIC
public static final int BASICThe action setting the basic properties for this resource.- See Also:
-
DEFAULT
public static final int DEFAULTThe action setting the default DAV properties for this resource.- See Also:
-
ALL
public static final int ALLThe action setting the all properties for this resource.- See Also:
-
OPTIONS_WORKSPACE
public static final int OPTIONS_WORKSPACE- See Also:
-
OPTIONS_VERSION_HISTORY
public static final int OPTIONS_VERSION_HISTORY- See Also:
-
LABEL_SET
public static final int LABEL_SET- See Also:
-
LABEL_REMOVE
public static final int LABEL_REMOVE- See Also:
-
LABEL_ADD
public static final int LABEL_ADD- See Also:
-
defaultOwner
Owner information for locking and unlocking.- See Also:
-
TRUE
The true constant string.- See Also:
-
FALSE
The false constant string.- See Also:
-
formats
Date formats using for Date parsing. -
gmtZone
GMT timezone. -
httpURL
protected org.apache.commons.httpclient.HttpURL httpURLThe HttpURL to represent a WebDAV resource. -
childResources
Table of the hrefs gotten in a collection. -
defaultAction
protected static int defaultActionThe default action to find properties. -
defaultDepth
protected static int defaultDepthThe default depth for WebDAV methods. -
tempDirForGet
Deprecated.The client is responsible for disk I/O.The default temporary directory for the GET method. -
useDiskForGet
protected static boolean useDiskForGetDeprecated.The client is responsible for disk I/O.The flag setter to use the disk for the GET method. -
thisResource
protected boolean thisResourceThe flag to set the status code by propfind. -
allowedMethods
The allowed HTTP methods. -
davCapabilities
The capabilities of the WebDAV server. -
exists
protected boolean existsAn WebdavResource flag to check its existence; -
overwrite
protected boolean overwriteAn WebdavResource flag to check overwriting; -
latestStatusCode
protected int latestStatusCodeAn status code performed by HTTP methods at the most recent. -
latestStatusMessage
An status message performed by HTTP methods at the most recent. -
displayName
An WebDAV property, displayname. -
getContentLength
protected long getContentLengthAn WebDAV property, getcontentlength. -
getContentType
An WebDAV property, getcontenttype. -
resourceType
An WebDAV property, resourcetype. -
getLastModified
protected long getLastModifiedAn WebDAV property, getlastmodified. -
creationDate
protected long creationDateAn WebDAV property, creationdate. -
getEtag
An WebDAV property, getetag. -
owner
Owner information for locking and unlocking. -
isHidden
protected boolean isHiddenAn WebDAV property, ishidden. -
isCollection
protected boolean isCollectionAn WebDAV property, iscollection. -
supportedLock
An WebDAV property, supportedlock. -
lockDiscovery
An WebDAV property, lockdiscovery. -
followRedirects
protected boolean followRedirects -
headers
Map of additional headers
-
-
Constructor Details
-
WebdavResource
protected WebdavResource()The default constructor. -
WebdavResource
protected WebdavResource(org.apache.commons.httpclient.HttpClient client) The constructor. -
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL, org.apache.commons.httpclient.Credentials credentials, int action, int depth) throws org.apache.commons.httpclient.HttpException, IOException The constructor.- Parameters:
httpURL
- The specified http URL.credentials
- The credentials to use for authentication.action
- The action to set properties of this resource.depth
- The depth to find properties.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL, int action, int depth) throws org.apache.commons.httpclient.HttpException, IOException The constructor.- Parameters:
httpURL
- The specified http URL.action
- The action to set properties of this resource.depth
- The depth to find properties.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL, int action, int depth, boolean followRedirects) throws org.apache.commons.httpclient.HttpException, IOException The constructor.- Parameters:
httpURL
- The specified http URL.action
- The action to set properties of this resource.depth
- The depth to find properties.followRedirects
- shall redirects from the server be accepted- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL, int depth) throws org.apache.commons.httpclient.HttpException, IOException The constructor.- Parameters:
httpURL
- The specified http URL.depth
- The depth to find properties.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL, int depth, boolean followRedirects) throws org.apache.commons.httpclient.HttpException, IOException The constructor.- Parameters:
httpURL
- The specified http URL.depth
- The depth to find properties.followRedirects
- Shall redirects be followed automatically.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL) throws org.apache.commons.httpclient.HttpException, IOException The constructor.- Parameters:
httpURL
- The specified http URL.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL, boolean followRedirects) throws org.apache.commons.httpclient.HttpException, IOException The constructor.- Parameters:
httpURL
- The specified http URL.followRedirects
- shall redirects from the server be accepted- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL, String proxyHost, int proxyPort) throws org.apache.commons.httpclient.HttpException, IOException The constructor.- Parameters:
httpURL
- The specified http URL.proxyHost
- The hostname of the proxy to use.proxyPort
- The port number of the proxy to use.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL, String proxyHost, int proxyPort, boolean followRedirects) throws org.apache.commons.httpclient.HttpException, IOException - Throws:
org.apache.commons.httpclient.HttpException
IOException
-
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL, String proxyHost, int proxyPort, org.apache.commons.httpclient.Credentials proxyCredentials) throws org.apache.commons.httpclient.HttpException, IOException The constructor.- Parameters:
httpURL
- The specified http URL.proxyHost
- The hostname of the proxy to use.proxyPort
- The port number of the proxy to use.proxyCredentials
- Credentials to use for proxy authentication.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL, String proxyHost, int proxyPort, org.apache.commons.httpclient.Credentials proxyCredentials, boolean followRedirects) throws org.apache.commons.httpclient.HttpException, IOException - Throws:
org.apache.commons.httpclient.HttpException
IOException
-
WebdavResource
public WebdavResource(String escapedHttpURL) throws org.apache.commons.httpclient.HttpException, IOException The constructor. It must be put an escaped http URL as an argument.- Parameters:
escapedHttpURL
- The escaped http URL string.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(String escapedHttpURL, boolean followRedirects) throws org.apache.commons.httpclient.HttpException, IOException - Throws:
org.apache.commons.httpclient.HttpException
IOException
-
WebdavResource
public WebdavResource(String escapedHttpURL, org.apache.commons.httpclient.Credentials credentials) throws org.apache.commons.httpclient.HttpException, IOException The constructor. It must be put an escaped http URL as an argument.- Parameters:
escapedHttpURL
- The escaped http URL string.credentials
- The credentials used for Authentication.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(String escapedHttpURL, org.apache.commons.httpclient.Credentials credentials, boolean followRedirects) throws org.apache.commons.httpclient.HttpException, IOException - Throws:
org.apache.commons.httpclient.HttpException
IOException
-
WebdavResource
public WebdavResource(String escapedHttpURL, String proxyHost, int proxyPort) throws org.apache.commons.httpclient.HttpException, IOException The constructor. It must be put an escaped http URL as an argument.- Parameters:
escapedHttpURL
- The escaped http URL string.proxyHost
- The hostname of the proxy to use.proxyPort
- The port number of the proxy to use.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(String escapedHttpURL, String proxyHost, int proxyPort, org.apache.commons.httpclient.Credentials proxyCredentials) throws org.apache.commons.httpclient.HttpException, IOException The constructor. It must be put an escaped http URL as an argument.- Parameters:
escapedHttpURL
- The escaped http URL string.proxyHost
- The hostname of the proxy to use.proxyPort
- The port number of the proxy to use.proxyCredentials
- Credentials to use for proxy authentication.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL, String additionalPath) throws org.apache.commons.httpclient.HttpException, IOException The constructor.- Parameters:
httpURL
- The http URL.additionalPath
- The added relative path.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
WebdavResource
public WebdavResource(org.apache.commons.httpclient.HttpURL httpURL, String additionalPath, boolean followRedirects) throws org.apache.commons.httpclient.HttpException, IOException The constructor.- Parameters:
httpURL
- The http URL.additionalPath
- The added relative path.followRedirects
- shall redirects be accepted- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
-
Method Details
-
generateTransactionHeader
protected void generateTransactionHeader(org.apache.commons.httpclient.HttpMethod method) Generates and adds the "Transaction" header if this method is part of an externally controlled transaction. -
generateIfHeader
protected void generateIfHeader(org.apache.commons.httpclient.HttpMethod method) Generate and add the If header to the specified HTTP method. -
generateAdditionalHeaders
protected void generateAdditionalHeaders(org.apache.commons.httpclient.HttpMethod method) Add all additionals headers that have been previously registered with addRequestHeader to the method -
parseDate
Parse thejava.util.Date
string for HTTP-date.- Returns:
- The parsed date.
-
setNameProperties
protected void setNameProperties(int depth) throws org.apache.commons.httpclient.HttpException, IOException Set only the displayname property for this resource.- Parameters:
depth
- The depth to find properties.- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
setBasicProperties
protected void setBasicProperties(int depth) throws org.apache.commons.httpclient.HttpException, IOException Sets the basic properties on a resource by indirectly issuing a PROPFIND on the resource.Properties retrieved include:
- displayname
- getcontentlength
- getcontenttype
- resourcetype
- getlastmodified
- lockdiscovery
- Parameters:
depth
- The depth to find properties.- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
setDefaultProperties
protected void setDefaultProperties(int depth) throws org.apache.commons.httpclient.HttpException, IOException Set the default properties on the resource by indirectly issuing a PROPFIND request for a default set of properties.Properties retrieved include:
- creationdate
- displayname
- getcontentlanguage
- getcontentlength
- getcontenttype
- getetag
- getlastmodified
- lockdiscovery
- resourcetype
- source
- supportedlock
- Parameters:
depth
- The depth to find properties.- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
setNamedProp
protected void setNamedProp(int depth, Vector propertyNames) throws org.apache.commons.httpclient.HttpException, IOException Set the named properties for this resource.- Parameters:
depth
- The depth.propertyNames
- The property-names.- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
setAllProp
protected void setAllProp(int depth) throws org.apache.commons.httpclient.HttpException, IOException Set all properties for this resource.- Parameters:
depth
- The depth- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
setWebdavProperties
protected void setWebdavProperties(Enumeration responses) throws org.apache.commons.httpclient.HttpException, IOException Set WebDAV properties following to the given http URL. This method is fundamental for getting information of a collection.- Parameters:
responses
- An enumeration overResponseEntity
items, one for each resource for which information was returned via PROPFIND.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- The socket error with a server.
-
setDefaultAction
public static void setDefaultAction(int action) Set the default action for this resource. The default action is set as 'BASIC' for the first time. ex) WebdavResource.NOACTION WebdavResource.NAME WebdavResource.BASIC WebdavResource.DEFAULT WebdavResource.ALL- Parameters:
action
- The action type.- See Also:
-
getDefaultAction
public static int getDefaultAction()Get the default action.- Returns:
- The action type.
-
setDefaultDepth
public static void setDefaultDepth(int depth) Set the default action for this resource. ex) DepthSupport.DEPTH_0 DepthSupport.DEPTH_1 DepthSupport.DEPTH_INFINITY- Parameters:
depth
- The depth.
-
getDefaultDepth
public static int getDefaultDepth()Get the default action.- Returns:
- The depth.
-
setGetTempDir
Deprecated.The given directory will not be used.Get the default temporary directory for the GET method.- Parameters:
tempDir
- The temporary directory.
-
getGetTempDir
Deprecated.The returned directory is not used by the GET method.Get the default temporary directory for the GET method. The default temporary directory is "temp/".- Returns:
- The temporary directory path. It's set by default, if it returns null.
-
setGetUseDisk
public static void setGetUseDisk(boolean useDisk) Deprecated.This method has no effect.Set the use disk flag for the GET method.- Parameters:
useDisk
- The use disk flag.
-
getGetUseDisk
public static boolean getGetUseDisk()Deprecated.This method always returns false.Get the use disk flag for the GET method.- Returns:
- The current flag of the use disk. By default, it's true.
-
setFollowRedirects
public void setFollowRedirects(boolean value) Sets a flag indicating that redirect responses from the server shall be followed. -
getFollowRedirects
public boolean getFollowRedirects()Returns the current "follow redirects" flag.- See Also:
-
isTheClient
protected boolean isTheClient() throws org.apache.commons.httpclient.URIExceptionTest that the httpURL is the same with the client.- Returns:
- true if the given httpURL is the client for this resource.
- Throws:
org.apache.commons.httpclient.URIException
-
setClient
Set the client for this resource.- Throws:
IOException
-
setClient
Set the client for this resource and the given http URL.- Parameters:
httpURL
- The http URL.- Throws:
IOException
-
setHttpURL
public void setHttpURL(org.apache.commons.httpclient.HttpURL httpURL, int action, int depth) throws org.apache.commons.httpclient.HttpException, IOException Set the HttpURL for this WebdavResource.- Parameters:
httpURL
- the specified HttpURL.action
- The action to decide, which properties to find.depth
- The depth to find properties.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
setHttpURL
public void setHttpURL(org.apache.commons.httpclient.HttpURL httpURL, int depth) throws org.apache.commons.httpclient.HttpException, IOException Set the HttpURL for this WebdavResource.- Parameters:
httpURL
- the specified HttpURL.depth
- The depth to find properties.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
setHttpURL
public void setHttpURL(org.apache.commons.httpclient.HttpURL httpURL, String additionalPath, int action, int depth) throws org.apache.commons.httpclient.HttpException, IOException Set the HttpURL for this WebdavResource. It must be put an escaped path part of the http URL as an argument.- Parameters:
httpURL
- The specified HttpURL.additionalPath
- The added relative path.action
- The action to decide, which properties to find.depth
- The depth.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
setHttpURL
public void setHttpURL(org.apache.commons.httpclient.HttpURL httpURL, String additionalPath, int action) throws org.apache.commons.httpclient.HttpException, IOException Set the HttpURL for this WebdavResource. It must be put an escaped path part of the http URL as an argument.- Parameters:
httpURL
- The specified HttpURL.additionalPath
- The added relative path.action
- The action to decide, which properties to find.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
setHttpURL
public void setHttpURL(org.apache.commons.httpclient.HttpURL httpURL, String additionalPath) throws org.apache.commons.httpclient.HttpException, IOException Set the HttpURL for this WebdavResource.- Parameters:
httpURL
- The specified HttpURL.additionalPath
- The added relative path.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
setHttpURL
public void setHttpURL(org.apache.commons.httpclient.HttpURL httpURL) throws org.apache.commons.httpclient.HttpException, IOException Set the HttpURL for this WebdavResource.- Parameters:
httpURL
- the specified HttpURL.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
setHttpURL
public void setHttpURL(String escapedHttpURL) throws org.apache.commons.httpclient.HttpException, IOException Set the HttpURL of this WebdavResource. It must be put an escaped http URL as an argument.- Parameters:
escapedHttpURL
- The escaped http URL string.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
getHttpURL
public org.apache.commons.httpclient.HttpURL getHttpURL()Get the HttpURL of this WebdavResource.- Returns:
- httpURL the http URL.
-
getHttpURLExceptForUserInfo
public org.apache.commons.httpclient.HttpURL getHttpURLExceptForUserInfo() throws org.apache.commons.httpclient.URIExceptionGet the HttpURL except for userinfo.- Returns:
- httpURL the http URL.
- Throws:
org.apache.commons.httpclient.URIException
-
setPath
Set the path part of this WebdavResource.- Parameters:
path
- the specified path.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
getPath
Get the path part of this WebdavResource. If the decoding of the path fails, this method will not throw an exception but return the escaped path instead.- Returns:
- the path for this WebdavResource.
- See Also:
-
getName
Get the name of this WebdavResource. If the decoding of the name fails, this method will not throw an exception but return the escaped name instead.- Returns:
- the name of this WebdavResource.
- See Also:
-
getHost
Get the hostname of this WebdavResource.- Returns:
- the hostname.
- Throws:
org.apache.commons.httpclient.URIException
-
setUserInfo
public void setUserInfo(String userName, String password) throws org.apache.commons.httpclient.HttpException, IOException Set the userinfo part of this WebdavResource.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
addRequestHeader
Add a header in the request sent to the webdav server- Parameters:
header
- Header namevalue
- Value
-
getDisplayName
Get the value of DAV property, displayname.- Returns:
- The displayname string.
-
setDisplayName
Set the value of DAV property, displayname.- Parameters:
displayName
- The displayname string.
-
getGetContentLength
public long getGetContentLength()Get the value of DAV property, getcontentlength.- Returns:
- The getcontentlength value.
-
setGetContentLength
protected void setGetContentLength(long getContentLength) Set the value of DAV property, getcontentlength.- Parameters:
getContentLength
- The getcontentlength value.
-
setGetContentLength
Set the value of DAV property, getcontentlength.- Parameters:
getContentLength
- The getcontentlength value.
-
getResourceType
Get the value of DAV property, resourcetype.- Returns:
- The resourcetype property.
- See Also:
-
setResourceType
Set the value of DAV property, resourcetype.- Parameters:
resourceType
- The resourcetype property.
-
isCollection
public boolean isCollection()Get the value of DAV property, resourcetype- Returns:
- The resourcetype string.
- See Also:
-
getGetContentType
Get the value of DAV property, getcontenttype.- Returns:
- The getcontenttype string.
-
setGetContentType
Set the value of DAV property, getcontenttype.- Parameters:
getContentType
- The getcontenttype string.
-
setContentType
Set the content-type to use for this resource, for PUTs.- Parameters:
contentType
- The content-type string.
-
getGetLastModified
public long getGetLastModified()Get the value of DAV property, getlastmodified.- Returns:
- The getlastmodified value.
-
setGetLastModified
protected void setGetLastModified(long getLastModified) Set the value of DAV property, getlastmodified.- Parameters:
getLastModified
- The getlastmodified value.- See Also:
-
setGetLastModified
Set the value of DAV property, getlastmodified.- Parameters:
getLastModified
- The getlastmodified value.- See Also:
-
getCreationDate
public long getCreationDate()Get the value of DAV property, creationdate.- Returns:
- The creationdate string.
-
setCreationDate
protected void setCreationDate(long creationDate) Set the value of DAV property, creationdate.- Parameters:
creationDate
- The creationdate string.
-
setCreationDate
Set the value of DAV property, creationdate.- Parameters:
creationDate
- The creationdate string.
-
getGetEtag
Get the value of DAV property, getetag.- Returns:
- The getetag string.
-
setGetEtag
Set the value of DAV property, getetag.- Parameters:
getEtag
- The getetag string.
-
getOwner
Get the owner string, as used for locking purposes. -
getSupportedLock
Get the value of DAV property, supportedlock.- Returns:
- The supportedlock string.
-
setSupportedLock
Set the value of DAV property, supportedlock.- Parameters:
supportedLock
- The supportedlock string.
-
getLockDiscovery
Get the value of DAV property, lockdiscovery.- Returns:
- The lockdiscovery property.
-
setLockDiscovery
Set the value of DAV property, lockdiscovery.- Parameters:
lockDiscovery
- The lockdiscovery property.
-
getActiveLockOwners
Get the activelock owners for this resource.- Returns:
- An enumeration of owners.
-
isLocked
public boolean isLocked()Test that this resource is locked.- Returns:
- true if it's locked.
-
getIsHidden
public boolean getIsHidden()Get the value of DAV property, ishidden.- Returns:
- true if it is hidden, otherwise false.
-
setIsHidden
protected void setIsHidden(boolean isHidden) Set the value of DAV property, ishidden.- Parameters:
isHidden
-
-
setIsHidden
Set the value of DAV property, ishidden.- Parameters:
isHidden
-
-
getIsCollection
public boolean getIsCollection()Get the value of DAV property, iscollection- Returns:
- true if it is collection, otherwise false.
- See Also:
-
setIsCollection
protected void setIsCollection(boolean isCollection) Set the value of DAV property, iscollection- Parameters:
isCollection
-
-
setIsCollection
Set the value of DAV property, iscollection- Parameters:
isCollection
-
-
setProperties
public void setProperties(int action, int depth) throws org.apache.commons.httpclient.HttpException, IOException Set the properties for this resource.- Parameters:
action
- The action to find properties for this resource.depth
- the depth to which properties shall be found- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
setProperties
public void setProperties(int depth) throws org.apache.commons.httpclient.HttpException, IOException Set the properties for this resource.- Parameters:
depth
- the depth to which properties shall be found- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
refresh
Refresh the properties of this resource without changing the status of the previous command- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
exists
public boolean exists()Returns the last known information about the existence of this resource. This is a wrapper method for getExistence. A previous call to the method setProperties might be necessary to update that information.- Returns:
- true if the resource is known to exist
false if the resource is known not to exist or its status is unknown. - See Also:
-
setExistence
protected void setExistence(boolean exists) Set its existence.- Parameters:
exists
- The boolean value to be set for its existence.
-
getExistence
public boolean getExistence()Returns the last known information about the existence of this resource. A previous call to the method setProperties might be necessary to update that information.- Returns:
- true if the resource is known to exist
false if the resource is known not to exist or its status is unknown. - See Also:
-
setOverwrite
public void setOverwrite(boolean overwrite) Set the overwrite flag for COPY, MOVE, BIND and REBIND. Should be set before the method is executed.- Parameters:
overwrite
- the overwrite flag- See Also:
-
getOverwrite
public boolean getOverwrite()Get the current value of the overwrite flag for COPY, MOVE, BIND and REBIND.- Returns:
- true if the current flag is overwriting.
- See Also:
-
close
Close the session of this client- Throws:
IOException
-
getStatusMessage
Get the lastest value of the status message by HTTP methods.- Returns:
- The http status string.
-
getStatusCode
public int getStatusCode()Get the lastest value of the status code by HTTP methods.- Returns:
- The http status code.
-
setStatusCode
protected void setStatusCode(int statusCode) Set the lastest value of the status code by HTTP methods.- Parameters:
statusCode
- the HTTP status code.
-
setStatusCode
Set the lastest value of the status code by HTTP methods.- Parameters:
statusCode
- the HTTP status code.message
- the additional message.
-
getAllowedMethods
Get the allowed methods, checked by HTTP OPTIONS.- Returns:
- the allowed HTTP methods.
- See Also:
-
getDavCapabilities
Get the WebDAV capabilities, checked by HTTP OPTIONS.- Returns:
- the WebDAV capabilities.
- See Also:
-
getChildResources
public WebdavResources getChildResources() throws org.apache.commons.httpclient.HttpException, IOExceptionGet all resources in this collection with the depth 1.- Returns:
- resources in this collection with the depth 1.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
listWebdavResources
public WebdavResource[] listWebdavResources() throws org.apache.commons.httpclient.HttpException, IOExceptionGet an array of resources denoting the WebDAV child resources in the collection of this resources.- Returns:
- An array of child resources in this resource.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
list
Get an array of pathnames denoting the WebDAV resources in the collection denoted by this pathname.- Returns:
- An array of pathnames denoting the resources, null if an IOException occurs.
-
listBasic
Get an array of pathnames and basic information denoting the WebDAV resources in the denoted by this pathname. array 0: displayname array 1: getcontentlength array 2: iscollection or getcontentype array 3: getlastmodifieddate array 4: name- Returns:
- An array of pathnames and more denoting the resources.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
setEncodeURLs
public void setEncodeURLs(boolean encodeURLs) Deprecated.No longer has any effect.Set the URL encoding flag for this http URL.- Parameters:
encodeURLs
- true if it is encoded.
-
retrieveSessionInstance
Retrieve the current http client for this resource.- Returns:
- The http client.
- Throws:
IOException
- See Also:
-
executeHttpRequestMethod
public int executeHttpRequestMethod(org.apache.commons.httpclient.HttpClient client, org.apache.commons.httpclient.HttpMethod method) throws IOException, org.apache.commons.httpclient.HttpException Execute the http request method. And get its status code.- Parameters:
client
- The http client.method
- The http method.- Returns:
- The status code.
- Throws:
IOException
org.apache.commons.httpclient.HttpException
- See Also:
-
aclMethod
public boolean aclMethod(String path, Ace[] aces) throws org.apache.commons.httpclient.HttpException, IOException Updates the resource with a new set of aces.- Parameters:
path
- the server relative path of the resource to which the given ACEs shall be appliedaces
- the ACEs to apply- Returns:
- true if the method succeeded
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
aclfindMethod
Return theAclProperty
for the current resource- Returns:
- acl property, null if the server doesn't respond with
AclProperty
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
aclfindMethod
public AclProperty aclfindMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Return theAclProperty
for the resource at the given path- Parameters:
path
- the server relative path of the resource to request- Returns:
- acl property, null if the server doesn't respond with
AclProperty
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
principalCollectionSetFindMethod
public PrincipalCollectionSetProperty principalCollectionSetFindMethod() throws org.apache.commons.httpclient.HttpException, IOExceptionGet thePrincipalCollectionSetProperty
for the current resource.- Returns:
- principal collection set Property, null if the server doesn't
respond with a
PrincipalCollectionSetProperty
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
principalCollectionSetFindMethod
public PrincipalCollectionSetProperty principalCollectionSetFindMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Get thePrincipalCollectionSetProperty
for the resource.- Parameters:
path
- the server relative path of the resource to request- Returns:
- principal collection set Property, null if the server doesn't
respond with a
PrincipalCollectionSetProperty
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
lockDiscoveryPropertyFindMethod
public LockDiscoveryProperty lockDiscoveryPropertyFindMethod() throws org.apache.commons.httpclient.HttpException, IOExceptionReturn the LockDiscoveryProperty for the current resource- Returns:
- null if the server doesn't respond with a LockDiscoveryProperty
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
lockDiscoveryPropertyFindMethod
public LockDiscoveryProperty lockDiscoveryPropertyFindMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Return the LockDiscoveryProperty for the resource at the given path- Parameters:
path
- the server relative path of the resource to request- Returns:
- null if the server doesn't respond with a LockDiscoveryProperty
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
getMethodData
Get InputStream for the GET method.- Returns:
- InputStream
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
getMethodData
public InputStream getMethodData(String path) throws org.apache.commons.httpclient.HttpException, IOException Get InputStream for the GET method for the given path.- Parameters:
path
- the server relative path of the resource to get- Returns:
- InputStream
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
getMethodDataAsString
public String getMethodDataAsString() throws org.apache.commons.httpclient.HttpException, IOExceptionGet data as a String for the GET method.- Returns:
- the contents of this resource as a string
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
getMethodDataAsString
public String getMethodDataAsString(String path) throws org.apache.commons.httpclient.HttpException, IOException Get data as a String for the GET method for the given path.- Parameters:
path
- the server relative path of the resource to get- Returns:
- the contents of the given resource as a string
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
getMethod
Execute the GET method for this WebdavResource path.- Parameters:
file
- The local file.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
getMethod
public boolean getMethod(String path, File file) throws org.apache.commons.httpclient.HttpException, IOException Execute the GET method for the given path.- Parameters:
path
- the server relative path of the resource to getfile
- The local file.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
putMethod
public boolean putMethod(byte[] data) throws org.apache.commons.httpclient.HttpException, IOException Execute the PUT method for this resource.- Parameters:
data
- The byte array.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
putMethod
public boolean putMethod(String path, byte[] data) throws org.apache.commons.httpclient.HttpException, IOException Execute the PUT method for the given path.- Parameters:
path
- the server relative path to put the datadata
- The byte array.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
putMethod
public boolean putMethod(InputStream is) throws org.apache.commons.httpclient.HttpException, IOException Execute the PUT method for this resource.- Parameters:
is
- The input stream.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
putMethod
public boolean putMethod(String path, InputStream is) throws org.apache.commons.httpclient.HttpException, IOException Execute the PUT method for the given path.- Parameters:
path
- the server relative path to put the datais
- The input stream.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
putMethod
public boolean putMethod(String data) throws org.apache.commons.httpclient.HttpException, IOException Execute the PUT method for this WebdavResource.- Parameters:
data
- String data to send.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
putMethod
public boolean putMethod(String path, String data) throws org.apache.commons.httpclient.HttpException, IOException Execute the PUT method for the given path.- Parameters:
path
- the server relative path to put the datadata
- String to send.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
putMethod
Execute the PUT method for this WebdavResource.- Parameters:
file
- the filename to get on local.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
putMethod
public boolean putMethod(String path, File file) throws org.apache.commons.httpclient.HttpException, IOException Execute the PUT method for the given path.- Parameters:
path
- the server relative path to put the given filefile
- the filename to get on local.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
putMethod
Execute the PUT method for this resource from the given url. It's like a streaming copy about a resource of the specified remote url to another remote url of this resource.- Parameters:
url
- The URL to get a resource.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
putMethod
public boolean putMethod(String path, URL url) throws org.apache.commons.httpclient.HttpException, IOException Execute the PUT method for the given path from the given url.- Parameters:
path
- the server relative path to put the dataurl
- The URL to get a resource.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
optionsMethod
Execute OPTIONS method for this WebdavResource.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
optionsMethod
public boolean optionsMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Execute OPTIONS method for the given path.- Parameters:
path
- the server relative path of the resource to request- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
optionsMethod
public boolean optionsMethod(String path, String aMethod) throws org.apache.commons.httpclient.HttpException, IOException Execute OPTIONS method for the given path.- Parameters:
path
- the server relative path to send the requestaMethod
- a method to check it's supported.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
optionsMethod
public Enumeration optionsMethod(org.apache.commons.httpclient.HttpURL httpURL) throws org.apache.commons.httpclient.HttpException, IOException Execute OPTIONS method for the given http URL.- Parameters:
httpURL
- the http URL.- Returns:
- the allowed methods and capabilities.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
optionsMethod
public Enumeration optionsMethod(org.apache.commons.httpclient.HttpURL httpURL, int type) throws org.apache.commons.httpclient.HttpException, IOException Execute OPTIONS method for the given http URL, DELTAV- Parameters:
httpURL
- the http URL.- Returns:
- the allowed methods and capabilities.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
optionsMethod
public Enumeration optionsMethod(String path, int type) throws org.apache.commons.httpclient.HttpException, IOException Execute OPTIONS method for the given path.- Parameters:
path
- the server relative path of the resource to request- Returns:
- the allowed methods and capabilities.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
labelMethod
public boolean labelMethod(String labelname, int type) throws org.apache.commons.httpclient.HttpException, IOException Execute a LABEL method on the current path, setting the given label- Parameters:
labelname
- the label to settype
- the type of action. One of:- LABEL_ADD
- LABEL_REMOVE
- LABEL_SET
- Returns:
- true if the method succeeded
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
labelMethod
public boolean labelMethod(String path, String labelname, int type) throws org.apache.commons.httpclient.HttpException, IOException Execute a LABEL method on the given path, setting the given label- Parameters:
path
- the server relative path of the resource to act onlabelname
- the label to settype
- the type of action. One of:- LABEL_ADD
- LABEL_REMOVE
- LABEL_SET
- Returns:
- true if the method succeeded
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
reportMethod
public Enumeration reportMethod(org.apache.commons.httpclient.HttpURL httpURL, int depth) throws org.apache.commons.httpclient.HttpException, IOException Execute the REPORT method.- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
reportMethod
public Enumeration reportMethod(org.apache.commons.httpclient.HttpURL httpURL, Vector properties) throws org.apache.commons.httpclient.HttpException, IOException - Throws:
org.apache.commons.httpclient.HttpException
IOException
-
reportMethod
public Enumeration reportMethod(org.apache.commons.httpclient.HttpURL httpURL, Vector properties, int depth) throws org.apache.commons.httpclient.HttpException, IOException - Throws:
org.apache.commons.httpclient.HttpException
IOException
-
reportMethod
public Enumeration reportMethod(org.apache.commons.httpclient.HttpURL httpURL, Vector properties, Vector histUri, int depth) throws org.apache.commons.httpclient.HttpException, IOException - Throws:
org.apache.commons.httpclient.HttpException
IOException
-
reportMethod
public Enumeration reportMethod(org.apache.commons.httpclient.HttpURL httpURL, String sQuery, int depth) throws org.apache.commons.httpclient.HttpException, IOException - Throws:
org.apache.commons.httpclient.HttpException
IOException
-
propfindMethod
public Enumeration propfindMethod(int depth) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPFIND method with allprop for this WebdavResource. Get list of all WebDAV properties on this WebDAV resource.Once used this method, the the status code in the 207 reponse is need to be set for the method of WebdavResource.
The values of DepthSupport.DEPTH_0, DepthSupport.DEPTH_1, DepthSupport.DEPTH_INFINITY is possbile for the depth.
- Parameters:
depth
-- Returns:
- an enumeration of
ResponseEntity
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
propfindMethod
public Enumeration propfindMethod(String path, int depth) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPFIND method with allprop for the given path. Get list of all WebDAV properties on the given resource.Once used this method, the the status code in the 207 reponse is need to be set for the method of WebdavResource.
The values of DepthSupport.DEPTH_0, DepthSupport.DEPTH_1, DepthSupport.DEPTH_INFINITY is possbile for the depth.
- Parameters:
path
- the server relative path of the resource to requestdepth
-- Returns:
- an enumeration of
ResponseEntity
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
propfindMethod
public Enumeration propfindMethod(int depth, Vector properties) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPFIND method with by propname for this resource. Get list of named WebDAV properties on this resource.Once used this method, the the status code in the 207 reponse is need to be set for the method of WebdavResource.
The values of DepthSupport.DEPTH_0, DepthSupport.DEPTH_1 DepthSupport.DEPTH_INFINITY is possbile for the depth.
- Parameters:
depth
- The depth.properties
- The named properties.- Returns:
- an enumeration of
ResponseEntity
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
propfindMethod
public Enumeration propfindMethod(String path, int depth, Vector properties) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPFIND method with by propname for the given path. Get list of named WebDAV properties on the given resource.Once used this method, the the status code in the 207 reponse is need to be set for the method of WebdavResource.
The values of DepthSupport.DEPTH_0, DepthSupport.DEPTH_1 DepthSupport.DEPTH_INFINITY is possbile for the depth.
- Parameters:
path
- the server relative path of the resource to requestdepth
- The depth.properties
- The named properties.- Returns:
- an enumeration of
ResponseEntity
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
propfindMethod
public Enumeration propfindMethod(String propertyName) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPFIND method for this WebdavResource. Get list of given WebDAV properties on this WebDAV resource.- Parameters:
propertyName
- the WebDAV property to find.- Returns:
- Enumeration list of WebDAV properties on a resource.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
propfindMethod
public Enumeration propfindMethod(String path, String propertyName) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPFIND method for the given WebdavResource path. Get list of given WebDAV properties on this WebDAV resource.- Parameters:
path
- the server relative path of the resource to requestpropertyName
- the WebDAV property to find.- Returns:
- Enumeration list of WebDAV properties on a resource.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
propfindMethod
public Enumeration propfindMethod(Vector properties) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPFIND method for this WebdavResource. Get list of given WebDAV properties on this WebDAV resource.- Parameters:
properties
- the WebDAV properties to find.- Returns:
- Enumeration list of WebDAV properties on a resource.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
propfindMethod
public Enumeration propfindMethod(String path, Vector properties) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPFIND method for the given path and properties. Get list of given WebDAV properties on the given resource.- Parameters:
path
- the server relative path of the resource to requestproperties
- the WebDAV properties to find.- Returns:
- Enumeration list of WebDAV properties on a resource.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
proppatchMethod
public boolean proppatchMethod(String propertyName, String propertyValue) throws org.apache.commons.httpclient.HttpException, IOException Deprecated.it could be removed after the major version changesExecute PROPATCH method for this WebdavResource.- Parameters:
propertyName
- the name of the property to setpropertyValue
- the value of the property to set- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
proppatchMethod
public boolean proppatchMethod(String propertyName, String propertyValue, boolean action) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPATCH method for this resource with the given property.- Parameters:
propertyName
- the property name string (in "DAV:" namespace)propertyValue
- the property value string If the proppatch action is being removed, the value is null or any.action
- true if it's being set, false if it's being removed- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
proppatchMethod
public boolean proppatchMethod(PropertyName propertyName, String propertyValue) throws org.apache.commons.httpclient.HttpException, IOException Deprecated.it could be removed after the major version changesExecute PROPATCH method for this WebdavResource.- Parameters:
propertyName
- the name of the property to setpropertyValue
- the value of the property to set- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
proppatchMethod
public boolean proppatchMethod(PropertyName propertyName, String propertyValue, boolean action) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPATCH method for this resource with the given property.- Parameters:
propertyName
- the name of the property to setpropertyValue
- the value of the property to set If the proppatch action is being removed, the value is null or any.action
- true if it's being set, false if it's being removed- Returns:
- true if the method is succeeded
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
proppatchMethod
public boolean proppatchMethod(String path, String propertyName, String propertyValue) throws org.apache.commons.httpclient.HttpException, IOException Deprecated.it could be removed after the major version changesExecute PROPATCH method for the given WebdavResource.- Parameters:
path
- the server relative path of the resource to act onpropertyName
- the property name in "DAV:" namespacepropertyValue
- the property value string- Returns:
- true if the method is succeeded
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
proppatchMethod
public boolean proppatchMethod(String path, String propertyName, String propertyValue, boolean action) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPATCH method for the specified resource with the given property.- Parameters:
path
- the server relative path of the resource to act onpropertyName
- the property name string (in "DAV:" namespace)propertyValue
- the property value string If the proppatch action is being removed, the value is null or any.action
- true if it's to be set, false if it's to be removed- Returns:
- true if the method is succeeded
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
proppatchMethod
public boolean proppatchMethod(String path, PropertyName propertyName, String propertyValue) throws org.apache.commons.httpclient.HttpException, IOException Deprecated.it could be removed after the major version changesExecute PROPATCH method for the given WebdavResource.- Parameters:
path
- the server relative path of the resource to act onpropertyName
- the property name.propertyValue
- the property value.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
proppatchMethod
public boolean proppatchMethod(String path, PropertyName propertyName, String propertyValue, boolean action) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPATCH method for the given resource with the given properties.- Parameters:
path
- the server relative path of the resource to act onpropertyName
- the property namepropertyValue
- the property value string If the proppatch action is being removed, the value is null or any.action
- true if it's to be set, false if it's to be removed- Returns:
- true if the method is succeeded
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
proppatchMethod
public boolean proppatchMethod(Hashtable properties) throws org.apache.commons.httpclient.HttpException, IOException Deprecated.it could be removed after the major version changesExecute PROPATCH method for this WebdavResource.- Parameters:
properties
- name and value pairs to set (name can be a String or PropertyName)- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
proppatchMethod
public boolean proppatchMethod(Hashtable properties, boolean action) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPATCH method for this resource with the given properties.- Parameters:
properties
- the name(=String
orPropertyName
and value(=String
) pairs for proppatch action If the proppatch action is being removed, the value is null or any.action
- true if it's being set, false if it's being removed- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
proppatchMethod
public boolean proppatchMethod(String path, Hashtable properties) throws org.apache.commons.httpclient.HttpException, IOException Deprecated.it could be removed after the major version changesExecute PROPATCH method for the given WebdavResource.- Parameters:
path
- the server relative path of the resource to act onproperties
- name and value pairs to set (name can be a String or PropertyName)- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
proppatchMethod
public boolean proppatchMethod(String path, Hashtable properties, boolean action) throws org.apache.commons.httpclient.HttpException, IOException Execute PROPATCH method for the specified resource with the given properties.- Parameters:
path
- the server relative path of the resource to act onproperties
- the name(=String
orPropertyName
and value(=String
) pairs for proppatch action If the proppatch action is being removed, the value is null or any.action
- true if it's being set, false if it's being removed- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
headMethod
Execute the HEAD method for this WebdavResource.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
headMethod
public boolean headMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Execute the HEAD method for the given path.- Parameters:
path
- the server relative path of the resource to request- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
deleteMethod
Execute the DELETE method for this WebdavResource.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
deleteMethod
public boolean deleteMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Execute the DELETE method for the given path.- Parameters:
path
- the server relative path of the resource to delete- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
moveMethod
public boolean moveMethod(String destination) throws org.apache.commons.httpclient.HttpException, IOException Execute the MOVE method for this WebdavReource.- Parameters:
destination
- the destination to move to as a server relative path- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
moveMethod
public boolean moveMethod(String source, String destination) throws org.apache.commons.httpclient.HttpException, IOException Execute the MOVE method for the given source and destination.- Parameters:
source
- the source resource as a server relativ pathdestination
- the destination to move to as a server relative path- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
copyMethod
public boolean copyMethod(String destination) throws org.apache.commons.httpclient.HttpException, IOException Execute the COPY method for the given destination path.- Parameters:
destination
- the destination as a server relative path- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
copyMethod
public boolean copyMethod(String source, String destination) throws org.apache.commons.httpclient.HttpException, IOException Execute the COPY method the given source and destination.- Parameters:
source
- the source resource as a server relative pathdestination
- the destination as a server relative path- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
mkcolMethod
Execute the MKCOL method for this WebdavResource.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
mkcolMethod
public boolean mkcolMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Execute the MKCOL method for the given path.- Parameters:
path
- the server relative path at which to create a new collection resource- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
lockMethod
Execute the LOCK method for this WebdavResource. This method tries to acquire an exclusive write lock with a timeout of 120 seconds.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
lockMethod
public boolean lockMethod(String owner, int timeout) throws org.apache.commons.httpclient.HttpException, IOException Execute the LOCK method for this WebdavResource. This method tries to acquire an exclusive write lock with the given timeout value.- Parameters:
owner
- the owner string.timeout
- the timeout- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
lockMethod
public boolean lockMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Execute the LOCK method for the given path. This method tries to acquire an exclusive write lock with a timeout of 120 seconds.- Parameters:
path
- the server relative path of the resource to lock- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
lockMethod
public boolean lockMethod(String path, String owner, int timeout) throws org.apache.commons.httpclient.HttpException, IOException Execute the LOCK method for the given path. This method tries to acquire an exclusive write lock with the given timeout value.- Parameters:
path
- the server relative path of the resource to lockowner
- The owner string.timeout
- the timeout value.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
lockMethod
public boolean lockMethod(String path, String owner, int timeout, short lockType) throws org.apache.commons.httpclient.HttpException, IOException Execute the LOCK method for the given path. This method tries to acquire an exclusive write lock with the given timeout value.- Parameters:
path
- the server relative path of the resource to lockowner
- The owner string.timeout
- the timeout value.locktype
- , the scope of lock.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
lockMethod
public boolean lockMethod(String path, String owner, int timeout, short lockType, int depth) throws org.apache.commons.httpclient.HttpException, IOException Execute the LOCK method for the given path. This method tries to acquire an exclusive write lock with the given timeout value.- Parameters:
path
- the server relative path of the resource to lockowner
- The owner string.timeout
- the timeout value.locktype
- , the scope of lock.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
lockMethod
public boolean lockMethod(String owner, short timeout) throws org.apache.commons.httpclient.HttpException, IOException Deprecated.The timeout value MUST NOT be greater than 2^32-1.Execute the LOCK method for this WebdavResource.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
lockMethod
public boolean lockMethod(String path, String owner, short timeout) throws org.apache.commons.httpclient.HttpException, IOException Deprecated.The timeout value MUST NOT be greater than 2^32-1.Execute the LOCK method for the given path.- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
startTransaction
Begins a new transaction. The transaction handle returned by the WebDAV server will be remembered and included as a header of subsequent requests until eithercommitTransaction()
orabortTransaction()
are called. You can retrieve it usinggetTransactionHandle()
.- Parameters:
owner
- the owner of this transactiontimeout
- timeout in milleseconds- Returns:
true
if the transaction has been successfully started,false
otherwise- Throws:
IOException
- if anything goes wrong- See Also:
-
getTransactionHandle
Returns the transaction handle set bystartTransaction(String, int)
.- Returns:
- the current transaction handle or
null
if the client does not operate inside a transaction - Throws:
IOException
- if anything goes wrong- See Also:
-
commitTransaction
Commits the transaction started bystartTransaction(String, int)
and resets the transaction handle.- Returns:
true
if the transaction has been successfully committed,false
otherwise- Throws:
IOException
- if anything goes wrong- See Also:
-
abortTransaction
Aborts - i.e. rolls back all changes of - the transaction started bystartTransaction(String, int)
and resets the transaction handle.- Returns:
true
if the transaction has been successfully committed,false
otherwise- Throws:
IOException
- if anything goes wrong- See Also:
-
endTransaction
- Throws:
IOException
-
unlockMethod
Execute the Unlock method for this WebdavResource.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
unlockMethod
public boolean unlockMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Execute the Unlock method for the given path.- Parameters:
path
- the server relative path of the resource to unlock- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
unlockMethod
public boolean unlockMethod(String path, String owner) throws org.apache.commons.httpclient.HttpException, IOException Execute the Unlock method for the given path.- Parameters:
path
- the server relative path of the resource to unlock- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
discoverOwnLocks
Discover and refresh lock tokens.- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
discoverOwnLocks
public void discoverOwnLocks(String owner) throws org.apache.commons.httpclient.HttpException, IOException Discover and refresh lock tokens for a specific owner.- Parameters:
owner
- the owner who's locks are to be discovered.- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
discoverLock
Discover the given owner and locktoken and set the locktoken- Parameters:
owner
- the activelock ownerpath
- the server relative path of the resource to requeststate
- the state to save the locktoken- Returns:
- state probably having lock information renewly
-
updateMethod
public boolean updateMethod(String target) throws org.apache.commons.httpclient.HttpException, IOException Update this resource to the specified target- Parameters:
target
- the path of the history element to update this resource from- Returns:
- true if the method has succeeded
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
updateMethod
public boolean updateMethod(String path, String target) throws org.apache.commons.httpclient.HttpException, IOException Update the specified resource to the specified target- Parameters:
path
- the server relative path of the resource to updatetarget
- path of the target to update from (history resource)- Returns:
- true if the method has succeeded
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
versionControlMethod
public boolean versionControlMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException - Throws:
org.apache.commons.httpclient.HttpException
IOException
-
versionControlMethod
public boolean versionControlMethod(String path, String target) throws org.apache.commons.httpclient.HttpException, IOException - Throws:
org.apache.commons.httpclient.HttpException
IOException
-
mkWorkspaceMethod
Execute the MKWORKSPACE method for this WebdavResource.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
mkWorkspaceMethod
public boolean mkWorkspaceMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Execute the MKCOL method for the given path.- Parameters:
path
- the server relative path at which to create a new workspace resource- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
compareToWebdavResource
Compare to the WebdavResource object.- Parameters:
another
- the other WebdavResource object- Returns:
- the value 0 if the argument is equal.
-
compareTo
Compare to the given another object.- Parameters:
another
- the other WebdavResource object- Returns:
- the value 0 if another is equal.
-
equals
Test the object. -
toString
Return the http URL string. -
checkinMethod
Execute the CHECKIN method for this WebdavResource.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
checkinMethod
public boolean checkinMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Execute the CHECKIN method for the given path.- Parameters:
path
- the server relative path of the resource to check in- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
checkoutMethod
Execute the CHECKOUT method for this WebdavResource.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
checkoutMethod
public boolean checkoutMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Execute the CHECKOUT method for the given path.- Parameters:
path
- the server relative path of the resource to check out- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
uncheckoutMethod
Execute the CHECKOUT method for this WebdavResource.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
uncheckoutMethod
public boolean uncheckoutMethod(String path) throws org.apache.commons.httpclient.HttpException, IOException Execute the CHECKOUT method for the given path.- Parameters:
path
- the server relative path of the resource to act on- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
createWebdavResource
Create a new WebdavResource object (as a seperate method so that it can be overridden by subclasses.- Parameters:
client
- HttpClient to be used by this webdavresource.- Returns:
- A new WebdavResource object.
-
processProperty
Process a property, setting various member variables depending on what the property is.- Parameters:
property
- The property to process.
-
aclReportMethod
public Enumeration aclReportMethod(String path, Collection properties, int reportType) throws org.apache.commons.httpclient.HttpException, IOException Execute REPORT method. This method is for the special Access Control Reports: - acl-principal-prop-set (not supported yet) - principal-match (not supported yet) - principal-property-search - principal-search-property-set (not supported yet)- Parameters:
path
- the server relative path of the resource to requestproperties
- The named properties.- Returns:
- an enumeration of
ResponseEntity
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
bindMethod
public boolean bindMethod(String newBinding) throws org.apache.commons.httpclient.HttpException, IOException Execute the BIND method for this WebdavResource, given an existing path to bind with.- Parameters:
newBinding
- the new binding as a server relative path- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
bindMethod
public boolean bindMethod(String existingBinding, String newBinding) throws org.apache.commons.httpclient.HttpException, IOException Execute the BIND method given the new path to bind to an existing path.- Parameters:
existingBinding
- the existing binding as a server relative pathnewBinding
- the new binding as a server relative path- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
unbindMethod
Execute the UNBIND method for this WebdavResource.- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
unbindMethod
public boolean unbindMethod(String binding) throws org.apache.commons.httpclient.HttpException, IOException Execute the UNBIND method given the resource to Unbind.- Parameters:
binding
- the server relative path of the resource to unbind- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
rebindMethod
public boolean rebindMethod(String newBinding) throws org.apache.commons.httpclient.HttpException, IOException Execute the Rebind method for this WebdavResource given the new Resource to bind with. The REBIND method removes a binding to a resource from one collection, and adds a binding to that resource into another collection. It is effectively an atomic form of a MOVE request.- Parameters:
newBinding
- the new binding as a server relative path- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
rebindMethod
public boolean rebindMethod(String existingBinding, String newBinding) throws org.apache.commons.httpclient.HttpException, IOException Execute the Rebind method given a resource to rebind and the new Resource to bind with. The REBIND method removes a binding to a resource from one collection, and adds a binding to that resource into another collection. It is effectively an atomic form of a MOVE request- Parameters:
existingBinding
- the existing binding as a server relative pathnewBinding
- the new binding as a server relative path- Returns:
- true if the method is succeeded.
- Throws:
org.apache.commons.httpclient.HttpException
IOException
- See Also:
-
subscribeMethod
public Subscription subscribeMethod(String path, String notificationType, String callback, long notificationDelay, int depth, long lifetime) throws org.apache.commons.httpclient.HttpException, IOException Subscribes for notifications for modifications of WebDAV resources.- Parameters:
path
- URL path of the resource that is to be subscribednotificationType
-callback
- the URL to be registered for notification, may benull
if no callback shall be registered.notificationDelay
-depth
- the depth of the subscription (for valid values seeDepthSupport
)lifetime
- duration of that subscription in seconds (Note: the server may change this and return an other one; seeSubscription.getLifetime()
.- Returns:
- a
Subscription
ornull
if an error occurs - Throws:
org.apache.commons.httpclient.HttpException
IOException
-
subscribeMethod
public boolean subscribeMethod(String path, int subscriptionId) throws org.apache.commons.httpclient.HttpException, IOException Refreshes a subscription.- Returns:
true
on success.- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
subscribeMethod
public boolean subscribeMethod(Subscription subscription) throws org.apache.commons.httpclient.HttpException, IOException Refreshes a subscription.- Parameters:
subscription
- The subscription to be refreshed.- Returns:
true
on success- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
unsubscribeMethod
public boolean unsubscribeMethod(String path, int subscriptionId) throws org.apache.commons.httpclient.HttpException, IOException Cancels a subscription.- Parameters:
path
- URL path for that was subscribed- Returns:
true
on success- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
unsubscribeMethod
public boolean unsubscribeMethod(Subscription subscription) throws org.apache.commons.httpclient.HttpException, IOException Cancels a subscription.- Parameters:
subscription
-- Returns:
true
on success- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
pollMethod
public boolean pollMethod(String contentLocation, int subscriptionId) throws org.apache.commons.httpclient.HttpException, IOException Asks the server whether events for a given subscription are fired.- Parameters:
contentLocation
- URL path returned by the SUBSCRIBE methods Content-Location headersubscriptionId
- id of the subscription- Returns:
true
if an event was fired- Throws:
org.apache.commons.httpclient.HttpException
IOException
-
pollMethod
public boolean pollMethod(Subscription subscription) throws org.apache.commons.httpclient.HttpException, IOException Asks the server whether events for a given subscription are fired.- Parameters:
subscription
- the subscription to ask for- Returns:
true
if an event was fired- Throws:
org.apache.commons.httpclient.HttpException
IOException
-