|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.webdav.client.DAVClient
org.eclipse.webdav.client.RemoteDAVClient
public class RemoteDAVClient
The ServerProxy
class implements the IServer
interface and represents a client's local proxy to a remote server.
This object is used to talk with the server.
Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
Field Summary | |
---|---|
protected HttpClient |
httpClient
|
Fields inherited from class org.eclipse.webdav.client.DAVClient |
---|
davFactory |
Constructor Summary | |
---|---|
RemoteDAVClient(RemoteDAVClient davClient)
Creates a new remote DAV client from a clone of the given remote DAV client. |
|
RemoteDAVClient(WebDAVFactory webDAVFactory,
HttpClient httpClient)
Creates a new remote DAV client. |
Method Summary | |
---|---|
IResponse |
baselineControl(ILocator locator,
IContext userContext,
Document document)
Corresponds to the BASELINE-CONTROL method defined in the WebDAV Versioning Specification. |
IResponse |
bind(ILocator source,
ILocator destination,
IContext userContext)
Binds the given source locator, to the given destination. |
IResponse |
checkin(ILocator locator,
IContext userContext,
Document document)
Corresponds to the CHECKIN method defined in the WebDAV Versioning Specification. |
IResponse |
checkout(ILocator locator,
IContext userContext,
Document body)
Corresponds to the CHECKOUT method defined in the WebDAV Versioning Specification. |
protected Object |
clone()
|
void |
close()
Close down the client for futire API calls. |
IResponse |
copy(ILocator source,
ILocator destination,
IContext userContext,
Document document)
Copies the resource with the given locator, to the given destination. |
IResponse |
delete(ILocator locator,
IContext userContext)
Deletes the resource with the given locator. |
IResponse |
get(ILocator locator,
IContext userContext)
Gets the content of the resource with the given locator. |
HttpClient |
getHttpClient()
Returns this DAV clients HTTP client. |
IResponse |
head(ILocator locator,
IContext userContext)
Returns the message headers from a message send to the server. |
IResponse |
label(ILocator locator,
IContext userContext,
Document document)
Corresponds to the LABEL method defined in the WebDAV Versioning Specification. |
IResponse |
lock(ILocator locator,
IContext userContext,
Document document)
Locks the resource with the given locator. |
IResponse |
merge(ILocator locator,
IContext userContext,
Document document)
Corresponds to the MERGE method defined in the WebDAV Versioning Specification. |
IResponse |
mkactivity(ILocator locator,
IContext userContext,
Document document)
Creates an activity as specified by the given locator. |
IResponse |
mkcol(ILocator locator,
IContext userContext,
Document document)
Creates the collection specified by the given locator. |
IResponse |
mkworkspace(ILocator locator,
IContext userContext,
Document document)
Creates a workspace as specified by the given locator. |
IResponse |
move(ILocator source,
ILocator destination,
IContext userContext,
Document document)
Moves the resource with the given source locator, to the specified destination. |
IResponse |
options(ILocator locator,
IContext userContext)
Performs an options call to the server. |
IResponse |
post(ILocator locator,
IContext userContext,
InputStream is)
Corresponds to the POST method as defined by the HTTP/1.1 specification. |
IResponse |
propfind(ILocator locator,
IContext userContext,
Document document)
Performs a property find on the server. |
IResponse |
proppatch(ILocator locator,
IContext userContext,
Document document)
Performs a property patch call on the server. |
IResponse |
put(ILocator locator,
IContext userContext,
InputStream is)
Puts the given contents onto the server into the specified location. |
IResponse |
report(ILocator locator,
IContext userContext,
Document document)
Corresponds to the REPORT method defined in the WebDAV Versioning Specification. |
IResponse |
trace(ILocator locator,
IContext userContext)
Does a trace call to the server. |
IResponse |
uncheckout(ILocator locator,
IContext userContext)
Corresponds to the UNCHECKOUT method defined in the WebDAV Versioning Specification. |
IResponse |
unlock(ILocator locator,
IContext userContext)
Unlocks the resource with the given locator. |
IResponse |
update(ILocator locator,
IContext userContext,
Document body)
Performs an update call on the server. |
IResponse |
versionControl(ILocator locator,
IContext userContext,
Document body)
Corresponds to the VERSION-CONTROL method defined in the WebDAV Versioning Specification. |
Methods inherited from class org.eclipse.webdav.client.DAVClient |
---|
getDAVFactory, newContext |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected HttpClient httpClient
Constructor Detail |
---|
public RemoteDAVClient(RemoteDAVClient davClient)
davClient
- the DAV client to clonepublic RemoteDAVClient(WebDAVFactory webDAVFactory, HttpClient httpClient)
webDAVFactory
- Method Detail |
---|
public IResponse baselineControl(ILocator locator, IContext userContext, Document document) throws IOException
IServer
IResponse
body is undefined.
locator
- the location of the collection to put under baseline control.userContext
- key-value pairings defined by the user.document
- the DOM document for the DAV:baseline element.
close()
to the response when done with it.
IOException
- if there was a problem sending the request
or receiving the response.IServer.baselineControl(ILocator, IContext, Document)
public IResponse bind(ILocator source, ILocator destination, IContext userContext) throws IOException
IServer
source
- the location of the resourcedestination
- the location of the resource's desired parentuserContext
- key-value pairings as set by the user
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.bind(ILocator, ILocator, IContext)
public IResponse checkin(ILocator locator, IContext userContext, Document document) throws IOException
IServer
IResponse
body is undefined.
locator
- the location of the resource to check in.userContext
- key-value pairings defined by the user.document
- DOM document for DAV:checkin.
close()
to the response when done with it.
IOException
- if there was a problem sending the request
or receiving the response.IServer.checkin(ILocator, IContext, Document)
public IResponse checkout(ILocator locator, IContext userContext, Document body) throws IOException
IServer
IResponse
body is undefined.
locator
- the location of the resourceuserContext
- key-value pairings defined by the userbody
- the XML elements that describe the parameters
of the checkout in a DAV:checkout element.
close()
to the response when done with it.
IOException
- if there was a problem sending the request
or receiving the response.IServer.checkout(ILocator, IContext, Document)
protected Object clone()
clone
in class DAVClient
Object.clone()
public void close()
close
in class DAVClient
public IResponse copy(ILocator source, ILocator destination, IContext userContext, Document document) throws IOException
IServer
source
- the location of the resourcedestination
- the desired location of the resource copyuserContext
- key-value pairings as defined by the userdocument
- XML document describing the properties to copy
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.copy(ILocator, ILocator, IContext, Document)
public IResponse delete(ILocator locator, IContext userContext) throws IOException
IServer
locator
- the location of the resourceuserContext
- key-value pairings as defined by the user
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.delete(ILocator, IContext)
public IResponse get(ILocator locator, IContext userContext) throws IOException
IServer
The input stream in the resulting response body should be closed by the user.
locator
- the location of the resourceuserContext
- key-value pairings as defined by the user
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.get(ILocator, IContext)
public HttpClient getHttpClient()
public IResponse head(ILocator locator, IContext userContext) throws IOException
IServer
locator
- the location of the resourceuserContext
- key-value pairings as defined by the user
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.head(ILocator, IContext)
public IResponse label(ILocator locator, IContext userContext, Document document) throws IOException
IServer
IResponse
body is undefined.
locator
- the location of the resourceuserContext
- key-value pairings defined by the userdocument
- DOM document for DAV:label element
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.label(ILocator, IContext, Document)
public IResponse lock(ILocator locator, IContext userContext, Document document) throws IOException
IServer
locator
- the location of the resourceuserContext
- key-value pairings defined by the userdocument
- XML document containing lock information
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.lock(ILocator, IContext, Document)
public IResponse merge(ILocator locator, IContext userContext, Document document) throws IOException
IServer
locator
- the location of the resourceuserContext
- key-value pairings defined by the userdocument
- XML document containing MERGE parameters
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.merge(ILocator, IContext, Document)
public IResponse mkactivity(ILocator locator, IContext userContext, Document document) throws IOException
IServer
locator
- the location of the new resource.userContext
- key-value pairings defined by the user.document
- an undefined XML body document.
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the response.IServer.mkactivity(ILocator, IContext, Document)
public IResponse mkcol(ILocator locator, IContext userContext, Document document) throws IOException
IServer
locator
- the location of the resourceuserContext
- key-value pairings defined by the userdocument
- XML document containing properties
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.mkcol(ILocator, IContext, Document)
public IResponse mkworkspace(ILocator locator, IContext userContext, Document document) throws IOException
IServer
locator
- the location of the new resource.userContext
- key-value pairings defined by the user.document
- an undefined XML body document.
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the response.IServer.mkworkspace(ILocator, IContext, Document)
public IResponse move(ILocator source, ILocator destination, IContext userContext, Document document) throws IOException
IServer
source
- the location of the resourcedestination
- the desired location for the resourceuserContext
- key-value pairing defined by the userdocument
- XML document specifying the properties to move
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.move(ILocator, ILocator, IContext, Document)
public IResponse options(ILocator locator, IContext userContext) throws IOException
IServer
Corresponds to the OPTIONS method as defined by the HTTP/1.1 Specification.
If the resource URL (in the locator) is "*", the server's general capabilities are queried.
locator
- the location of the resourceuserContext
- key-value pairings defined by the user
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.options(ILocator, IContext)
public IResponse post(ILocator locator, IContext userContext, InputStream is) throws IOException
IServer
The given input stream will be closed by the server after the contents have been consumed.
locator
- the location of the resourceuserContext
- key-value pairings defined by the useris
- the input stream containing the resource data
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.post(ILocator, IContext, InputStream)
public IResponse propfind(ILocator locator, IContext userContext, Document document) throws IOException
IServer
locator
- the location of the resourceuserContext
- key-value pairings defined by the userdocument
- XML document as defined by the spec
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.propfind(ILocator, IContext, Document)
public IResponse proppatch(ILocator locator, IContext userContext, Document document) throws IOException
IServer
locator
- the location of the resourceuserContext
- key-value pairings defined by the userdocument
- XML document as defined by the spec
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.proppatch(ILocator, IContext, Document)
public IResponse put(ILocator locator, IContext userContext, InputStream is) throws IOException
IServer
The given input stream will be closed by the server after the contents have been consumed.
locator
- the location of the resourceuserContext
- key-value pairings defined by the useris
- the input stream containing the resource data
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.put(ILocator, IContext, InputStream)
public IResponse report(ILocator locator, IContext userContext, Document document) throws IOException
IServer
locator
- the location of the resourceuserContext
- key-value pairings defined by the userdocument
- XML document containing REPORT parameters
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.report(ILocator, IContext, Document)
public IResponse trace(ILocator locator, IContext userContext) throws IOException
IServer
The input stream in the response body should be closed by the user.
locator
- the location of the resourceuserContext
- key-value pairings defined by the user
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.trace(ILocator, IContext)
public IResponse uncheckout(ILocator locator, IContext userContext) throws IOException
IServer
locator
- the location of the resourceuserContext
- key-value pairings defined by the user
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.uncheckout(ILocator, IContext)
public IResponse unlock(ILocator locator, IContext userContext) throws IOException
IServer
locator
- the location of the resourceuserContext
- key-value pairings defined by the user
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.unlock(ILocator, IContext)
public IResponse update(ILocator locator, IContext userContext, Document body) throws IOException
IServer
locator
- the location of the version-controlled resource.userContext
- key-value pairings defined by the client.body
- DAV:update XML document as defined by the spec.
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.update(ILocator, IContext, Document)
public IResponse versionControl(ILocator locator, IContext userContext, Document body) throws IOException
IServer
locator
- the location of the versionable resource.userContext
- key-value pairings defined by the user.body
- the request body elements as a DOM document.
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIServer.versionControl(ILocator, IContext, Document)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |