org.apache.webdav.lib.methods

Class MoveMethod


public class MoveMethod
extends XMLResponseMethodBase

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

Constructor Summary

MoveMethod()
Method constructor.
MoveMethod(String source)
Method constructor.
MoveMethod(String source, String destination)
Method constructor.
MoveMethod(String source, String destination, boolean overwrite)
Method constructor.

Method Summary

void
addRequestHeaders(HttpState state, HttpConnection conn)
Generate additional headers needed by the request.
(package private) static String
getAbsoluteDestination(HttpConnection conn, String absolutePathOrURL)
A client of the MoveMethod 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.
String
getDestination()
Destination getter.
String
getName()
boolean
getOverwrite()
Overwrite getter.
boolean
isOverwrite()
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 to setOverwrite(boolean) and setDestination(String) as appropriate.

Methods inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase

convertElementToProperty, generateRequestBody, getDebug, getRequestContentLength, getResponseDocument, getResponseHashtable, getResponseURLs, getResponses, parseResponse, parseXMLResponse, readResponseBody, recycle, setDebug, setDecodeResponseHrefs, setDocument, setResponseHashtable, writeRequestBody

Methods inherited from class org.apache.webdav.lib.methods.HttpRequestBodyMethodBase

getRequestContentLength, isRequestContentAlreadySet, readContinueCode, recycle, setRequestBody, setRequestBody, setRequestBody, setRequestBody, setRequestBody, writeRequestBody

Constructor Details

MoveMethod

public MoveMethod()
Method constructor.

MoveMethod

public MoveMethod(String source)
Method constructor.

MoveMethod

public MoveMethod(String source,
                  String destination)
Method constructor.

MoveMethod

public MoveMethod(String source,
                  String destination,
                  boolean overwrite)
Method constructor.

Method Details

addRequestHeaders

public void addRequestHeaders(HttpState state,
                              HttpConnection conn)
            throws IOException,
                   HttpException
Generate additional headers needed by the request.
Parameters:
state - State token
conn - The connection being used to make the request.

getAbsoluteDestination

(package private) static String getAbsoluteDestination(HttpConnection conn,
                                                       String absolutePathOrURL)
A client of the MoveMethod 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

getDestination

public String getDestination()
Destination getter.
Returns:
String destination value

getName

public String getName()

getOverwrite

public boolean getOverwrite()
Overwrite getter.
Returns:
boolean Overwrite value

isOverwrite

public boolean isOverwrite()
Overwrite getter.
Returns:
boolean Overwrite value

setDestination

public void setDestination(String destination)
Destination setter.
Parameters:
destination - New destination value

setOverwrite

public void setOverwrite(boolean overwrite)
Overwrite setter.
Parameters:
overwrite - New overwrite value

setRequestHeader

public void setRequestHeader(String headerName,
                             String headerValue)
Parameters:
headerName - Header name
headerValue - Header value