Package org.apache.webdav.lib.methods
Class MoveMethod
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.MoveMethod
- All Implemented Interfaces:
org.apache.commons.httpclient.HttpMethod
MOVE Method.
-
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
Fields inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase
builder, decodeResponseHrefs, responseURLs
Fields inherited from class org.apache.commons.httpclient.HttpMethodBase
effectiveVersion, statusLine
-
Constructor Summary
ConstructorsConstructorDescriptionMethod constructor.MoveMethod
(String source) Method constructor.MoveMethod
(String source, String destination) Method constructor.MoveMethod
(String source, String destination, boolean overwrite) Method constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addRequestHeaders
(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn) Generate additional headers needed by the request.(package private) static String
getAbsoluteDestination
(org.apache.commons.httpclient.HttpConnection conn, String absolutePathOrURL) A client of theMoveMethod
can specify a destination as either an absolute URL (possibly to a different server), or as a absolute path on the same server, but this function makes sure that the path sent to the server is always an absolute URL.Destination getter.getName()
boolean
Overwrite getter.boolean
Overwrite getter.void
setDestination
(String destination) Destination setter.void
setOverwrite
(boolean overwrite) Overwrite setter.void
setRequestHeader
(String headerName, String headerValue) Set a header value, redirecting the special case of the Overwrite and Destination headers tosetOverwrite(boolean)
andsetDestination(java.lang.String)
as appropriate.Methods inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase
convertElementToProperty, generateRequestBody, getDebug, getRequestContentLength, getResponseDocument, getResponseHashtable, getResponses, getResponseURLs, parseResponse, parseXMLResponse, readResponseBody, recycle, setDebug, setDecodeResponseHrefs, setDocument, setResponseHashtable, writeRequestBody
Methods inherited from class org.apache.webdav.lib.methods.HttpRequestBodyMethodBase
isRequestContentAlreadySet, readContinueCode, setRequestBody, setRequestBody, setRequestBody, setRequestBody, setRequestBody
Methods 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, setResponseStream, setStrictMode, setURI, shouldCloseConnection, validate, writeRequest, writeRequestHeaders, writeRequestLine
-
Constructor Details
-
MoveMethod
public MoveMethod()Method constructor. -
MoveMethod
Method constructor. -
MoveMethod
Method constructor. -
MoveMethod
Method constructor.
-
-
Method Details
-
setRequestHeader
Set a header value, redirecting the special case of the Overwrite and Destination headers tosetOverwrite(boolean)
andsetDestination(java.lang.String)
as appropriate.- Specified by:
setRequestHeader
in interfaceorg.apache.commons.httpclient.HttpMethod
- Overrides:
setRequestHeader
in classorg.apache.commons.httpclient.HttpMethodBase
- Parameters:
headerName
- Header nameheaderValue
- Header value
-
setDestination
Destination setter.- Parameters:
destination
- New destination value
-
getDestination
Destination getter.- Returns:
- String destination value
-
setOverwrite
public void setOverwrite(boolean overwrite) Overwrite setter.- Parameters:
overwrite
- New overwrite value
-
isOverwrite
public boolean isOverwrite()Overwrite getter.- Returns:
- boolean Overwrite value
-
getOverwrite
public boolean getOverwrite()Overwrite getter.- Returns:
- boolean Overwrite value
-
getName
- Specified by:
getName
in interfaceorg.apache.commons.httpclient.HttpMethod
- Specified by:
getName
in classorg.apache.commons.httpclient.HttpMethodBase
-
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:
addRequestHeaders
in classorg.apache.commons.httpclient.HttpMethodBase
- Parameters:
state
- State tokenconn
- The connection being used to make the request.- Throws:
IOException
org.apache.commons.httpclient.HttpException
-
getAbsoluteDestination
static String getAbsoluteDestination(org.apache.commons.httpclient.HttpConnection conn, String absolutePathOrURL) A client of theMoveMethod
can specify a destination as either an absolute URL (possibly to a different server), or as a absolute path on the same server, but this function makes sure that the path sent to the server is always an absolute URL.Note that this function will add server and port to the request - however, port is not added if it is the default port for the scheme in question.
This function is static so that it can be reused by the
CopyMethod
.- Parameters:
conn
- The connection for the current request, in case the caller specifies an absolute path.absolutePathOrURL
- If an absolute URL, nothing done, but if an absolute path, it is converted into an absolute URL.- Returns:
- An absolute URL
-