org.apache.webdav.lib.methods
Class CopyMethod

java.lang.Object
  extended byorg.apache.commons.httpclient.HttpMethodBase
      extended byorg.apache.webdav.lib.methods.HttpRequestBodyMethodBase
          extended byorg.apache.webdav.lib.methods.XMLResponseMethodBase
              extended byorg.apache.webdav.lib.methods.CopyMethod
All Implemented Interfaces:
HttpMethod

public class CopyMethod
extends XMLResponseMethodBase

COPY Method.


Nested Class Summary
 
Nested classes 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, responseURLs
 
Fields inherited from class org.apache.commons.httpclient.HttpMethodBase
USER_AGENT
 
Constructor Summary
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
 void addRequestHeaders(HttpState state, 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, 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
addAuthorizationRequestHeader, addContentLengthRequestHeader, addCookieRequestHeader, addHostRequestHeader, addProxyAuthorizationRequestHeader, addProxyConnectionHeader, addRequestHeader, addRequestHeader, addResponseFooter, addUserAgentRequestHeader, checkNotUsed, checkUsed, execute, fakeResponse, generateRequestLine, getAuthenticationRealm, getContentCharSet, getDoAuthentication, getFollowRedirects, getHostConfiguration, getMethodRetryHandler, getPath, getProxyAuthenticationRealm, getQueryString, getRecoverableExceptionCount, getRequestCharSet, getRequestHeader, getRequestHeaderGroup, getRequestHeaders, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaderGroup, getResponseHeaders, getResponseStream, getResponseTrailerHeaderGroup, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isConnectionCloseForced, isHttp11, isStrictMode, processResponseBody, processResponseHeaders, processStatusLine, readResponse, readResponseHeaders, readStatusLine, releaseConnection, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, setFollowRedirects, setHostConfiguration, setHttp11, setMethodRetryHandler, setPath, setQueryString, setQueryString, setRequestHeader, setResponseStream, setStrictMode, 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.

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()

addRequestHeaders

public void addRequestHeaders(HttpState state,
                              HttpConnection conn)
                       throws java.io.IOException,
                              HttpException
Generate additional headers needed by the request.

Parameters:
state - HttpState token
conn - The connection being used for the request.
Throws:
java.io.IOException
HttpException