Class BindMethod

  • All Implemented Interfaces:
    org.apache.commons.httpclient.HttpMethod

    public class BindMethod
    extends XMLResponseMethodBase
    The BIND method modifies the collection identified by the Request-URI, by adding a new binding from the segment specified in the BIND body to the resource identified in the BIND body. BIND Method Example: >> Request: BIND /CollY HTTP/1.1 Host: www.example.com Content-Type: text/xml; charset="utf-8" Content-Length: xxx bar.html http://www.example.com/CollX/foo.html >> Response: HTTP/1.1 201 Created The server added a new binding to the collection, "http://www.example.com/CollY", associating "bar.html" with the resource identified by the URI "http://www.example.com/CollX/foo.html". Clients can now use the URI "http://www.example.com/CollY/bar.html", to submit requests to that resource.
    • Constructor Summary

      Constructors 
      Constructor Description
      BindMethod()
      Method constructor.
      BindMethod​(java.lang.String existingBinding, java.lang.String newBinding)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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 getHref()  
      java.lang.String getName()  
      java.lang.String getSegment()  
      boolean isOverwrite()
      By default, if there already is a binding for the specified segment in the collection, the new binding replaces the existing binding.
      void setHref​(java.lang.String href)  
      void setOverwrite​(boolean overwrite)
      By default, if there already is a binding for the specified segment in the collection, the new binding replaces the existing binding.
      void setSegment​(java.lang.String segment)  
      • 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, processResponseBody, processResponseHeaders, processStatusLine, readResponse, readResponseHeaders, readStatusLine, releaseConnection, removeRequestHeader, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, setFollowRedirects, 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
    • Constructor Detail

      • BindMethod

        public BindMethod()
        Method constructor.
      • BindMethod

        public BindMethod​(java.lang.String existingBinding,
                          java.lang.String newBinding)
    • Method Detail

      • 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
      • setOverwrite

        public void setOverwrite​(boolean overwrite)
        By default, if there already is a binding for the specified segment in the collection, the new binding replaces the existing binding. This default binding replacement behavior can be overridden using the Overwrite header.
        Parameters:
        overwrite - New overwrite value
      • isOverwrite

        public boolean isOverwrite()
        By default, if there already is a binding for the specified segment in the collection, the new binding replaces the existing binding. This default binding replacement behavior can be overridden using the Overwrite header.
        Returns:
        the current value of the overwrite flag
      • 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 for the request.
        Throws:
        java.io.IOException
        org.apache.commons.httpclient.HttpException
      • generateRequestBody

        protected java.lang.String generateRequestBody()
        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
      • getHref

        public java.lang.String getHref()
        Returns:
        path of the resource to be bound
      • getSegment

        public java.lang.String getSegment()
        Returns:
        new resource name
      • setHref

        public void setHref​(java.lang.String href)
        Parameters:
        href - path of the resource to be bound
      • setSegment

        public void setSegment​(java.lang.String segment)
        Parameters:
        segment - new resource name