|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IServer
Represents a WebDAV server API.
There is a one-to-one correspondence between the methods in this interface and methods in the HTTP and WebDAV protocols.
The methods all return a response object; it is the
client's responsibility to close()
the response
when they are done with it.
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.
Method Summary | |
---|---|
IResponse |
baselineControl(ILocator locator,
IContext context,
Document body)
Corresponds to the BASELINE-CONTROL method defined in the WebDAV Versioning Specification. |
IResponse |
bind(ILocator source,
ILocator destination,
IContext context)
Binds the given source locator, to the given destination. |
IResponse |
checkin(ILocator locator,
IContext context,
Document body)
Corresponds to the CHECKIN method defined in the WebDAV Versioning Specification. |
IResponse |
checkout(ILocator locator,
IContext context,
Document body)
Corresponds to the CHECKOUT method defined in the WebDAV Versioning Specification. |
IResponse |
copy(ILocator source,
ILocator destination,
IContext context,
Document body)
Copies the resource with the given locator, to the given destination. |
IResponse |
delete(ILocator locator,
IContext context)
Deletes the resource with the given locator. |
IResponse |
get(ILocator locator,
IContext context)
Gets the content of the resource with the given locator. |
IResponse |
head(ILocator locator,
IContext context)
Returns the message headers from a message send to the server. |
IResponse |
label(ILocator locator,
IContext context,
Document body)
Corresponds to the LABEL method defined in the WebDAV Versioning Specification. |
IResponse |
lock(ILocator locator,
IContext context,
Document body)
Locks the resource with the given locator. |
IResponse |
merge(ILocator locator,
IContext context,
Document body)
Corresponds to the MERGE method defined in the WebDAV Versioning Specification. |
IResponse |
mkactivity(ILocator locator,
IContext context,
Document element)
Creates an activity as specified by the given locator. |
IResponse |
mkcol(ILocator locator,
IContext context,
Document element)
Creates the collection specified by the given locator. |
IResponse |
mkworkspace(ILocator locator,
IContext context,
Document element)
Creates a workspace as specified by the given locator. |
IResponse |
move(ILocator source,
ILocator destination,
IContext context,
Document body)
Moves the resource with the given source locator, to the specified destination. |
IResponse |
options(ILocator locator,
IContext context)
Performs an options call to the server. |
IResponse |
post(ILocator locator,
IContext context,
InputStream input)
Corresponds to the POST method as defined by the HTTP/1.1 specification. |
IResponse |
propfind(ILocator locator,
IContext context,
Document body)
Performs a property find on the server. |
IResponse |
proppatch(ILocator locator,
IContext context,
Document body)
Performs a property patch call on the server. |
IResponse |
put(ILocator locator,
IContext context,
InputStream input)
Puts the given contents onto the server into the specified location. |
IResponse |
report(ILocator locator,
IContext context,
Document body)
Corresponds to the REPORT method defined in the WebDAV Versioning Specification. |
IResponse |
trace(ILocator locator,
IContext context)
Does a trace call to the server. |
IResponse |
uncheckout(ILocator locator,
IContext context)
Corresponds to the UNCHECKOUT method defined in the WebDAV Versioning Specification. |
IResponse |
unlock(ILocator locator,
IContext context)
Unlocks the resource with the given locator. |
IResponse |
update(ILocator locator,
IContext context,
Document body)
Performs an update call on the server. |
IResponse |
versionControl(ILocator locator,
IContext context,
Document body)
Corresponds to the VERSION-CONTROL method defined in the WebDAV Versioning Specification. |
Method Detail |
---|
IResponse baselineControl(ILocator locator, IContext context, Document body) throws IOException
IResponse
body is undefined.
locator
- the location of the collection to put under baseline control.context
- key-value pairings defined by the user.body
- 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.IResponse bind(ILocator source, ILocator destination, IContext context) throws IOException
source
- the location of the resourcedestination
- the location of the resource's desired parentcontext
- 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 responseIResponse checkin(ILocator locator, IContext context, Document body) throws IOException
IResponse
body is undefined.
locator
- the location of the resource to check in.context
- key-value pairings defined by the user.body
- 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.IResponse checkout(ILocator locator, IContext context, Document body) throws IOException
IResponse
body is undefined.
locator
- the location of the resourcecontext
- 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.IResponse copy(ILocator source, ILocator destination, IContext context, Document body) throws IOException
source
- the location of the resourcedestination
- the desired location of the resource copycontext
- key-value pairings as defined by the userbody
- 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 responseIResponse delete(ILocator locator, IContext context) throws IOException
locator
- the location of the resourcecontext
- 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 responseIResponse get(ILocator locator, IContext context) throws IOException
The input stream in the resulting response body should be closed by the user.
locator
- the location of the resourcecontext
- 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 responseIResponse head(ILocator locator, IContext context) throws IOException
locator
- the location of the resourcecontext
- 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 responseIResponse label(ILocator locator, IContext context, Document body) throws IOException
IResponse
body is undefined.
locator
- the location of the resourcecontext
- key-value pairings defined by the userbody
- 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 responseIResponse lock(ILocator locator, IContext context, Document body) throws IOException
locator
- the location of the resourcecontext
- key-value pairings defined by the userbody
- 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 responseIResponse merge(ILocator locator, IContext context, Document body) throws IOException
locator
- the location of the resourcecontext
- key-value pairings defined by the userbody
- 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 responseIResponse mkactivity(ILocator locator, IContext context, Document element) throws IOException
locator
- the location of the new resource.context
- key-value pairings defined by the user.element
- 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.IResponse mkcol(ILocator locator, IContext context, Document element) throws IOException
locator
- the location of the resourcecontext
- key-value pairings defined by the userelement
- XML document containing properties
close()
to the response when done with it
IOException
- if there was a problem sending the request
or receiving the responseIResponse mkworkspace(ILocator locator, IContext context, Document element) throws IOException
locator
- the location of the new resource.context
- key-value pairings defined by the user.element
- 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.IResponse move(ILocator source, ILocator destination, IContext context, Document body) throws IOException
source
- the location of the resourcedestination
- the desired location for the resourcecontext
- key-value pairing defined by the userbody
- 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 responseIResponse options(ILocator locator, IContext context) throws IOException
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 resourcecontext
- 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 responseIResponse post(ILocator locator, IContext context, InputStream input) throws IOException
The given input stream will be closed by the server after the contents have been consumed.
locator
- the location of the resourcecontext
- key-value pairings defined by the userinput
- 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 responseIResponse propfind(ILocator locator, IContext context, Document body) throws IOException
locator
- the location of the resourcecontext
- key-value pairings defined by the userbody
- 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 responseIResponse proppatch(ILocator locator, IContext context, Document body) throws IOException
locator
- the location of the resourcecontext
- key-value pairings defined by the userbody
- 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 responseIResponse put(ILocator locator, IContext context, InputStream input) throws IOException
The given input stream will be closed by the server after the contents have been consumed.
locator
- the location of the resourcecontext
- key-value pairings defined by the userinput
- 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 responseIResponse report(ILocator locator, IContext context, Document body) throws IOException
locator
- the location of the resourcecontext
- key-value pairings defined by the userbody
- 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 responseIResponse trace(ILocator locator, IContext context) throws IOException
The input stream in the response body should be closed by the user.
locator
- the location of the resourcecontext
- 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 responseIResponse uncheckout(ILocator locator, IContext context) throws IOException
locator
- the location of the resourcecontext
- 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 responseIResponse unlock(ILocator locator, IContext context) throws IOException
locator
- the location of the resourcecontext
- 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 responseIResponse update(ILocator locator, IContext context, Document body) throws IOException
locator
- the location of the version-controlled resource.context
- 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 responseIResponse versionControl(ILocator locator, IContext context, Document body) throws IOException
locator
- the location of the versionable resource.context
- 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 response
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |