Package org.apache.webdav.lib.methods

Class CopyMethod

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.CopyMethod

All Implemented Interfaces:

org.apache.commons.httpclient.HttpMethod

public class CopyMethod
extends XMLResponseMethodBase

COPY 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

Constructors

Constructor	Description
CopyMethod()	Method constructor.
CopyMethod(java.lang.String source)	Method constructor.
CopyMethod(java.lang.String source, java.lang.String destination)	Method constructor.
CopyMethod(java.lang.String source, java.lang.String destination, boolean overwrite)	Method constructor.
CopyMethod(java.lang.String source, java.lang.String destination, boolean overwrite, int depth)

Method Summary

Modifier and Type	Method	Description
void	addRequestHeaders(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)	Generate additional headers needed by the request.
int	getDepth()	Depth getter.
java.lang.String	getDestination()	Destination getter.
java.lang.String	getName()
boolean	getOverwrite()	Overwrite getter.
boolean	isOverwrite()	Overwrite getter.
void	setDepth(int depth)	Depth setter.
void	setDestination(java.lang.String destination)	Destination setter.
void	setOverwrite(boolean overwrite)	Overwrite setter.
void	setRequestHeader(java.lang.String headerName, java.lang.String headerValue)	Set a header value, redirecting the special case of Overwrite and Destination headers to setOverwrite(boolean) and setDestination(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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CopyMethod

public CopyMethod()

Method constructor.

CopyMethod

public CopyMethod(java.lang.String source)

Method constructor.

CopyMethod

public CopyMethod(java.lang.String source,
                  java.lang.String destination)

Method constructor.

CopyMethod

public CopyMethod(java.lang.String source,
                  java.lang.String destination,
                  boolean overwrite)

Method constructor.

CopyMethod

public CopyMethod(java.lang.String source,
                  java.lang.String destination,
                  boolean overwrite,
                  int depth)

Method Detail

setRequestHeader

public void setRequestHeader(java.lang.String headerName,
                             java.lang.String headerValue)

Set a header value, redirecting the special case of Overwrite and Destination headers to setOverwrite(boolean) and setDestination(java.lang.String) as appropriate.

Specified by:

setRequestHeader in interface org.apache.commons.httpclient.HttpMethod

Overrides:

setRequestHeader in class org.apache.commons.httpclient.HttpMethodBase

Parameters:

headerName - Header name

headerValue - Header value

setDestination

public void setDestination(java.lang.String destination)

Destination setter.

Parameters:

destination - New destination value

getDestination

public java.lang.String 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

setDepth

public void setDepth(int depth)

Depth setter.

Parameters:

depth - New depth value

getDepth

public int getDepth()

Depth getter.

Returns:

int Depth value

getName

public java.lang.String getName()

Specified by:

getName in interface org.apache.commons.httpclient.HttpMethod

Specified by:

getName in class org.apache.commons.httpclient.HttpMethodBase

addRequestHeaders

public void addRequestHeaders(org.apache.commons.httpclient.HttpState state,
                              org.apache.commons.httpclient.HttpConnection conn)
                       throws java.io.IOException,
                              org.apache.commons.httpclient.HttpException

Generate additional headers needed by the request.

Overrides:

addRequestHeaders in class org.apache.commons.httpclient.HttpMethodBase

Parameters:

state - HttpState token

conn - The connection being used for the request.

Throws:

java.io.IOException

org.apache.commons.httpclient.HttpException