|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.httpclient.HttpMethodBase
org.apache.commons.httpclient.methods.ExpectContinueMethod
org.apache.commons.httpclient.methods.EntityEnclosingMethod
org.apache.jackrabbit.webdav.client.methods.DavMethodBase
public abstract class DavMethodBase
DavMethodBase
...
Field Summary |
---|
Fields inherited from class org.apache.commons.httpclient.methods.EntityEnclosingMethod |
---|
CONTENT_LENGTH_AUTO, CONTENT_LENGTH_CHUNKED |
Constructor Summary | |
---|---|
DavMethodBase(String uri)
|
Method Summary | |
---|---|
void |
addRequestHeader(Header header)
Adds the specified request header , NOT overwriting any
previous value. |
void |
checkSuccess()
|
abstract String |
getName()
Reset method to 'abstract' in order to force subclasses to change the name (inherited value is GetMethod.getName() ). |
Document |
getResponseBodyAsDocument()
Parse the response body into an Xml Document . |
MultiStatus |
getResponseBodyAsMultiStatus()
Return the response body as MultiStatus object. |
DavException |
getResponseException()
Builds a DavException for the status line and the DAV:error element that may be present in the response body. |
protected boolean |
getSuccess()
|
protected abstract boolean |
isSuccess(int statusCode)
|
protected void |
processMultiStatusBody(MultiStatus multiStatus,
org.apache.commons.httpclient.HttpState httpState,
org.apache.commons.httpclient.HttpConnection httpConnection)
This method is invoked during the processResponseBody(HttpState, HttpConnection) ,
which in this implementation parses the response body into a MultiStatus
object if the status code indicates 207 (MultiStatus).Subclasses may want to override this method in order to apply specific validation of the multi-status. This implementation does nothing. |
protected void |
processResponseBody(org.apache.commons.httpclient.HttpState httpState,
org.apache.commons.httpclient.HttpConnection httpConnection)
In case of a MultiStatus response code, this method parses the response body and resets the 'success' flag depending on the multistatus content, which could indicate method failure as well. |
protected void |
processStatusLine(org.apache.commons.httpclient.HttpState httpState,
org.apache.commons.httpclient.HttpConnection httpConnection)
|
void |
setRequestBody(Document requestBody)
|
void |
setRequestBody(XmlSerializable requestBody)
|
void |
setRequestHeader(Header header)
Set the specified request header, overwriting any previous value. |
protected void |
setSuccess(boolean success)
|
boolean |
succeeded()
|
Methods inherited from class org.apache.commons.httpclient.methods.EntityEnclosingMethod |
---|
addContentLengthRequestHeader, addRequestHeaders, clearRequestBody, generateRequestBody, generateRequestEntity, getFollowRedirects, getRequestCharSet, getRequestContentLength, getRequestEntity, hasRequestContent, recycle, setContentChunked, setFollowRedirects, setRequestBody, setRequestBody, setRequestContentLength, setRequestContentLength, setRequestEntity, writeRequestBody |
Methods inherited from class org.apache.commons.httpclient.methods.ExpectContinueMethod |
---|
getUseExpectHeader, setUseExpectHeader |
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, getHostAuthState, getHostConfiguration, getMethodRetryHandler, getParams, getPath, getProxyAuthenticationRealm, getProxyAuthState, getQueryString, getRecoverableExceptionCount, getRequestHeader, getRequestHeaderGroup, getRequestHeaders, getRequestHeaders, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaderGroup, getResponseHeaders, getResponseHeaders, getResponseStream, getResponseTrailerHeaderGroup, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isAborted, isConnectionCloseForced, isHttp11, isRequestSent, isStrictMode, processResponseHeaders, readResponse, readResponseBody, readResponseHeaders, readStatusLine, releaseConnection, removeRequestHeader, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, setHostConfiguration, setHttp11, setMethodRetryHandler, setParams, setPath, setQueryString, setQueryString, setRequestHeader, 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 |
Methods inherited from interface org.apache.commons.httpclient.HttpMethod |
---|
abort, addRequestHeader, addRequestHeader, addResponseFooter, execute, getDoAuthentication, getFollowRedirects, getHostAuthState, getHostConfiguration, getParams, getPath, getProxyAuthState, getQueryString, getRequestHeader, getRequestHeaders, getRequestHeaders, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaders, getResponseHeaders, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isRequestSent, isStrictMode, recycle, releaseConnection, removeRequestHeader, removeRequestHeader, setDoAuthentication, setFollowRedirects, setParams, setPath, setQueryString, setQueryString, setRequestHeader, setRequestHeader, setStrictMode, setURI, validate |
Constructor Detail |
---|
public DavMethodBase(String uri)
Method Detail |
---|
public abstract String getName()
GetMethod.getName()
).
getName
in interface org.apache.commons.httpclient.HttpMethod
getName
in class org.apache.commons.httpclient.HttpMethodBase
HttpMethod.getName()
public void addRequestHeader(Header header)
DavMethod
request header
, NOT overwriting any
previous value. Note that header-name matching is case insensitive.
addRequestHeader
in interface DavMethod
DavMethod.addRequestHeader(Header)
public void setRequestHeader(Header header)
DavMethod
setRequestHeader
in interface DavMethod
DavMethod.setRequestHeader(Header)
public MultiStatus getResponseBodyAsMultiStatus() throws IOException, DavException
DavMethod
MultiStatus
object.
getResponseBodyAsMultiStatus
in interface DavMethod
IOException
- if the response body could not be parsed
DavException
- if the status code is other than MultiStatus or if
obtaining the response XML document failsDavMethod.getResponseBodyAsMultiStatus()
public Document getResponseBodyAsDocument() throws IOException
DavMethod
Document
.
getResponseBodyAsDocument
in interface DavMethod
null
if the response stream is
null
.
IOException
- If an I/O (transport) problem occurs while obtaining
the response body of if the XML parsing fails.DavMethod.getResponseBodyAsDocument()
public DavException getResponseException() throws IOException
DavMethod
null
will be returned.
getResponseException
in interface DavMethod
null
if this method did not result
in an error.
IOException
DavMethod.getResponseException()
public void checkSuccess() throws DavException, IOException
checkSuccess
in interface DavMethod
DavException
IOException
DavMethod.checkSuccess()
public boolean succeeded()
succeeded
in interface DavMethod
DavMethod.succeeded()
public void setRequestBody(Document requestBody) throws IOException
requestBody
-
IOException
public void setRequestBody(XmlSerializable requestBody) throws IOException
requestBody
-
IOException
protected abstract boolean isSuccess(int statusCode)
statusCode
-
protected void setSuccess(boolean success)
success
- protected boolean getSuccess()
protected void processMultiStatusBody(MultiStatus multiStatus, org.apache.commons.httpclient.HttpState httpState, org.apache.commons.httpclient.HttpConnection httpConnection)
processResponseBody(HttpState, HttpConnection)
,
which in this implementation parses the response body into a MultiStatus
object if the status code indicates 207 (MultiStatus).
multiStatus
- httpState
- httpConnection
- processResponseBody(HttpState, HttpConnection)
protected void processStatusLine(org.apache.commons.httpclient.HttpState httpState, org.apache.commons.httpclient.HttpConnection httpConnection)
processStatusLine
in class org.apache.commons.httpclient.HttpMethodBase
httpState
- httpConnection
- protected void processResponseBody(org.apache.commons.httpclient.HttpState httpState, org.apache.commons.httpclient.HttpConnection httpConnection)
processResponseBody
in class org.apache.commons.httpclient.HttpMethodBase
httpState
- httpConnection
- HttpMethodBase.processResponseBody(HttpState, HttpConnection)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |