org.apache.webdav.lib.methods

Class UnlockMethod

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

All Implemented Interfaces:

org.apache.commons.httpclient.HttpMethod

public class UnlockMethod
extends XMLResponseMethodBase

UNLOCK 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

Modifier and Type	Field and Description
static int	ABORT_TRANSACTION
static int	COMMIT_TRANSACTION
static int	NO_TRANSACTION

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 and Description
UnlockMethod() Method constructor.
UnlockMethod(java.lang.String path) Method constructor.
UnlockMethod(java.lang.String path, java.lang.String lockToken) Method constructor.
UnlockMethod(java.lang.String path, java.lang.String txHandle, int transactionStatus) Creates an unlock method that ends a transaction when server supports them in a MS like style.

Method Summary

Modifier and Type	Method and Description
void	addRequestHeaders(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn) Generate additional headers needed by the request.
protected java.lang.String	generateRequestBody() DAV requests that contain a body must override this function to generate that body.
java.lang.String	getName()
int	getTransactionStatus() Gets the parameter described in setTransactionStatus(int).
protected void	processResponseBody(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)
void	recycle() Reset the State of the class to its initial state, so that it can be used again.
void	setLockToken(java.lang.String lockToken)
void	setRequestHeader(java.lang.String headerName, java.lang.String headerValue) Set header, handling the special case of the lock-token header so that it calls setLockToken(java.lang.String) instead.
void	setTransactionStatus(int transactionStatus) Sets the transaction status of this method when it is used to end a externally controlled transaction.

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

convertElementToProperty, getDebug, getRequestContentLength, getResponseDocument, getResponseHashtable, getResponses, getResponseURLs, parseResponse, parseXMLResponse, readResponseBody, 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, 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

Field Detail

NO_TRANSACTION

public static final int NO_TRANSACTION

See Also:

Constant Field Values

ABORT_TRANSACTION

public static final int ABORT_TRANSACTION

See Also:

Constant Field Values

COMMIT_TRANSACTION

public static final int COMMIT_TRANSACTION

See Also:

Constant Field Values

Constructor Detail

UnlockMethod

public UnlockMethod(java.lang.String path,
                    java.lang.String txHandle,
                    int transactionStatus)

Creates an unlock method that ends a transaction when server supports them in a MS like style. The transacion handle of transaction is stored as the lock token.

To start a transaction use LockMethod.

Parameters:

path - any path inside Slide's scope

txHandle - lock token specifying transaction handle

transactionStatus - status of transaction as described in setTransactionStatus(int)

UnlockMethod

public UnlockMethod()

Method constructor.

UnlockMethod

public UnlockMethod(java.lang.String path)

Method constructor.

UnlockMethod

public UnlockMethod(java.lang.String path,
                    java.lang.String lockToken)

Method constructor.

Method Detail

setLockToken

public void setLockToken(java.lang.String lockToken)

getTransactionStatus

public int getTransactionStatus()

Gets the parameter described in setTransactionStatus(int).

Returns:

either COMMIT_TRANSACTION or ABORT_TRANSACTION as the real transaction status or NO_TRANSACTION to indicate this method is not used for transaction control

setTransactionStatus

public void setTransactionStatus(int transactionStatus)

Sets the transaction status of this method when it is used to end a externally controlled transaction.

Parameters:

transactionStatus - COMMIT_TRANSACTION to set the status to successful commit or ABORT_TRANSACTION to let the transaction abort discarding all changes associated to it.

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

recycle

public void recycle()

Description copied from class: XMLResponseMethodBase

Reset the State of the class to its initial state, so that it can be used again.

Specified by:

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

Overrides:

recycle in class XMLResponseMethodBase

setRequestHeader

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

Set header, handling the special case of the lock-token header so that it calls setLockToken(java.lang.String) instead.

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

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 to send the request.

Throws:

java.io.IOException

org.apache.commons.httpclient.HttpException

generateRequestBody

protected java.lang.String generateRequestBody()

Description copied from class: XMLResponseMethodBase

DAV requests that contain a body must override this function to generate that body.

The default behavior simply returns an empty body.

Overrides:

generateRequestBody in class XMLResponseMethodBase

processResponseBody

protected void processResponseBody(org.apache.commons.httpclient.HttpState state,
                                   org.apache.commons.httpclient.HttpConnection conn)

Overrides:

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