|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.webdav.lib.WebdavSession
org.apache.webdav.lib.WebdavResource
public class WebdavResource
The class 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 | |
---|---|
static int |
ALL
The action setting the all properties for this resource. |
protected java.util.Enumeration |
allowedMethods
The allowed HTTP methods. |
static int |
BASIC
The action setting the basic properties for this resource. |
protected WebdavResources |
childResources
Table of the hrefs gotten in a collection. |
protected long |
creationDate
An WebDAV property, creationdate. |
static java.lang.String |
CREATIONDATE
The creationdate property. |
protected java.util.Enumeration |
davCapabilities
The capabilities of the WebDAV server. |
static int |
DEFAULT
The action setting the default DAV properties for this resource. |
protected static int |
defaultAction
The default action to find properties. |
protected static int |
defaultDepth
The default depth for WebDAV methods. |
static java.lang.String |
defaultOwner
Owner information for locking and unlocking. |
protected java.lang.String |
displayName
An WebDAV property, displayname. |
static java.lang.String |
DISPLAYNAME
The displayname property. |
protected boolean |
exists
An WebdavResource flag to check its existence; |
static java.lang.String |
FALSE
The false constant string. |
protected boolean |
followRedirects
|
static java.text.SimpleDateFormat[] |
formats
Date formats using for Date parsing. |
static java.lang.String |
GETCONTENTLANGUAGE
The getcontentlanguage property. |
protected long |
getContentLength
An WebDAV property, getcontentlength. |
static java.lang.String |
GETCONTENTLENGTH
The getcontentlength property. |
protected java.lang.String |
getContentType
An WebDAV property, getcontenttype. |
static java.lang.String |
GETCONTENTTYPE
The getcontenttype property. |
protected java.lang.String |
getEtag
An WebDAV property, getetag. |
static java.lang.String |
GETETAG
The getetag property. |
protected long |
getLastModified
An WebDAV property, getlastmodified. |
static java.lang.String |
GETLASTMODIFIED
The getlastmodifed property. |
protected static java.util.TimeZone |
gmtZone
GMT timezone. |
protected java.util.Map |
headers
Map of additional headers |
protected HttpURL |
httpURL
The HttpURL to represent a WebDAV resource. |
protected boolean |
isCollection
An WebDAV property, iscollection. |
static java.lang.String |
ISCOLLECTION
The iscollection property. |
protected boolean |
isHidden
An WebDAV property, ishidden. |
static java.lang.String |
ISHIDDEN
The ishidden property. |
static int |
LABEL_ADD
|
static int |
LABEL_REMOVE
|
static int |
LABEL_SET
|
protected int |
latestStatusCode
An status code performed by HTTP methods at the most recent. |
protected java.lang.String |
latestStatusMessage
An status message performed by HTTP methods at the most recent. |
protected LockDiscoveryProperty |
lockDiscovery
An WebDAV property, lockdiscovery. |
static java.lang.String |
LOCKDISCOVERY
The lockdiscovery property. |
static int |
NAME
The action setting only the displayname for this resource. |
static int |
NOACTION
No action to find properties for this resource. |
static int |
OPTIONS_VERSION_HISTORY
|
static int |
OPTIONS_WORKSPACE
|
protected boolean |
overwrite
An WebdavResource flag to check overwriting; |
protected java.lang.String |
owner
Owner information for locking and unlocking. |
protected ResourceTypeProperty |
resourceType
An WebDAV property, resourcetype. |
static java.lang.String |
RESOURCETYPE
The resourcetype property. |
static java.lang.String |
SOURCE
The source property. |
protected java.lang.String |
supportedLock
An WebDAV property, supportedlock. |
static java.lang.String |
SUPPORTEDLOCK
The supportedlock property. |
protected static java.lang.String |
tempDirForGet
Deprecated. The client is responsible for disk I/O. |
protected boolean |
thisResource
The flag to set the status code by propfind. |
static java.lang.String |
TRUE
The true constant string. |
protected static boolean |
useDiskForGet
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 | |
---|---|
protected |
WebdavResource()
The default constructor. |
protected |
WebdavResource(HttpClient client)
The constructor. |
|
WebdavResource(HttpURL httpURL)
The constructor. |
|
WebdavResource(HttpURL httpURL,
boolean followRedirects)
The constructor. |
|
WebdavResource(HttpURL httpURL,
Credentials credentials,
int action,
int depth)
The constructor. |
|
WebdavResource(HttpURL httpURL,
int depth)
The constructor. |
|
WebdavResource(HttpURL httpURL,
int depth,
boolean followRedirects)
The constructor. |
|
WebdavResource(HttpURL httpURL,
int action,
int depth)
The constructor. |
|
WebdavResource(HttpURL httpURL,
int action,
int depth,
boolean followRedirects)
The constructor. |
|
WebdavResource(HttpURL httpURL,
java.lang.String additionalPath)
The constructor. |
|
WebdavResource(HttpURL httpURL,
java.lang.String additionalPath,
boolean followRedirects)
The constructor. |
|
WebdavResource(HttpURL httpURL,
java.lang.String proxyHost,
int proxyPort)
The constructor. |
|
WebdavResource(HttpURL httpURL,
java.lang.String proxyHost,
int proxyPort,
boolean followRedirects)
|
|
WebdavResource(HttpURL httpURL,
java.lang.String proxyHost,
int proxyPort,
Credentials proxyCredentials)
The constructor. |
|
WebdavResource(HttpURL httpURL,
java.lang.String proxyHost,
int proxyPort,
Credentials proxyCredentials,
boolean followRedirects)
|
|
WebdavResource(java.lang.String escapedHttpURL)
The constructor. |
|
WebdavResource(java.lang.String escapedHttpURL,
boolean followRedirects)
|
|
WebdavResource(java.lang.String escapedHttpURL,
Credentials credentials)
The constructor. |
|
WebdavResource(java.lang.String escapedHttpURL,
Credentials credentials,
boolean followRedirects)
|
|
WebdavResource(java.lang.String escapedHttpURL,
java.lang.String proxyHost,
int proxyPort)
The constructor. |
|
WebdavResource(java.lang.String escapedHttpURL,
java.lang.String proxyHost,
int proxyPort,
Credentials proxyCredentials)
The constructor. |
Method Summary | |
---|---|
boolean |
abortTransaction()
Aborts - i.e. |
AclProperty |
aclfindMethod()
Return the AclProperty for the current resource |
AclProperty |
aclfindMethod(java.lang.String path)
Return the AclProperty for the resource at the given path |
boolean |
aclMethod(java.lang.String path,
Ace[] aces)
Updates the resource with a new set of aces. |
java.util.Enumeration |
aclReportMethod(java.lang.String path,
java.util.Collection properties,
int reportType)
Execute REPORT method. |
void |
addRequestHeader(java.lang.String header,
java.lang.String value)
Add a header in the request sent to the webdav server |
boolean |
bindMethod(java.lang.String newBinding)
Execute the BIND method for this WebdavResource, given an existing path to bind with. |
boolean |
bindMethod(java.lang.String existingBinding,
java.lang.String newBinding)
Execute the BIND method given the new path to bind to an existing path. |
boolean |
checkinMethod()
Execute the CHECKIN method for this WebdavResource. |
boolean |
checkinMethod(java.lang.String path)
Execute the CHECKIN method for the given path. |
boolean |
checkoutMethod()
Execute the CHECKOUT method for this WebdavResource. |
boolean |
checkoutMethod(java.lang.String path)
Execute the CHECKOUT method for the given path. |
void |
close()
Close the session of this client |
boolean |
commitTransaction()
Commits the transaction started by startTransaction(String, int) and resets the transaction handle. |
int |
compareTo(java.lang.Object another)
Compare to the given another object. |
int |
compareToWebdavResource(WebdavResource another)
Compare to the WebdavResource object. |
boolean |
copyMethod(java.lang.String destination)
Execute the COPY method for the given destination path. |
boolean |
copyMethod(java.lang.String source,
java.lang.String destination)
Execute the COPY method the given source and destination. |
protected WebdavResource |
createWebdavResource(HttpClient client)
Create a new WebdavResource object (as a seperate method so that it can be overridden by subclasses. |
boolean |
deleteMethod()
Execute the DELETE method for this WebdavResource. |
boolean |
deleteMethod(java.lang.String path)
Execute the DELETE method for the given path. |
protected WebdavState |
discoverLock(java.lang.String owner,
java.lang.String path,
WebdavState state)
Discover the given owner and locktoken and set the locktoken |
void |
discoverOwnLocks()
Discover and refresh lock tokens. |
void |
discoverOwnLocks(java.lang.String owner)
Discover and refresh lock tokens for a specific owner. |
protected boolean |
endTransaction(java.lang.String path,
int transactionStatus)
|
boolean |
equals(java.lang.Object obj)
Test the object. |
int |
executeHttpRequestMethod(HttpClient client,
HttpMethod method)
Execute the http request method. |
boolean |
exists()
Returns the last known information about the existence of this resource. |
protected void |
generateAdditionalHeaders(HttpMethod method)
Add all additionals headers that have been previously registered with addRequestHeader to the method |
protected void |
generateIfHeader(HttpMethod method)
Generate and add the If header to the specified HTTP method. |
protected void |
generateTransactionHeader(HttpMethod method)
Generates and adds the "Transaction" header if this method is part of an externally controlled transaction. |
java.util.Enumeration |
getActiveLockOwners()
Get the activelock owners for this resource. |
java.util.Enumeration |
getAllowedMethods()
Get the allowed methods, checked by HTTP OPTIONS. |
WebdavResources |
getChildResources()
Get all resources in this collection with the depth 1. |
long |
getCreationDate()
Get the value of DAV property, creationdate. |
java.util.Enumeration |
getDavCapabilities()
Get the WebDAV capabilities, checked by HTTP OPTIONS. |
static int |
getDefaultAction()
Get the default action. |
static int |
getDefaultDepth()
Get the default action. |
java.lang.String |
getDisplayName()
Get the value of DAV property, displayname. |
boolean |
getExistence()
Returns the last known information about the existence of this resource. |
boolean |
getFollowRedirects()
Returns the current "follow redirects" flag. |
long |
getGetContentLength()
Get the value of DAV property, getcontentlength. |
java.lang.String |
getGetContentType()
Get the value of DAV property, getcontenttype. |
java.lang.String |
getGetEtag()
Get the value of DAV property, getetag. |
long |
getGetLastModified()
Get the value of DAV property, getlastmodified. |
static java.lang.String |
getGetTempDir()
Deprecated. The returned directory is not used by the GET method. |
static boolean |
getGetUseDisk()
Deprecated. This method always returns false. |
java.lang.String |
getHost()
Get the hostname of this WebdavResource. |
HttpURL |
getHttpURL()
Get the HttpURL of this WebdavResource. |
HttpURL |
getHttpURLExceptForUserInfo()
Get the HttpURL except for userinfo. |
boolean |
getIsCollection()
Get the value of DAV property, iscollection |
boolean |
getIsHidden()
Get the value of DAV property, ishidden. |
LockDiscoveryProperty |
getLockDiscovery()
Get the value of DAV property, lockdiscovery. |
boolean |
getMethod(java.io.File file)
Execute the GET method for this WebdavResource path. |
boolean |
getMethod(java.lang.String path,
java.io.File file)
Execute the GET method for the given path. |
java.io.InputStream |
getMethodData()
Get InputStream for the GET method. |
java.io.InputStream |
getMethodData(java.lang.String path)
Get InputStream for the GET method for the given path. |
java.lang.String |
getMethodDataAsString()
Get data as a String for the GET method. |
java.lang.String |
getMethodDataAsString(java.lang.String path)
Get data as a String for the GET method for the given path. |
java.lang.String |
getName()
Get the name of this WebdavResource. |
boolean |
getOverwrite()
Get the current value of the overwrite flag for COPY, MOVE, BIND and REBIND. |
java.lang.String |
getOwner()
Get the owner string, as used for locking purposes. |
java.lang.String |
getPath()
Get the path part of this WebdavResource. |
ResourceTypeProperty |
getResourceType()
Get the value of DAV property, resourcetype. |
int |
getStatusCode()
Get the lastest value of the status code by HTTP methods. |
java.lang.String |
getStatusMessage()
Get the lastest value of the status message by HTTP methods. |
java.lang.String |
getSupportedLock()
Get the value of DAV property, supportedlock. |
java.lang.String |
getTransactionHandle()
Returns the transaction handle set by startTransaction(String, int) . |
boolean |
headMethod()
Execute the HEAD method for this WebdavResource. |
boolean |
headMethod(java.lang.String path)
Execute the HEAD method for the given path. |
boolean |
isCollection()
Get the value of DAV property, resourcetype |
boolean |
isLocked()
Test that this resource is locked. |
protected boolean |
isTheClient()
Test that the httpURL is the same with the client. |
boolean |
labelMethod(java.lang.String labelname,
int type)
Execute a LABEL method on the current path, setting the given label |
boolean |
labelMethod(java.lang.String path,
java.lang.String labelname,
int type)
Execute a LABEL method on the given path, setting the given label |
java.lang.String[] |
list()
Get an array of pathnames denoting the WebDAV resources in the collection denoted by this pathname. |
java.util.Vector |
listBasic()
Get an array of pathnames and basic information denoting the WebDAV resources in the denoted by this pathname. |
WebdavResource[] |
listWebdavResources()
Get an array of resources denoting the WebDAV child resources in the collection of this resources. |
LockDiscoveryProperty |
lockDiscoveryPropertyFindMethod()
Return the LockDiscoveryProperty for the current resource |
LockDiscoveryProperty |
lockDiscoveryPropertyFindMethod(java.lang.String path)
Return the LockDiscoveryProperty for the resource at the given path |
boolean |
lockMethod()
Execute the LOCK method for this WebdavResource. |
boolean |
lockMethod(java.lang.String path)
Execute the LOCK method for the given path. |
boolean |
lockMethod(java.lang.String owner,
int timeout)
Execute the LOCK method for this WebdavResource. |
boolean |
lockMethod(java.lang.String owner,
short timeout)
Deprecated. The timeout value MUST NOT be greater than 2^32-1. |
boolean |
lockMethod(java.lang.String path,
java.lang.String owner,
int timeout)
Execute the LOCK method for the given path. |
boolean |
lockMethod(java.lang.String path,
java.lang.String owner,
int timeout,
short lockType)
Execute the LOCK method for the given path. |
boolean |
lockMethod(java.lang.String path,
java.lang.String owner,
int timeout,
short lockType,
int depth)
Execute the LOCK method for the given path. |
boolean |
lockMethod(java.lang.String path,
java.lang.String owner,
short timeout)
Deprecated. The timeout value MUST NOT be greater than 2^32-1. |
boolean |
mkcolMethod()
Execute the MKCOL method for this WebdavResource. |
boolean |
mkcolMethod(java.lang.String path)
Execute the MKCOL method for the given path. |
boolean |
mkWorkspaceMethod()
Execute the MKWORKSPACE method for this WebdavResource. |
boolean |
mkWorkspaceMethod(java.lang.String path)
Execute the MKCOL method for the given path. |
boolean |
moveMethod(java.lang.String destination)
Execute the MOVE method for this WebdavReource. |
boolean |
moveMethod(java.lang.String source,
java.lang.String destination)
Execute the MOVE method for the given source and destination. |
boolean |
optionsMethod()
Execute OPTIONS method for this WebdavResource. |
java.util.Enumeration |
optionsMethod(HttpURL httpURL)
Execute OPTIONS method for the given http URL. |
java.util.Enumeration |
optionsMethod(HttpURL httpURL,
int type)
Execute OPTIONS method for the given http URL, DELTAV |
boolean |
optionsMethod(java.lang.String path)
Execute OPTIONS method for the given path. |
java.util.Enumeration |
optionsMethod(java.lang.String path,
int type)
Execute OPTIONS method for the given path. |
boolean |
optionsMethod(java.lang.String path,
java.lang.String aMethod)
Execute OPTIONS method for the given path. |
protected java.util.Date |
parseDate(java.lang.String dateValue)
Parse the java.util.Date string for HTTP-date. |
boolean |
pollMethod(java.lang.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. |
PrincipalCollectionSetProperty |
principalCollectionSetFindMethod()
Get the PrincipalCollectionSetProperty for the current
resource. |
PrincipalCollectionSetProperty |
principalCollectionSetFindMethod(java.lang.String path)
Get the PrincipalCollectionSetProperty for the resource. |
protected void |
processProperty(Property property)
Process a property, setting various member variables depending on what the property is. |
java.util.Enumeration |
propfindMethod(int depth)
Execute PROPFIND method with allprop for this WebdavResource. |
java.util.Enumeration |
propfindMethod(int depth,
java.util.Vector properties)
Execute PROPFIND method with by propname for this resource. |
java.util.Enumeration |
propfindMethod(java.lang.String propertyName)
Execute PROPFIND method for this WebdavResource. |
java.util.Enumeration |
propfindMethod(java.lang.String path,
int depth)
Execute PROPFIND method with allprop for the given path. |
java.util.Enumeration |
propfindMethod(java.lang.String path,
int depth,
java.util.Vector properties)
Execute PROPFIND method with by propname for the given path. |
java.util.Enumeration |
propfindMethod(java.lang.String path,
java.lang.String propertyName)
Execute PROPFIND method for the given WebdavResource path. |
java.util.Enumeration |
propfindMethod(java.lang.String path,
java.util.Vector properties)
Execute PROPFIND method for the given path and properties. |
java.util.Enumeration |
propfindMethod(java.util.Vector properties)
Execute PROPFIND method for this WebdavResource. |
boolean |
proppatchMethod(java.util.Hashtable properties)
Deprecated. it could be removed after the major version changes |
boolean |
proppatchMethod(java.util.Hashtable properties,
boolean action)
Execute PROPATCH method for this resource with the given properties. |
boolean |
proppatchMethod(PropertyName propertyName,
java.lang.String propertyValue)
Deprecated. it could be removed after the major version changes |
boolean |
proppatchMethod(PropertyName propertyName,
java.lang.String propertyValue,
boolean action)
Execute PROPATCH method for this resource with the given property. |
boolean |
proppatchMethod(java.lang.String path,
java.util.Hashtable properties)
Deprecated. it could be removed after the major version changes |
boolean |
proppatchMethod(java.lang.String path,
java.util.Hashtable properties,
boolean action)
Execute PROPATCH method for the specified resource with the given properties. |
boolean |
proppatchMethod(java.lang.String path,
PropertyName propertyName,
java.lang.String propertyValue)
Deprecated. it could be removed after the major version changes |
boolean |
proppatchMethod(java.lang.String path,
PropertyName propertyName,
java.lang.String propertyValue,
boolean action)
Execute PROPATCH method for the given resource with the given properties. |
boolean |
proppatchMethod(java.lang.String propertyName,
java.lang.String propertyValue)
Deprecated. it could be removed after the major version changes |
boolean |
proppatchMethod(java.lang.String propertyName,
java.lang.String propertyValue,
boolean action)
Execute PROPATCH method for this resource with the given property. |
boolean |
proppatchMethod(java.lang.String path,
java.lang.String propertyName,
java.lang.String propertyValue)
Deprecated. it could be removed after the major version changes |
boolean |
proppatchMethod(java.lang.String path,
java.lang.String propertyName,
java.lang.String propertyValue,
boolean action)
Execute PROPATCH method for the specified resource with the given property. |
boolean |
putMethod(byte[] data)
Execute the PUT method for this resource. |
boolean |
putMethod(java.io.File file)
Execute the PUT method for this WebdavResource. |
boolean |
putMethod(java.io.InputStream is)
Execute the PUT method for this resource. |
boolean |
putMethod(java.lang.String data)
Execute the PUT method for this WebdavResource. |
boolean |
putMethod(java.lang.String path,
byte[] data)
Execute the PUT method for the given path. |
boolean |
putMethod(java.lang.String path,
java.io.File file)
Execute the PUT method for the given path. |
boolean |
putMethod(java.lang.String path,
java.io.InputStream is)
Execute the PUT method for the given path. |
boolean |
putMethod(java.lang.String path,
java.lang.String data)
Execute the PUT method for the given path. |
boolean |
putMethod(java.lang.String path,
java.net.URL url)
Execute the PUT method for the given path from the given url. |
boolean |
putMethod(java.net.URL url)
Execute the PUT method for this resource from the given url. |
boolean |
rebindMethod(java.lang.String newBinding)
Execute the Rebind method for this WebdavResource given the new Resource to bind with. |
boolean |
rebindMethod(java.lang.String existingBinding,
java.lang.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 command |
java.util.Enumeration |
reportMethod(HttpURL httpURL,
int depth)
Execute the REPORT method. |
java.util.Enumeration |
reportMethod(HttpURL httpURL,
java.lang.String sQuery,
int depth)
|
java.util.Enumeration |
reportMethod(HttpURL httpURL,
java.util.Vector properties)
|
java.util.Enumeration |
reportMethod(HttpURL httpURL,
java.util.Vector properties,
int depth)
|
java.util.Enumeration |
reportMethod(HttpURL httpURL,
java.util.Vector properties,
java.util.Vector histUri,
int depth)
|
HttpClient |
retrieveSessionInstance()
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 |
setClient()
Set the client for this resource. |
protected void |
setClient(HttpURL httpURL)
Set the client for this resource and the given http URL. |
void |
setContentType(java.lang.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(java.lang.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(java.lang.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(java.lang.String getContentLength)
Set the value of DAV property, getcontentlength. |
protected void |
setGetContentType(java.lang.String getContentType)
Set the value of DAV property, getcontenttype. |
protected void |
setGetEtag(java.lang.String getEtag)
Set the value of DAV property, getetag. |
protected void |
setGetLastModified(long getLastModified)
Set the value of DAV property, getlastmodified. |
protected void |
setGetLastModified(java.lang.String getLastModified)
Set the value of DAV property, getlastmodified. |
static void |
setGetTempDir(java.lang.String tempDir)
Deprecated. The given directory will not be used. |
static void |
setGetUseDisk(boolean useDisk)
Deprecated. This method has no effect. |
void |
setHttpURL(HttpURL httpURL)
Set the HttpURL for this WebdavResource. |
void |
setHttpURL(HttpURL httpURL,
int depth)
Set the HttpURL for this WebdavResource. |
void |
setHttpURL(HttpURL httpURL,
int action,
int depth)
Set the HttpURL for this WebdavResource. |
void |
setHttpURL(HttpURL httpURL,
java.lang.String additionalPath)
Set the HttpURL for this WebdavResource. |
void |
setHttpURL(HttpURL httpURL,
java.lang.String additionalPath,
int action)
Set the HttpURL for this WebdavResource. |
void |
setHttpURL(HttpURL httpURL,
java.lang.String additionalPath,
int action,
int depth)
Set the HttpURL for this WebdavResource. |
void |
setHttpURL(java.lang.String escapedHttpURL)
Set the HttpURL of this WebdavResource. |
protected void |
setIsCollection(boolean isCollection)
Set the value of DAV property, iscollection |
protected void |
setIsCollection(java.lang.String isCollection)
Set the value of DAV property, iscollection |
protected void |
setIsHidden(boolean isHidden)
Set the value of DAV property, ishidden. |
protected void |
setIsHidden(java.lang.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,
java.util.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 |
setPath(java.lang.String path)
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,
java.lang.String message)
Set the lastest value of the status code by HTTP methods. |
protected void |
setSupportedLock(java.lang.String supportedLock)
Set the value of DAV property, supportedlock. |
void |
setUserInfo(java.lang.String userName,
java.lang.String password)
Set the userinfo part of this WebdavResource. |
protected void |
setWebdavProperties(java.util.Enumeration responses)
Set WebDAV properties following to the given http URL. |
boolean |
startTransaction(java.lang.String owner,
int timeout)
Begins a new transaction. |
boolean |
subscribeMethod(java.lang.String path,
int subscriptionId)
Refreshes a subscription. |
Subscription |
subscribeMethod(java.lang.String path,
java.lang.String notificationType,
java.lang.String callback,
long notificationDelay,
int depth,
long lifetime)
Subscribes for notifications for modifications of WebDAV resources. |
boolean |
subscribeMethod(Subscription subscription)
Refreshes a subscription. |
java.lang.String |
toString()
Return the http URL string. |
boolean |
unbindMethod()
Execute the UNBIND method for this WebdavResource. |
boolean |
unbindMethod(java.lang.String binding)
Execute the UNBIND method given the resource to Unbind. |
boolean |
uncheckoutMethod()
Execute the CHECKOUT method for this WebdavResource. |
boolean |
uncheckoutMethod(java.lang.String path)
Execute the CHECKOUT method for the given path. |
boolean |
unlockMethod()
Execute the Unlock method for this WebdavResource. |
boolean |
unlockMethod(java.lang.String path)
Execute the Unlock method for the given path. |
boolean |
unlockMethod(java.lang.String path,
java.lang.String owner)
Execute the Unlock method for the given path. |
boolean |
unsubscribeMethod(java.lang.String path,
int subscriptionId)
Cancels a subscription. |
boolean |
unsubscribeMethod(Subscription subscription)
Cancels a subscription. |
boolean |
updateMethod(java.lang.String target)
Update this resource to the specified target |
boolean |
updateMethod(java.lang.String path,
java.lang.String target)
Update the specified resource to the specified target |
boolean |
versionControlMethod(java.lang.String path)
|
boolean |
versionControlMethod(java.lang.String path,
java.lang.String target)
|
Methods inherited from class org.apache.webdav.lib.WebdavSession |
---|
closeSession, closeSession, getSessionInstance, getSessionInstance, setCredentials, setDebug, setProxy, setProxyCredentials |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DISPLAYNAME
public static final java.lang.String GETCONTENTLANGUAGE
public static final java.lang.String GETCONTENTLENGTH
public static final java.lang.String GETLASTMODIFIED
public static final java.lang.String CREATIONDATE
public static final java.lang.String RESOURCETYPE
public static final java.lang.String SOURCE
public static final java.lang.String GETCONTENTTYPE
public static final java.lang.String GETETAG
public static final java.lang.String ISHIDDEN
public static final java.lang.String ISCOLLECTION
public static final java.lang.String SUPPORTEDLOCK
public static final java.lang.String LOCKDISCOVERY
public static final int NOACTION
public static final int NAME
public static final int BASIC
public static final int DEFAULT
public static final int ALL
public static final int OPTIONS_WORKSPACE
public static final int OPTIONS_VERSION_HISTORY
public static final int LABEL_SET
public static final int LABEL_REMOVE
public static final int LABEL_ADD
public static final java.lang.String defaultOwner
public static final java.lang.String TRUE
public static final java.lang.String FALSE
public static final java.text.SimpleDateFormat[] formats
protected static final java.util.TimeZone gmtZone
protected HttpURL httpURL
protected WebdavResources childResources
protected static int defaultAction
protected static int defaultDepth
protected static java.lang.String tempDirForGet
protected static boolean useDiskForGet
protected boolean thisResource
protected java.util.Enumeration allowedMethods
protected java.util.Enumeration davCapabilities
protected boolean exists
protected boolean overwrite
protected int latestStatusCode
protected java.lang.String latestStatusMessage
protected java.lang.String displayName
protected long getContentLength
protected java.lang.String getContentType
protected ResourceTypeProperty resourceType
protected long getLastModified
protected long creationDate
protected java.lang.String getEtag
protected java.lang.String owner
protected boolean isHidden
protected boolean isCollection
protected java.lang.String supportedLock
protected LockDiscoveryProperty lockDiscovery
protected boolean followRedirects
protected java.util.Map headers
Constructor Detail |
---|
protected WebdavResource()
protected WebdavResource(HttpClient client)
public WebdavResource(HttpURL httpURL, Credentials credentials, int action, int depth) throws HttpException, java.io.IOException
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.
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(HttpURL httpURL, int action, int depth) throws HttpException, java.io.IOException
httpURL
- The specified http URL.action
- The action to set properties of this resource.depth
- The depth to find properties.
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(HttpURL httpURL, int action, int depth, boolean followRedirects) throws HttpException, java.io.IOException
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
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(HttpURL httpURL, int depth) throws HttpException, java.io.IOException
httpURL
- The specified http URL.depth
- The depth to find properties.
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(HttpURL httpURL, int depth, boolean followRedirects) throws HttpException, java.io.IOException
httpURL
- The specified http URL.depth
- The depth to find properties.followRedirects
- Shall redirects be followed automatically.
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(HttpURL httpURL) throws HttpException, java.io.IOException
httpURL
- The specified http URL.
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(HttpURL httpURL, boolean followRedirects) throws HttpException, java.io.IOException
httpURL
- The specified http URL.followRedirects
- shall redirects from the server be accepted
HttpException
java.io.IOException
public WebdavResource(HttpURL httpURL, java.lang.String proxyHost, int proxyPort) throws HttpException, java.io.IOException
httpURL
- The specified http URL.proxyHost
- The hostname of the proxy to use.proxyPort
- The port number of the proxy to use.
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(HttpURL httpURL, java.lang.String proxyHost, int proxyPort, boolean followRedirects) throws HttpException, java.io.IOException
HttpException
java.io.IOException
public WebdavResource(HttpURL httpURL, java.lang.String proxyHost, int proxyPort, Credentials proxyCredentials) throws HttpException, java.io.IOException
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.
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(HttpURL httpURL, java.lang.String proxyHost, int proxyPort, Credentials proxyCredentials, boolean followRedirects) throws HttpException, java.io.IOException
HttpException
java.io.IOException
public WebdavResource(java.lang.String escapedHttpURL) throws HttpException, java.io.IOException
escapedHttpURL
- The escaped http URL string.
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(java.lang.String escapedHttpURL, boolean followRedirects) throws HttpException, java.io.IOException
HttpException
java.io.IOException
public WebdavResource(java.lang.String escapedHttpURL, Credentials credentials) throws HttpException, java.io.IOException
escapedHttpURL
- The escaped http URL string.credentials
- The credentials used for Authentication.
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(java.lang.String escapedHttpURL, Credentials credentials, boolean followRedirects) throws HttpException, java.io.IOException
HttpException
java.io.IOException
public WebdavResource(java.lang.String escapedHttpURL, java.lang.String proxyHost, int proxyPort) throws HttpException, java.io.IOException
escapedHttpURL
- The escaped http URL string.proxyHost
- The hostname of the proxy to use.proxyPort
- The port number of the proxy to use.
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(java.lang.String escapedHttpURL, java.lang.String proxyHost, int proxyPort, Credentials proxyCredentials) throws HttpException, java.io.IOException
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.
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(HttpURL httpURL, java.lang.String additionalPath) throws HttpException, java.io.IOException
httpURL
- The http URL.additionalPath
- The added relative path.
HttpException
java.io.IOException
setDefaultAction(int)
public WebdavResource(HttpURL httpURL, java.lang.String additionalPath, boolean followRedirects) throws HttpException, java.io.IOException
httpURL
- The http URL.additionalPath
- The added relative path.followRedirects
- shall redirects be accepted
HttpException
java.io.IOException
Method Detail |
---|
protected void generateTransactionHeader(HttpMethod method)
protected void generateIfHeader(HttpMethod method)
protected void generateAdditionalHeaders(HttpMethod method)
protected java.util.Date parseDate(java.lang.String dateValue)
java.util.Date
string for HTTP-date.
protected void setNameProperties(int depth) throws HttpException, java.io.IOException
depth
- The depth to find properties.
HttpException
java.io.IOException
protected void setBasicProperties(int depth) throws HttpException, java.io.IOException
Properties retrieved include:
depth
- The depth to find properties.
HttpException
java.io.IOException
protected void setDefaultProperties(int depth) throws HttpException, java.io.IOException
Properties retrieved include:
depth
- The depth to find properties.
HttpException
java.io.IOException
protected void setNamedProp(int depth, java.util.Vector propertyNames) throws HttpException, java.io.IOException
depth
- The depth.propertyNames
- The property-names.
HttpException
java.io.IOException
protected void setAllProp(int depth) throws HttpException, java.io.IOException
depth
- The depth
HttpException
java.io.IOException
protected void setWebdavProperties(java.util.Enumeration responses) throws HttpException, java.io.IOException
responses
- An enumeration over ResponseEntity
items, one
for each resource for which information was returned via PROPFIND.
HttpException
java.io.IOException
- The socket error with a server.public static void setDefaultAction(int action)
action
- The action type.NOACTION
,
NAME
,
BASIC
,
DEFAULT
,
ALL
public static int getDefaultAction()
public static void setDefaultDepth(int depth)
depth
- The depth.public static int getDefaultDepth()
public static void setGetTempDir(java.lang.String tempDir)
tempDir
- The temporary directory.public static java.lang.String getGetTempDir()
public static void setGetUseDisk(boolean useDisk)
useDisk
- The use disk flag.public static boolean getGetUseDisk()
public void setFollowRedirects(boolean value)
public boolean getFollowRedirects()
setFollowRedirects(boolean)
protected boolean isTheClient() throws URIException
URIException
protected void setClient() throws java.io.IOException
java.io.IOException
protected void setClient(HttpURL httpURL) throws java.io.IOException
httpURL
- The http URL.
java.io.IOException
public void setHttpURL(HttpURL httpURL, int action, int depth) throws HttpException, java.io.IOException
httpURL
- the specified HttpURL.action
- The action to decide, which properties to find.depth
- The depth to find properties.
HttpException
java.io.IOException
setHttpURL(java.lang.String)
,
setUserInfo(java.lang.String, java.lang.String)
,
setPath(java.lang.String)
,
setDefaultAction(int)
public void setHttpURL(HttpURL httpURL, int depth) throws HttpException, java.io.IOException
httpURL
- the specified HttpURL.depth
- The depth to find properties.
HttpException
java.io.IOException
setHttpURL(java.lang.String)
,
setUserInfo(java.lang.String, java.lang.String)
,
setPath(java.lang.String)
public void setHttpURL(HttpURL httpURL, java.lang.String additionalPath, int action, int depth) throws HttpException, java.io.IOException
httpURL
- The specified HttpURL.additionalPath
- The added relative path.action
- The action to decide, which properties to find.depth
- The depth.
HttpException
java.io.IOException
setHttpURL(java.lang.String)
,
setUserInfo(java.lang.String, java.lang.String)
,
setPath(java.lang.String)
,
setDefaultAction(int)
public void setHttpURL(HttpURL httpURL, java.lang.String additionalPath, int action) throws HttpException, java.io.IOException
httpURL
- The specified HttpURL.additionalPath
- The added relative path.action
- The action to decide, which properties to find.
HttpException
java.io.IOException
setHttpURL(java.lang.String)
,
setUserInfo(java.lang.String, java.lang.String)
,
setPath(java.lang.String)
,
setDefaultAction(int)
public void setHttpURL(HttpURL httpURL, java.lang.String additionalPath) throws HttpException, java.io.IOException
httpURL
- The specified HttpURL.additionalPath
- The added relative path.
HttpException
java.io.IOException
setHttpURL(java.lang.String)
,
setUserInfo(java.lang.String, java.lang.String)
,
setPath(java.lang.String)
public void setHttpURL(HttpURL httpURL) throws HttpException, java.io.IOException
httpURL
- the specified HttpURL.
HttpException
java.io.IOException
setHttpURL(java.lang.String)
,
setUserInfo(java.lang.String, java.lang.String)
,
setPath(java.lang.String)
public void setHttpURL(java.lang.String escapedHttpURL) throws HttpException, java.io.IOException
escapedHttpURL
- The escaped http URL string.
HttpException
java.io.IOException
setHttpURL(HttpURL)
,
setUserInfo(java.lang.String, java.lang.String)
,
setPath(java.lang.String)
public HttpURL getHttpURL()
public HttpURL getHttpURLExceptForUserInfo() throws URIException
URIException
public void setPath(java.lang.String path) throws HttpException, java.io.IOException
path
- the specified path.
HttpException
java.io.IOException
setHttpURL(HttpURL)
,
setHttpURL(java.lang.String)
,
setUserInfo(java.lang.String, java.lang.String)
public java.lang.String getPath()
URI.getPath()
,
setPath(java.lang.String)
public java.lang.String getName()
URI.getName()
public java.lang.String getHost() throws URIException
URIException
public void setUserInfo(java.lang.String userName, java.lang.String password) throws HttpException, java.io.IOException
HttpException
java.io.IOException
setHttpURL(HttpURL)
,
setHttpURL(java.lang.String)
,
setPath(java.lang.String)
public void addRequestHeader(java.lang.String header, java.lang.String value)
header
- Header namevalue
- Valuepublic java.lang.String getDisplayName()
protected void setDisplayName(java.lang.String displayName)
displayName
- The displayname string.public long getGetContentLength()
protected void setGetContentLength(long getContentLength)
getContentLength
- The getcontentlength value.protected void setGetContentLength(java.lang.String getContentLength)
getContentLength
- The getcontentlength value.public ResourceTypeProperty getResourceType()
isCollection()
protected void setResourceType(ResourceTypeProperty resourceType)
resourceType
- The resourcetype property.public boolean isCollection()
getResourceType()
,
getIsCollection()
public java.lang.String getGetContentType()
protected void setGetContentType(java.lang.String getContentType)
getContentType
- The getcontenttype string.public void setContentType(java.lang.String contentType)
contentType
- The content-type string.public long getGetLastModified()
protected void setGetLastModified(long getLastModified)
getLastModified
- The getlastmodified value.setGetLastModified(java.lang.String)
protected void setGetLastModified(java.lang.String getLastModified)
getLastModified
- The getlastmodified value.setGetLastModified(long)
public long getCreationDate()
protected void setCreationDate(long creationDate)
creationDate
- The creationdate string.protected void setCreationDate(java.lang.String creationDate)
creationDate
- The creationdate string.public java.lang.String getGetEtag()
protected void setGetEtag(java.lang.String getEtag)
getEtag
- The getetag string.public java.lang.String getOwner()
public java.lang.String getSupportedLock()
protected void setSupportedLock(java.lang.String supportedLock)
supportedLock
- The supportedlock string.public LockDiscoveryProperty getLockDiscovery()
protected void setLockDiscovery(LockDiscoveryProperty lockDiscovery)
lockDiscovery
- The lockdiscovery property.public java.util.Enumeration getActiveLockOwners()
public boolean isLocked()
public boolean getIsHidden()
protected void setIsHidden(boolean isHidden)
isHidden
- protected void setIsHidden(java.lang.String isHidden)
isHidden
- public boolean getIsCollection()
isCollection()
protected void setIsCollection(boolean isCollection)
isCollection
- protected void setIsCollection(java.lang.String isCollection)
isCollection
- public void setProperties(int action, int depth) throws HttpException, java.io.IOException
action
- The action to find properties for this resource.depth
- the depth to which properties shall be found
HttpException
java.io.IOException
setDefaultAction(int)
public void setProperties(int depth) throws HttpException, java.io.IOException
depth
- the depth to which properties shall be found
HttpException
java.io.IOException
protected void refresh() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean exists()
getExistence()
,
setProperties(int, int)
protected void setExistence(boolean exists)
exists
- The boolean value to be set for its existence.public boolean getExistence()
setProperties(int, int)
public void setOverwrite(boolean overwrite)
overwrite
- the overwrite flaggetOverwrite()
public boolean getOverwrite()
setOverwrite(boolean)
public void close() throws java.io.IOException
java.io.IOException
public java.lang.String getStatusMessage()
public int getStatusCode()
protected void setStatusCode(int statusCode)
statusCode
- the HTTP status code.protected void setStatusCode(int statusCode, java.lang.String message)
statusCode
- the HTTP status code.message
- the additional message.public java.util.Enumeration getAllowedMethods()
optionsMethod(java.lang.String)
public java.util.Enumeration getDavCapabilities()
optionsMethod(java.lang.String)
public WebdavResources getChildResources() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public WebdavResource[] listWebdavResources() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public java.lang.String[] list()
public java.util.Vector listBasic() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public void setEncodeURLs(boolean encodeURLs)
encodeURLs
- true if it is encoded.
MalformedURLException
java.io.IOException
public HttpClient retrieveSessionInstance() throws java.io.IOException
java.io.IOException
executeHttpRequestMethod(HttpClient, HttpMethod)
public int executeHttpRequestMethod(HttpClient client, HttpMethod method) throws java.io.IOException, HttpException
client
- The http client.method
- The http method.
java.io.IOException
HttpException
retrieveSessionInstance()
public boolean aclMethod(java.lang.String path, Ace[] aces) throws HttpException, java.io.IOException
path
- the server relative path of the resource to which the given
ACEs shall be appliedaces
- the ACEs to apply
HttpException
java.io.IOException
public AclProperty aclfindMethod() throws HttpException, java.io.IOException
AclProperty
for the current resource
AclProperty
HttpException
java.io.IOException
public AclProperty aclfindMethod(java.lang.String path) throws HttpException, java.io.IOException
AclProperty
for the resource at the given path
path
- the server relative path of the resource to request
AclProperty
HttpException
java.io.IOException
public PrincipalCollectionSetProperty principalCollectionSetFindMethod() throws HttpException, java.io.IOException
PrincipalCollectionSetProperty
for the current
resource.
PrincipalCollectionSetProperty
HttpException
java.io.IOException
public PrincipalCollectionSetProperty principalCollectionSetFindMethod(java.lang.String path) throws HttpException, java.io.IOException
PrincipalCollectionSetProperty
for the resource.
path
- the server relative path of the resource to request
PrincipalCollectionSetProperty
HttpException
java.io.IOException
public LockDiscoveryProperty lockDiscoveryPropertyFindMethod() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public LockDiscoveryProperty lockDiscoveryPropertyFindMethod(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path of the resource to request
HttpException
java.io.IOException
public java.io.InputStream getMethodData() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public java.io.InputStream getMethodData(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path of the resource to get
HttpException
java.io.IOException
public java.lang.String getMethodDataAsString() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public java.lang.String getMethodDataAsString(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path of the resource to get
HttpException
java.io.IOException
public boolean getMethod(java.io.File file) throws HttpException, java.io.IOException
file
- The local file.
HttpException
java.io.IOException
public boolean getMethod(java.lang.String path, java.io.File file) throws HttpException, java.io.IOException
path
- the server relative path of the resource to getfile
- The local file.
HttpException
java.io.IOException
public boolean putMethod(byte[] data) throws HttpException, java.io.IOException
data
- The byte array.
HttpException
java.io.IOException
public boolean putMethod(java.lang.String path, byte[] data) throws HttpException, java.io.IOException
path
- the server relative path to put the datadata
- The byte array.
HttpException
java.io.IOException
public boolean putMethod(java.io.InputStream is) throws HttpException, java.io.IOException
is
- The input stream.
HttpException
java.io.IOException
public boolean putMethod(java.lang.String path, java.io.InputStream is) throws HttpException, java.io.IOException
path
- the server relative path to put the datais
- The input stream.
HttpException
java.io.IOException
public boolean putMethod(java.lang.String data) throws HttpException, java.io.IOException
data
- String data to send.
HttpException
java.io.IOException
public boolean putMethod(java.lang.String path, java.lang.String data) throws HttpException, java.io.IOException
path
- the server relative path to put the datadata
- String to send.
HttpException
java.io.IOException
public boolean putMethod(java.io.File file) throws HttpException, java.io.IOException
file
- the filename to get on local.
HttpException
java.io.IOException
public boolean putMethod(java.lang.String path, java.io.File file) throws HttpException, java.io.IOException
path
- the server relative path to put the given filefile
- the filename to get on local.
HttpException
java.io.IOException
public boolean putMethod(java.net.URL url) throws HttpException, java.io.IOException
url
- The URL to get a resource.
HttpException
java.io.IOException
public boolean putMethod(java.lang.String path, java.net.URL url) throws HttpException, java.io.IOException
path
- the server relative path to put the dataurl
- The URL to get a resource.
HttpException
java.io.IOException
public boolean optionsMethod() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean optionsMethod(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path of the resource to request
HttpException
java.io.IOException
getAllowedMethods()
public boolean optionsMethod(java.lang.String path, java.lang.String aMethod) throws HttpException, java.io.IOException
path
- the server relative path to send the requestaMethod
- a method to check it's supported.
HttpException
java.io.IOException
public java.util.Enumeration optionsMethod(HttpURL httpURL) throws HttpException, java.io.IOException
httpURL
- the http URL.
HttpException
java.io.IOException
public java.util.Enumeration optionsMethod(HttpURL httpURL, int type) throws HttpException, java.io.IOException
httpURL
- the http URL.
HttpException
java.io.IOException
public java.util.Enumeration optionsMethod(java.lang.String path, int type) throws HttpException, java.io.IOException
path
- the server relative path of the resource to request
HttpException
java.io.IOException
getAllowedMethods()
public boolean labelMethod(java.lang.String labelname, int type) throws HttpException, java.io.IOException
labelname
- the label to settype
- the type of action. One of:
HttpException
java.io.IOException
public boolean labelMethod(java.lang.String path, java.lang.String labelname, int type) throws HttpException, java.io.IOException
path
- the server relative path of the resource to act onlabelname
- the label to settype
- the type of action. One of:
HttpException
java.io.IOException
public java.util.Enumeration reportMethod(HttpURL httpURL, int depth) throws HttpException, java.io.IOException
HttpException
java.io.IOException
public java.util.Enumeration reportMethod(HttpURL httpURL, java.util.Vector properties) throws HttpException, java.io.IOException
HttpException
java.io.IOException
public java.util.Enumeration reportMethod(HttpURL httpURL, java.util.Vector properties, int depth) throws HttpException, java.io.IOException
HttpException
java.io.IOException
public java.util.Enumeration reportMethod(HttpURL httpURL, java.util.Vector properties, java.util.Vector histUri, int depth) throws HttpException, java.io.IOException
HttpException
java.io.IOException
public java.util.Enumeration reportMethod(HttpURL httpURL, java.lang.String sQuery, int depth) throws HttpException, java.io.IOException
HttpException
java.io.IOException
public java.util.Enumeration propfindMethod(int depth) throws HttpException, java.io.IOException
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.
depth
-
ResponseEntity
HttpException
java.io.IOException
public java.util.Enumeration propfindMethod(java.lang.String path, int depth) throws HttpException, java.io.IOException
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.
path
- the server relative path of the resource to requestdepth
-
ResponseEntity
HttpException
java.io.IOException
public java.util.Enumeration propfindMethod(int depth, java.util.Vector properties) throws HttpException, java.io.IOException
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.
depth
- The depth.properties
- The named properties.
ResponseEntity
HttpException
java.io.IOException
public java.util.Enumeration propfindMethod(java.lang.String path, int depth, java.util.Vector properties) throws HttpException, java.io.IOException
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.
path
- the server relative path of the resource to requestdepth
- The depth.properties
- The named properties.
ResponseEntity
HttpException
java.io.IOException
public java.util.Enumeration propfindMethod(java.lang.String propertyName) throws HttpException, java.io.IOException
propertyName
- the WebDAV property to find.
HttpException
java.io.IOException
public java.util.Enumeration propfindMethod(java.lang.String path, java.lang.String propertyName) throws HttpException, java.io.IOException
path
- the server relative path of the resource to requestpropertyName
- the WebDAV property to find.
HttpException
java.io.IOException
public java.util.Enumeration propfindMethod(java.util.Vector properties) throws HttpException, java.io.IOException
properties
- the WebDAV properties to find.
HttpException
java.io.IOException
public java.util.Enumeration propfindMethod(java.lang.String path, java.util.Vector properties) throws HttpException, java.io.IOException
path
- the server relative path of the resource to requestproperties
- the WebDAV properties to find.
HttpException
java.io.IOException
public boolean proppatchMethod(java.lang.String propertyName, java.lang.String propertyValue) throws HttpException, java.io.IOException
propertyName
- the name of the property to setpropertyValue
- the value of the property to set
HttpException
java.io.IOException
public boolean proppatchMethod(java.lang.String propertyName, java.lang.String propertyValue, boolean action) throws HttpException, java.io.IOException
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
HttpException
java.io.IOException
public boolean proppatchMethod(PropertyName propertyName, java.lang.String propertyValue) throws HttpException, java.io.IOException
propertyName
- the name of the property to setpropertyValue
- the value of the property to set
HttpException
java.io.IOException
public boolean proppatchMethod(PropertyName propertyName, java.lang.String propertyValue, boolean action) throws HttpException, java.io.IOException
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
HttpException
java.io.IOException
public boolean proppatchMethod(java.lang.String path, java.lang.String propertyName, java.lang.String propertyValue) throws HttpException, java.io.IOException
path
- the server relative path of the resource to act onpropertyName
- the property name in "DAV:" namespacepropertyValue
- the property value string
HttpException
java.io.IOException
public boolean proppatchMethod(java.lang.String path, java.lang.String propertyName, java.lang.String propertyValue, boolean action) throws HttpException, java.io.IOException
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
HttpException
java.io.IOException
public boolean proppatchMethod(java.lang.String path, PropertyName propertyName, java.lang.String propertyValue) throws HttpException, java.io.IOException
path
- the server relative path of the resource to act onpropertyName
- the property name.propertyValue
- the property value.
HttpException
java.io.IOException
public boolean proppatchMethod(java.lang.String path, PropertyName propertyName, java.lang.String propertyValue, boolean action) throws HttpException, java.io.IOException
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
HttpException
java.io.IOException
public boolean proppatchMethod(java.util.Hashtable properties) throws HttpException, java.io.IOException
properties
- name and value pairs to set
(name can be a String or PropertyName)
HttpException
java.io.IOException
public boolean proppatchMethod(java.util.Hashtable properties, boolean action) throws HttpException, java.io.IOException
properties
- the name(= String
or PropertyName
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
HttpException
java.io.IOException
public boolean proppatchMethod(java.lang.String path, java.util.Hashtable properties) throws HttpException, java.io.IOException
path
- the server relative path of the resource to act onproperties
- name and value pairs to set
(name can be a String or PropertyName)
HttpException
java.io.IOException
public boolean proppatchMethod(java.lang.String path, java.util.Hashtable properties, boolean action) throws HttpException, java.io.IOException
path
- the server relative path of the resource to act onproperties
- the name(= String
or PropertyName
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
HttpException
java.io.IOException
public boolean headMethod() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean headMethod(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path of the resource to request
HttpException
java.io.IOException
public boolean deleteMethod() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean deleteMethod(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path of the resource to delete
HttpException
java.io.IOException
public boolean moveMethod(java.lang.String destination) throws HttpException, java.io.IOException
destination
- the destination to move to as a server relative path
HttpException
java.io.IOException
public boolean moveMethod(java.lang.String source, java.lang.String destination) throws HttpException, java.io.IOException
source
- the source resource as a server relativ pathdestination
- the destination to move to as a server relative path
HttpException
java.io.IOException
public boolean copyMethod(java.lang.String destination) throws HttpException, java.io.IOException
destination
- the destination as a server relative path
HttpException
java.io.IOException
public boolean copyMethod(java.lang.String source, java.lang.String destination) throws HttpException, java.io.IOException
source
- the source resource as a server relative pathdestination
- the destination as a server relative path
HttpException
java.io.IOException
public boolean mkcolMethod() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean mkcolMethod(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path at which to create a new collection
resource
HttpException
java.io.IOException
public boolean lockMethod() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean lockMethod(java.lang.String owner, int timeout) throws HttpException, java.io.IOException
owner
- the owner string.timeout
- the timeout
HttpException
java.io.IOException
public boolean lockMethod(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path of the resource to lock
HttpException
java.io.IOException
public boolean lockMethod(java.lang.String path, java.lang.String owner, int timeout) throws HttpException, java.io.IOException
path
- the server relative path of the resource to lockowner
- The owner string.timeout
- the timeout value.
HttpException
java.io.IOException
public boolean lockMethod(java.lang.String path, java.lang.String owner, int timeout, short lockType) throws HttpException, java.io.IOException
path
- the server relative path of the resource to lockowner
- The owner string.timeout
- the timeout value.locktype,
- the scope of lock.
HttpException
java.io.IOException
public boolean lockMethod(java.lang.String path, java.lang.String owner, int timeout, short lockType, int depth) throws HttpException, java.io.IOException
path
- the server relative path of the resource to lockowner
- The owner string.timeout
- the timeout value.locktype,
- the scope of lock.
HttpException
java.io.IOException
public boolean lockMethod(java.lang.String owner, short timeout) throws HttpException, java.io.IOException
HttpException
java.io.IOException
LockMethod
public boolean lockMethod(java.lang.String path, java.lang.String owner, short timeout) throws HttpException, java.io.IOException
HttpException
java.io.IOException
LockMethod
public boolean startTransaction(java.lang.String owner, int timeout) throws java.io.IOException
commitTransaction()
or abortTransaction()
are called. You can retrieve it using getTransactionHandle()
.
owner
- the owner of this transactiontimeout
- timeout in milleseconds
true
if the transaction has been successfully started, false
otherwise
java.io.IOException
- if anything goes wrongcommitTransaction()
,
abortTransaction()
,
getTransactionHandle()
public java.lang.String getTransactionHandle() throws java.io.IOException
startTransaction(String, int)
.
null
if the client does not operate inside a transaction
java.io.IOException
- if anything goes wrongstartTransaction(String, int)
public boolean commitTransaction() throws java.io.IOException
startTransaction(String, int)
and resets the transaction handle.
true
if the transaction has been successfully committed, false
otherwise
java.io.IOException
- if anything goes wrongstartTransaction(String, int)
,
abortTransaction()
,
getTransactionHandle()
public boolean abortTransaction() throws java.io.IOException
startTransaction(String, int)
and resets the transaction handle.
true
if the transaction has been successfully committed, false
otherwise
java.io.IOException
- if anything goes wrongstartTransaction(String, int)
,
abortTransaction()
,
getTransactionHandle()
protected boolean endTransaction(java.lang.String path, int transactionStatus) throws java.io.IOException
java.io.IOException
public boolean unlockMethod() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean unlockMethod(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path of the resource to unlock
HttpException
java.io.IOException
public boolean unlockMethod(java.lang.String path, java.lang.String owner) throws HttpException, java.io.IOException
path
- the server relative path of the resource to unlock
HttpException
java.io.IOException
public void discoverOwnLocks() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public void discoverOwnLocks(java.lang.String owner) throws HttpException, java.io.IOException
owner
- the owner who's locks are to be discovered.
HttpException
java.io.IOException
protected WebdavState discoverLock(java.lang.String owner, java.lang.String path, WebdavState state)
owner
- the activelock ownerpath
- the server relative path of the resource to requeststate
- the state to save the locktoken
public boolean updateMethod(java.lang.String target) throws HttpException, java.io.IOException
target
- the path of the history element to update this resource
from
HttpException
java.io.IOException
public boolean updateMethod(java.lang.String path, java.lang.String target) throws HttpException, java.io.IOException
path
- the server relative path of the resource to updatetarget
- path of the target to update from (history resource)
HttpException
java.io.IOException
public boolean versionControlMethod(java.lang.String path) throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean versionControlMethod(java.lang.String path, java.lang.String target) throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean mkWorkspaceMethod() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean mkWorkspaceMethod(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path at which to create a new workspace
resource
HttpException
java.io.IOException
public int compareToWebdavResource(WebdavResource another)
another
- the other WebdavResource object
public int compareTo(java.lang.Object another)
another
- the other WebdavResource object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- the other object
public java.lang.String toString()
toString
in class java.lang.Object
public boolean checkinMethod() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean checkinMethod(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path of the resource to check in
HttpException
java.io.IOException
public boolean checkoutMethod() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean checkoutMethod(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path of the resource to check out
HttpException
java.io.IOException
public boolean uncheckoutMethod() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean uncheckoutMethod(java.lang.String path) throws HttpException, java.io.IOException
path
- the server relative path of the resource to act on
HttpException
java.io.IOException
protected WebdavResource createWebdavResource(HttpClient client)
client
- HttpClient to be used by this webdavresource.
protected void processProperty(Property property)
property
- The property to process.public java.util.Enumeration aclReportMethod(java.lang.String path, java.util.Collection properties, int reportType) throws HttpException, java.io.IOException
path
- the server relative path of the resource to requestproperties
- The named properties.
ResponseEntity
HttpException
java.io.IOException
public boolean bindMethod(java.lang.String newBinding) throws HttpException, java.io.IOException
newBinding
- the new binding as a server relative path
HttpException
java.io.IOException
setOverwrite(boolean)
public boolean bindMethod(java.lang.String existingBinding, java.lang.String newBinding) throws HttpException, java.io.IOException
existingBinding
- the existing binding as a server relative pathnewBinding
- the new binding as a server relative path
HttpException
java.io.IOException
setOverwrite(boolean)
public boolean unbindMethod() throws HttpException, java.io.IOException
HttpException
java.io.IOException
public boolean unbindMethod(java.lang.String binding) throws HttpException, java.io.IOException
binding
- the server relative path of the resource to unbind
HttpException
java.io.IOException
public boolean rebindMethod(java.lang.String newBinding) throws HttpException, java.io.IOException
newBinding
- the new binding as a server relative path
HttpException
java.io.IOException
setOverwrite(boolean)
public boolean rebindMethod(java.lang.String existingBinding, java.lang.String newBinding) throws HttpException, java.io.IOException
existingBinding
- the existing binding as a server relative pathnewBinding
- the new binding as a server relative path
HttpException
java.io.IOException
setOverwrite(boolean)
public Subscription subscribeMethod(java.lang.String path, java.lang.String notificationType, java.lang.String callback, long notificationDelay, int depth, long lifetime) throws HttpException, java.io.IOException
path
- URL path of the resource that is to be subscribednotificationType
- callback
- the URL to be registered for notification, may be
null
if no callback shall be registered.notificationDelay
- depth
- the depth of the subscription (for valid values see
DepthSupport
)lifetime
- duration of that subscription in seconds (Note: the
server may change this and return an other one;
see Subscription.getLifetime()
.
Subscription
or null
if an error occurs
HttpException
java.io.IOException
public boolean subscribeMethod(java.lang.String path, int subscriptionId) throws HttpException, java.io.IOException
true
on success.
HttpException
java.io.IOException
public boolean subscribeMethod(Subscription subscription) throws HttpException, java.io.IOException
subscription
- The subscription to be refreshed.
true
on success
HttpException
java.io.IOException
public boolean unsubscribeMethod(java.lang.String path, int subscriptionId) throws HttpException, java.io.IOException
path
- URL path for that was subscribed
true
on success
HttpException
java.io.IOException
public boolean unsubscribeMethod(Subscription subscription) throws HttpException, java.io.IOException
subscription
-
true
on success
HttpException
java.io.IOException
public boolean pollMethod(java.lang.String contentLocation, int subscriptionId) throws HttpException, java.io.IOException
contentLocation
- URL path returned by the SUBSCRIBE methods
Content-Location headersubscriptionId
- id of the subscription
true
if an event was fired
HttpException
java.io.IOException
public boolean pollMethod(Subscription subscription) throws HttpException, java.io.IOException
subscription
- the subscription to ask for
true
if an event was fired
HttpException
java.io.IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |