Package org.apache.webdav.lib.methods
Class BindMethod
java.lang.Object
org.apache.commons.httpclient.HttpMethodBase
org.apache.webdav.lib.methods.HttpRequestBodyMethodBase
org.apache.webdav.lib.methods.XMLResponseMethodBase
org.apache.webdav.lib.methods.BindMethod
- All Implemented Interfaces:
org.apache.commons.httpclient.HttpMethod
The BIND method modifies the collection identified by the Request-URI,
by adding a new binding from the segment specified in the BIND body
to the resource identified in the BIND body.
BIND Method Example:
>> Request:
BIND /CollY HTTP/1.1
Host: www.example.com
Content-Type: text/xml; charset="utf-8"
Content-Length: xxx
invalid input: '<'?xml version="1.0" encoding="utf-8" ?>
invalid input: '<'D:bind xmlns:D="DAV:">
invalid input: '<'D:segment>bar.htmlinvalid input: '<'/D:segment>
invalid input: '<'D:href>http://www.example.com/CollX/foo.htmlinvalid input: '<'/D:href>
invalid input: '<'/D:bind>
>> Response:
HTTP/1.1 201 Created
The server added a new binding to the collection, "http://www.example.com/CollY",
associating "bar.html" with the resource identified by the URI
"http://www.example.com/CollX/foo.html". Clients can now use the URI
"http://www.example.com/CollY/bar.html", to submit requests to that resource.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase
XMLResponseMethodBase.OptionsResponse, XMLResponseMethodBase.Response, XMLResponseMethodBase.ResponseWithinMultistatus, XMLResponseMethodBase.SingleResponse -
Field Summary
FieldsFields inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase
builder, decodeResponseHrefs, responseURLsFields inherited from class org.apache.commons.httpclient.HttpMethodBase
effectiveVersion, statusLine -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddRequestHeaders(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn) Generate additional headers needed by the request.protected StringDAV requests that contain a body must override this function to generate that body.getHref()getName()booleanBy default, if there already is a binding for the specified segment in the collection, the new binding replaces the existing binding.voidvoidsetOverwrite(boolean overwrite) By default, if there already is a binding for the specified segment in the collection, the new binding replaces the existing binding.voidsetSegment(String segment) Methods inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase
convertElementToProperty, getDebug, getRequestContentLength, getResponseDocument, getResponseHashtable, getResponses, getResponseURLs, parseResponse, parseXMLResponse, readResponseBody, recycle, setDebug, setDecodeResponseHrefs, setDocument, setResponseHashtable, writeRequestBodyMethods inherited from class org.apache.webdav.lib.methods.HttpRequestBodyMethodBase
isRequestContentAlreadySet, readContinueCode, setRequestBody, setRequestBody, setRequestBody, setRequestBody, setRequestBodyMethods inherited from class org.apache.commons.httpclient.HttpMethodBase
abort, addCookieRequestHeader, addHostRequestHeader, addProxyConnectionHeader, addRequestHeader, addRequestHeader, addResponseFooter, addUserAgentRequestHeader, checkNotUsed, checkUsed, execute, generateRequestLine, getAuthenticationRealm, getContentCharSet, getDoAuthentication, getEffectiveVersion, getFollowRedirects, getHostAuthState, getHostConfiguration, getMethodRetryHandler, getParams, getPath, getProxyAuthenticationRealm, getProxyAuthState, getQueryString, getRecoverableExceptionCount, getRequestCharSet, getRequestHeader, getRequestHeaderGroup, getRequestHeaders, getRequestHeaders, getResponseBody, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaderGroup, getResponseHeaders, getResponseHeaders, getResponseStream, getResponseTrailerHeaderGroup, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isAborted, isConnectionCloseForced, isHttp11, isRequestSent, isStrictMode, processCookieHeaders, processResponseBody, processResponseHeaders, processStatusLine, readResponse, readResponseHeaders, readStatusLine, releaseConnection, removeRequestHeader, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, setFollowRedirects, setHostConfiguration, setHttp11, setMethodRetryHandler, setParams, setPath, setQueryString, setQueryString, setRequestHeader, setRequestHeader, setResponseStream, setStrictMode, setURI, shouldCloseConnection, validate, writeRequest, writeRequestHeaders, writeRequestLine
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
BindMethod
public BindMethod()Method constructor. -
BindMethod
-
-
Method Details
-
getName
- Specified by:
getNamein interfaceorg.apache.commons.httpclient.HttpMethod- Specified by:
getNamein classorg.apache.commons.httpclient.HttpMethodBase
-
setOverwrite
public void setOverwrite(boolean overwrite) By default, if there already is a binding for the specified segment in the collection, the new binding replaces the existing binding. This default binding replacement behavior can be overridden using the Overwrite header.- Parameters:
overwrite- New overwrite value
-
isOverwrite
public boolean isOverwrite()By default, if there already is a binding for the specified segment in the collection, the new binding replaces the existing binding. This default binding replacement behavior can be overridden using the Overwrite header.- Returns:
- the current value of the overwrite flag
-
addRequestHeaders
public void addRequestHeaders(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException Generate additional headers needed by the request.- Overrides:
addRequestHeadersin classorg.apache.commons.httpclient.HttpMethodBase- Parameters:
state- HttpState tokenconn- The connection being used for the request.- Throws:
IOExceptionorg.apache.commons.httpclient.HttpException
-
generateRequestBody
DAV requests that contain a body must override this function to generate that body.The default behavior simply returns an empty body.
- Overrides:
generateRequestBodyin classXMLResponseMethodBase
-
getHref
- Returns:
- path of the resource to be bound
-
getSegment
- Returns:
- new resource name
-
setHref
- Parameters:
href- path of the resource to be bound
-
setSegment
- Parameters:
segment- new resource name
-