org.apache.webdav.lib.methods
Class CheckinMethod

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

All Implemented Interfaces:

org.apache.commons.httpclient.HttpMethod

public class CheckinMethod
extends XMLResponseMethodBase

The CHECKIN method can be applied to a checked-out version-controlled resource to produce a new version whose content and dead properties are copied from the checked-out resource.

This implementation of a CHECKIN client method does support a a request body.

If a CHECKIN request fails, the server state preceding the request MUST be restored. The request body MUST be a DAV:checkin XML element with at most one DAV:keep-checked-out or DAV:fork-ok.

Example Request

 CHECKIN /foo.html HTTP/1.1
 Host: www.server.org
 Content-type: text/xml; charset="utf-8"
 Content-Length: xx
 

Example Response

 HTTP/1.1 201 Created
 Location: http://server.org/history/1/1.1
 Content-type: text/xml; charset="utf-8"
 

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.webdav.lib.methods.XMLResponseMethodBase

XMLResponseMethodBase.Response

Field Summary

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

builder, decodeResponseHrefs, responseURLs

Fields inherited from class org.apache.commons.httpclient.HttpMethodBase

USER_AGENT

Constructor Summary

CheckinMethod()
Method constructor.

CheckinMethod(java.lang.String path)
Method constructor.

Method Summary

java.lang.String	getName()
void	parseResponse(java.io.InputStream input, org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn) Parse response.

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

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

addAuthorizationRequestHeader, addContentLengthRequestHeader, addCookieRequestHeader, addHostRequestHeader, addProxyAuthorizationRequestHeader, addProxyConnectionHeader, addRequestHeader, addRequestHeader, addRequestHeaders, 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, 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

CheckinMethod

public CheckinMethod()

Method constructor.

CheckinMethod

public CheckinMethod(java.lang.String path)

Method constructor.

Method Detail

parseResponse

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

Parse response.

Overrides:

parseResponse in class XMLResponseMethodBase

Parameters:

input - Input stream

Throws:

java.io.IOException

org.apache.commons.httpclient.HttpException

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