public class UnlockMethod extends XMLResponseMethodBase
XMLResponseMethodBase.OptionsResponse, XMLResponseMethodBase.Response, XMLResponseMethodBase.ResponseWithinMultistatus, XMLResponseMethodBase.SingleResponse
Modifier and Type | Field and Description |
---|---|
static int |
ABORT_TRANSACTION |
static int |
COMMIT_TRANSACTION |
static int |
NO_TRANSACTION |
builder, decodeResponseHrefs, responseURLs
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.
|
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.
|
convertElementToProperty, getDebug, getRequestContentLength, getResponseDocument, getResponseHashtable, getResponses, getResponseURLs, parseResponse, parseXMLResponse, readResponseBody, setDebug, setDecodeResponseHrefs, setDocument, setResponseHashtable, writeRequestBody
isRequestContentAlreadySet, readContinueCode, setRequestBody, setRequestBody, setRequestBody, setRequestBody, setRequestBody
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
public static final int NO_TRANSACTION
public static final int ABORT_TRANSACTION
public static final int COMMIT_TRANSACTION
public UnlockMethod(java.lang.String path, java.lang.String txHandle, int transactionStatus)
LockMethod
.path
- any path inside Slide's scopetxHandle
- lock token specifying transaction handletransactionStatus
- status of transaction as described in setTransactionStatus(int)
public UnlockMethod()
public UnlockMethod(java.lang.String path)
public UnlockMethod(java.lang.String path, java.lang.String lockToken)
public void setLockToken(java.lang.String lockToken)
public int getTransactionStatus()
setTransactionStatus(int)
.COMMIT_TRANSACTION
or ABORT_TRANSACTION
as the real
transaction status or NO_TRANSACTION
to indicate this method is not used for
transaction controlpublic void setTransactionStatus(int transactionStatus)
transactionStatus
- COMMIT_TRANSACTION
to set the status to successful commit or
ABORT_TRANSACTION
to let the transaction abort discarding all changes associated to it.public java.lang.String getName()
getName
in interface org.apache.commons.httpclient.HttpMethod
getName
in class org.apache.commons.httpclient.HttpMethodBase
public void recycle()
XMLResponseMethodBase
recycle
in interface org.apache.commons.httpclient.HttpMethod
recycle
in class XMLResponseMethodBase
public void setRequestHeader(java.lang.String headerName, java.lang.String headerValue)
setLockToken(java.lang.String)
instead.setRequestHeader
in interface org.apache.commons.httpclient.HttpMethod
setRequestHeader
in class org.apache.commons.httpclient.HttpMethodBase
headerName
- Header nameheaderValue
- Header valuepublic void addRequestHeaders(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn) throws java.io.IOException, org.apache.commons.httpclient.HttpException
addRequestHeaders
in class org.apache.commons.httpclient.HttpMethodBase
state
- HttpState tokenconn
- The connection being used to send the request.java.io.IOException
org.apache.commons.httpclient.HttpException
protected java.lang.String generateRequestBody()
XMLResponseMethodBase
The default behavior simply returns an empty body.
generateRequestBody
in class XMLResponseMethodBase
protected void processResponseBody(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)
processResponseBody
in class org.apache.commons.httpclient.HttpMethodBase