SardineImpl (Sardine WebDAV client 5.9 API)

java.lang.Object
- com.github.sardine.impl.SardineImpl

All Implemented Interfaces:

Sardine
```
public class SardineImpl
extends Object
implements Sardine
```
Implementation of the Sardine interface. This is where the meat of the Sardine library lives.

Author:

jonstevens

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.apache.http.impl.client.CloseableHttpClient`	`client` HTTP client implementation
`protected org.apache.http.client.protocol.HttpClientContext`	`context` Local context with authentication cache.

Constructor Summary

Constructors
Constructor and Description
`SardineImpl()` Access resources with no authentication
`SardineImpl(org.apache.http.impl.client.HttpClientBuilder builder)`
`SardineImpl(org.apache.http.impl.client.HttpClientBuilder builder, String username, String password)`
`SardineImpl(String bearerAuth)` Access resources with Bearer authorization
`SardineImpl(String username, String password)` Supports standard authentication mechanisms
`SardineImpl(String username, String password, ProxySelector selector)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected org.apache.http.impl.client.HttpClientBuilder`	`configure(ProxySelector selector, org.apache.http.client.CredentialsProvider credentials)` Creates a client with all of the defaults.
`void`	`copy(String sourceUrl, String destinationUrl)` Copy a url from source to destination using WebDAV `COPY`.
`void`	`copy(String sourceUrl, String destinationUrl, boolean overwrite)` Copy a url from source to destination using WebDAV `COPY`.
`protected org.apache.http.conn.HttpClientConnectionManager`	`createDefaultConnectionManager(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> schemeRegistry)` Use fail fast connection manager when connections are not released properly.
`protected SardineRedirectStrategy`	`createDefaultRedirectStrategy()`
`protected org.apache.http.conn.routing.HttpRoutePlanner`	`createDefaultRoutePlanner(org.apache.http.conn.SchemePortResolver resolver, ProxySelector selector)` Override to provide proxy configuration
`protected org.apache.http.impl.conn.DefaultSchemePortResolver`	`createDefaultSchemePortResolver()`
`protected org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory>`	`createDefaultSchemeRegistry()` Creates a new registry for default ports with socket factories.
`protected org.apache.http.conn.socket.ConnectionSocketFactory`	`createDefaultSecureSocketFactory()`
`protected org.apache.http.conn.socket.ConnectionSocketFactory`	`createDefaultSocketFactory()`
`void`	`createDirectory(String url)` Uses WebDAV `MKCOL` to create a directory at the specified url
`void`	`delete(String url)` Delete a resource using HTTP `DELETE` at the specified url
`void`	`disableCompression()` Disable GZIP compression header.
`void`	`disablePreemptiveAuthentication()` Disable preemptive authentication.
`void`	`enableCompression()` Adds handling of GZIP compression to the client.
`void`	`enablePreemptiveAuthentication(String hostname)` Send a `Basic` authentication header with each request even before 401 is returned.
`void`	`enablePreemptiveAuthentication(String hostname, int httpPort, int httpsPort)` Send a `Basic` authentication header with each request even before 401 is returned.
`void`	`enablePreemptiveAuthentication(String hostname, int httpPort, int httpsPort, Charset credentialsCharset)`
`void`	`enablePreemptiveAuthentication(URL url)` Send a `Basic` authentication header with each request even before 401 is returned.
`protected <T> T`	`execute(org.apache.http.client.protocol.HttpClientContext context, org.apache.http.client.methods.HttpRequestBase request, org.apache.http.client.ResponseHandler<T> responseHandler)` Common method as single entry point responsible fo request execution
`protected org.apache.http.HttpResponse`	`execute(org.apache.http.client.methods.HttpRequestBase request)` No validation of the response.
`protected <T> T`	`execute(org.apache.http.client.methods.HttpRequestBase request, org.apache.http.client.ResponseHandler<T> responseHandler)` Validate the response using the response handler.
`boolean`	`exists(String url)` Performs a HTTP `HEAD` request to see if a resource exists or not.
`ContentLengthInputStream`	`get(String url)` Uses HTTP `GET` to download data from a server.
`ContentLengthInputStream`	`get(String url, List<org.apache.http.Header> headers)`
`ContentLengthInputStream`	`get(String url, Map<String,String> headers)` Uses HTTP `GET` to download data from a server.
`DavAcl`	`getAcl(String url)` Read access control list for resource
`List<String>`	`getPrincipalCollectionSet(String url)` The principals that are available on the server that implements this resource.
`List<DavPrincipal>`	`getPrincipals(String url)` List the principals that can be used to set ACLs on given url
`DavQuota`	`getQuota(String url)` Read quota properties for resource
`List<DavResource>`	`getResources(String url)`
`void`	`ignoreCookies()` Ignores cookies by always returning the IgnoreSpecFactory regardless of the cookieSpec value being looked up.
`List<DavResource>`	`list(String url)` Gets a directory listing using WebDAV `PROPFIND`.
`List<DavResource>`	`list(String url, int depth)` Gets a directory listing using WebDAV `PROPFIND`.
`List<DavResource>`	`list(String url, int depth, boolean allProp)` Gets a directory listing using WebDAV `PROPFIND`.
`List<DavResource>`	`list(String url, int depth, Set<QName> props)` Gets a directory listing using WebDAV `PROPFIND`.
`String`	`lock(String url)` Put an exclusive write lock on this resource.
`void`	`move(String sourceUrl, String destinationUrl)` Move a url to from source to destination using WebDAV `MOVE`.
`void`	`move(String sourceUrl, String destinationUrl, boolean overwrite)` Move a url to from source to destination using WebDAV `MOVE`.
`List<DavResource>`	`patch(String url, List<Element> setProps, List<QName> removeProps)` Creates a `Propertyupdate` element containing all properties to set from setProps and all properties to remove from removeProps.
`List<DavResource>`	`patch(String url, Map<QName,String> setProps)` Add custom properties for a url WebDAV `PROPPATCH`.
`List<DavResource>`	`patch(String url, Map<QName,String> setProps, List<QName> removeProps)` Creates a `Propertyupdate` element containing all properties to set from setProps and all properties to remove from removeProps.
`protected List<DavResource>`	`propfind(String url, int depth, Propfind body)`
`List<DavResource>`	`propfind(String url, int depth, Set<QName> props)` Fetches a resource using WebDAV `PROPFIND`.
`void`	`put(String url, byte[] data)` Uses HTTP `PUT` to send data to a server.
`void`	`put(String url, byte[] data, String contentType)` Uses `PUT` to send data to a server with a specific content type header.
`void`	`put(String url, File localFile, String contentType)` Uses `PUT` to upload file to a server with specific contentType.
`void`	`put(String url, File localFile, String contentType, boolean expectContinue)` Uses `PUT` to upload file to a server with specific contentType.
`void`	`put(String url, org.apache.http.HttpEntity entity, List<org.apache.http.Header> headers)` Upload the entity using `PUT`
`<T> T`	`put(String url, org.apache.http.HttpEntity entity, List<org.apache.http.Header> headers, org.apache.http.client.ResponseHandler<T> handler)`
`void`	`put(String url, org.apache.http.HttpEntity entity, String contentType, boolean expectContinue)` Upload the entity using `PUT`
`void`	`put(String url, InputStream dataStream)` Uses `PUT` to send data to a server.
`void`	`put(String url, InputStream dataStream, List<org.apache.http.Header> headers)`
`void`	`put(String url, InputStream dataStream, Map<String,String> headers)` Uses `PUT` to send data to a server with specific headers.
`void`	`put(String url, InputStream dataStream, String contentType)` Uses `PUT` to send data to a server with a specific content type header.
`void`	`put(String url, InputStream dataStream, String contentType, boolean expectContinue)` Uses `PUT` to send data to a server with a specific content type header.
`void`	`put(String url, InputStream dataStream, String contentType, boolean expectContinue, long contentLength)` Uses `PUT` to send data to a server with a specific content type header.
`String`	`refreshLock(String url, String token, String file)` A LOCK request with no request body is a "LOCK refresh" request.
`<T> T`	`report(String url, int depth, SardineReport<T> report)` Runs a report on the given resource using WebDAV `REPORT`.
`List<DavResource>`	`search(String url, String language, String query)` Perform a search of the Webdav repository.
`void`	`setAcl(String url, List<DavAce> aces)` Write access control list for resource
`void`	`setCredentials(org.apache.http.client.CredentialsProvider provider)`
`void`	`setCredentials(String username, String password)` Add credentials to any scope.
`void`	`setCredentials(String username, String password, String domain, String workstation)`
`void`	`setCustomProps(String url, Map<String,String> set, List<String> remove)`
`void`	`shutdown()` Releasing any resources that might be held open.
`void`	`unlock(String url, String token)` Unlock the resource.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - client
```
protected org.apache.http.impl.client.CloseableHttpClient client
```
    HTTP client implementation
  - context
```
protected org.apache.http.client.protocol.HttpClientContext context
```
    Local context with authentication cache. Make sure the same context is used to execute logically related requests.
- Constructor Detail
  - SardineImpl
```
public SardineImpl()
```
    Access resources with no authentication
  - SardineImpl
```
public SardineImpl(String bearerAuth)
```
    Access resources with Bearer authorization
  - SardineImpl
```
public SardineImpl(String username,
                   String password)
```
    Supports standard authentication mechanisms
    
    Parameters:
    
    username - Use in authentication header credentials
    
    password - Use in authentication header credentials
  - SardineImpl
```
public SardineImpl(String username,
                   String password,
                   ProxySelector selector)
```
    Parameters:
    
    username - Use in authentication header credentials
    
    password - Use in authentication header credentials
    
    selector - Proxy configuration
  - SardineImpl
```
public SardineImpl(org.apache.http.impl.client.HttpClientBuilder builder)
```
    Parameters:
    
    builder - Custom client configuration
  - SardineImpl
```
public SardineImpl(org.apache.http.impl.client.HttpClientBuilder builder,
                   String username,
                   String password)
```
    Parameters:
    
    builder - Custom client configuration
    
    username - Use in authentication header credentials
    
    password - Use in authentication header credentials
- Method Detail
  - setCredentials
```
public void setCredentials(String username,
                           String password)
```
    Add credentials to any scope. Supports Basic, Digest and NTLM authentication methods.
    
    Specified by:
    
    setCredentials in interface Sardine
    
    Parameters:
    
    username - Use in authentication header credentials
    
    password - Use in authentication header credentials
  - setCredentials
```
public void setCredentials(String username,
                           String password,
                           String domain,
                           String workstation)
```
    Specified by:
    
    setCredentials in interface Sardine
    
    Parameters:
    
    username - Use in authentication header credentials
    
    password - Use in authentication header credentials
    
    domain - NTLM authentication
    
    workstation - NTLM authentication
  - setCredentials
```
public void setCredentials(org.apache.http.client.CredentialsProvider provider)
```
  - enableCompression
```
public void enableCompression()
```
    Adds handling of GZIP compression to the client.
    
    Specified by:
    
    enableCompression in interface Sardine
  - disableCompression
```
public void disableCompression()
```
    Disable GZIP compression header.
    
    Specified by:
    
    disableCompression in interface Sardine
    
    See Also:
    
    Sardine.enableCompression()
  - ignoreCookies
```
public void ignoreCookies()
```
    Ignores cookies by always returning the IgnoreSpecFactory regardless of the cookieSpec value being looked up.
    
    Specified by:
    
    ignoreCookies in interface Sardine
  - enablePreemptiveAuthentication
```
public void enablePreemptiveAuthentication(String hostname)
```
    Description copied from interface: Sardine
    
    Send a Basic authentication header with each request even before 401 is returned. Uses default ports: 80 for http and 443 for https
    
    Specified by:
    
    enablePreemptiveAuthentication in interface Sardine
    
    Parameters:
    
    hostname - The hostname to enable preemptive authentication for.
  - enablePreemptiveAuthentication
```
public void enablePreemptiveAuthentication(URL url)
```
    Description copied from interface: Sardine
    
    Send a Basic authentication header with each request even before 401 is returned.
    
    Specified by:
    
    enablePreemptiveAuthentication in interface Sardine
    
    Parameters:
    
    url - The hostname, protocol and port to enable preemptive authentication for.
  - enablePreemptiveAuthentication
```
public void enablePreemptiveAuthentication(String hostname,
                                           int httpPort,
                                           int httpsPort)
```
    Description copied from interface: Sardine
    
    Send a Basic authentication header with each request even before 401 is returned.
    
    Specified by:
    
    enablePreemptiveAuthentication in interface Sardine
    
    Parameters:
    
    hostname - The hostname to enable preemptive authentication for.
    
    httpPort - The http port to enable preemptive authentication for. -1 for default value.
    
    httpsPort - The https port to enable preemptive authentication for. -1 for default value.
  - enablePreemptiveAuthentication
```
public void enablePreemptiveAuthentication(String hostname,
                                           int httpPort,
                                           int httpsPort,
                                           Charset credentialsCharset)
```
  - disablePreemptiveAuthentication
```
public void disablePreemptiveAuthentication()
```
    Description copied from interface: Sardine
    
    Disable preemptive authentication.
    
    Specified by:
    
    disablePreemptiveAuthentication in interface Sardine
  - getResources
```
public List<DavResource> getResources(String url)
                               throws IOException
```
    Specified by:
    
    getResources in interface Sardine
    
    Throws:
    
    IOException
    
    See Also:
    
    Sardine.list(String)
  - list
```
public List<DavResource> list(String url)
                       throws IOException
```
    Description copied from interface: Sardine
    
    Gets a directory listing using WebDAV PROPFIND.
    
    Specified by:
    
    list in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    Returns:
    
    List of resources for this URI including the parent resource itself
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - list
```
public List<DavResource> list(String url,
                              int depth)
                       throws IOException
```
    Description copied from interface: Sardine
    
    Gets a directory listing using WebDAV PROPFIND.
    
    Specified by:
    
    list in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    depth - The depth to look at (use 0 for single resource, 1 for directory listing, -1 for infinite recursion)
    
    Returns:
    
    List of resources for this URI including the parent resource itself
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - list
```
public List<DavResource> list(String url,
                              int depth,
                              boolean allProp)
                       throws IOException
```
    Description copied from interface: Sardine
    
    Gets a directory listing using WebDAV PROPFIND.
    
    Specified by:
    
    list in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    depth - The depth to look at (use 0 for single resource, 1 for directory listing, -1 for infinite recursion)
    
    allProp - If allprop should be used, which can be inefficient sometimes; warning: no allprop does not retrieve custom props, just the basic ones
    
    Returns:
    
    List of resources for this URI including the parent resource itself
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - list
```
public List<DavResource> list(String url,
                              int depth,
                              Set<QName> props)
                       throws IOException
```
    Description copied from interface: Sardine
    
    Gets a directory listing using WebDAV PROPFIND.
    
    Specified by:
    
    list in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    depth - The depth to look at (use 0 for single resource, 1 for directory listing, -1 for infinite recursion)
    
    props - Additional properties which should be requested.
    
    Returns:
    
    List of resources for this URI including the parent resource itself
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - propfind
```
public List<DavResource> propfind(String url,
                                  int depth,
                                  Set<QName> props)
                           throws IOException
```
    Description copied from interface: Sardine
    
    Fetches a resource using WebDAV PROPFIND. Only the specified properties are retrieved.
    
    Specified by:
    
    propfind in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    depth - The depth to look at (use 0 for single resource, 1 for directory listing, -1 for infinite recursion)
    
    props - Set of properties to be requested
    
    Returns:
    
    List of resources for this URI including the parent resource itself
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - propfind
```
protected List<DavResource> propfind(String url,
                                     int depth,
                                     Propfind body)
                              throws IOException
```
    Throws:
    
    IOException
  - report
```
public <T> T report(String url,
                    int depth,
                    SardineReport<T> report)
             throws IOException
```
    Description copied from interface: Sardine
    
    Runs a report on the given resource using WebDAV REPORT.
    
    Specified by:
    
    report in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    depth - The depth to look at (use 0 for single resource, 1 for directory listing, -1 for infinite recursion)
    
    report - The report to run
    
    Returns:
    
    Result of the report, packaged in a report-specific result object
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - search
```
public List<DavResource> search(String url,
                                String language,
                                String query)
                         throws IOException
```
    Description copied from interface: Sardine
    
    Perform a search of the Webdav repository.
    
    Specified by:
    
    search in interface Sardine
    
    Parameters:
    
    url - The base resource to search from.
    
    language - The language the query is formed in.
    
    query - The query string to be processed by the webdav server.
    
    Returns:
    
    A list of matching resources.
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure.
  - setCustomProps
```
public void setCustomProps(String url,
                           Map<String,String> set,
                           List<String> remove)
                    throws IOException
```
    Specified by:
    
    setCustomProps in interface Sardine
    
    Throws:
    
    IOException
    
    See Also:
    
    Sardine.patch(String, java.util.Map, java.util.List)
  - patch
```
public List<DavResource> patch(String url,
                               Map<QName,String> setProps)
                        throws IOException
```
    Description copied from interface: Sardine
    
    Add custom properties for a url WebDAV PROPPATCH.
    
    Specified by:
    
    patch in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    setProps - Properties to add to resource. If a property already exists then its value is replaced.
    
    Returns:
    
    The patched resources from the response
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - patch
```
public List<DavResource> patch(String url,
                               Map<QName,String> setProps,
                               List<QName> removeProps)
                        throws IOException
```
    Creates a Propertyupdate element containing all properties to set from setProps and all properties to remove from removeProps. Note this method will use a SardineUtil.CUSTOM_NAMESPACE_URI as namespace and SardineUtil.CUSTOM_NAMESPACE_PREFIX as prefix.
    
    Specified by:
    
    patch in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    setProps - Properties to add to resource. If a property already exists then its value is replaced.
    
    removeProps - Properties to remove from resource. Specifying the removal of a property that does not exist is not an error.
    
    Returns:
    
    The patched resources from the response
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - patch
```
public List<DavResource> patch(String url,
                               List<Element> setProps,
                               List<QName> removeProps)
                        throws IOException
```
    Creates a Propertyupdate element containing all properties to set from setProps and all properties to remove from removeProps. Note this method will use a SardineUtil.CUSTOM_NAMESPACE_URI as namespace and SardineUtil.CUSTOM_NAMESPACE_PREFIX as prefix.
    
    Specified by:
    
    patch in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    setProps - Properties to add to resource. If a property already exists then its value is replaced.
    
    removeProps - Properties to remove from resource. Specifying the removal of a property that does not exist is not an error.
    
    Returns:
    
    The patched resources from the response
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - lock
```
public String lock(String url)
            throws IOException
```
    Description copied from interface: Sardine
    
    Put an exclusive write lock on this resource. A write lock must prevent a principal without the lock from successfully executing a PUT, POST, PROPPATCH, LOCK, UNLOCK, MOVE, DELETE, or MKCOL on the locked resource. All other current methods, GET in particular, function independently of the lock.
    A WebDAV compliant server is not required to support locking in any form. If the server does support locking it may choose to support any combination of exclusive and shared locks for any access types.
    
    Specified by:
    
    lock in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    Returns:
    
    The lock token to unlock this resource. A lock token is a type of state token, represented as a URI, which identifies a particular lock. A lock token is returned by every successful LOCK operation in the lockdiscovery property in the response body, and can also be found through lock discovery on a resource.
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - refreshLock
```
public String refreshLock(String url,
                          String token,
                          String file)
                   throws IOException
```
    Description copied from interface: Sardine
    
    A LOCK request with no request body is a "LOCK refresh" request. It's purpose is to restart all timers associated with a lock. The request MUST include an "If" header that contains the lock tokens of the locks to be refreshed (note there may be multiple in the case of shared locks).
    
    Specified by:
    
    refreshLock in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    token - The lock token used to lock the resource
    
    file - The name of the file at the end of the url
    
    Returns:
    
    The lock token to unlock this resource. A lock token is a type of state token, represented as a URI, which identifies a particular lock. A lock token is returned by every successful LOCK operation in the lockdiscovery property in the response body, and can also be found through lock discovery on a resource.
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - unlock
```
public void unlock(String url,
                   String token)
            throws IOException
```
    Description copied from interface: Sardine
    
    Unlock the resource.
    A WebDAV compliant server is not required to support locking in any form. If the server does support locking it may choose to support any combination of exclusive and shared locks for any access types.
    
    Specified by:
    
    unlock in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    token - The lock token to unlock this resource.
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
    
    See Also:
    
    Sardine.lock(String)
  - setAcl
```
public void setAcl(String url,
                   List<DavAce> aces)
            throws IOException
```
    Description copied from interface: Sardine
    
    Write access control list for resource
    
    Specified by:
    
    setAcl in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    aces - Access control elements
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - getAcl
```
public DavAcl getAcl(String url)
              throws IOException
```
    Description copied from interface: Sardine
    
    Read access control list for resource
    
    Specified by:
    
    getAcl in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    Returns:
    
    Current ACL set on the resource
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - getQuota
```
public DavQuota getQuota(String url)
                  throws IOException
```
    Description copied from interface: Sardine
    
    Read quota properties for resource
    
    Specified by:
    
    getQuota in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    Returns:
    
    Current Quota and Size Properties for resource
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - getPrincipals
```
public List<DavPrincipal> getPrincipals(String url)
                                 throws IOException
```
    Description copied from interface: Sardine
    
    List the principals that can be used to set ACLs on given url
    
    Specified by:
    
    getPrincipals in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    Returns:
    
    List of principals (in the form of urls according to spec)
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - getPrincipalCollectionSet
```
public List<String> getPrincipalCollectionSet(String url)
                                       throws IOException
```
    Description copied from interface: Sardine
    
    The principals that are available on the server that implements this resource.
    
    Specified by:
    
    getPrincipalCollectionSet in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    Returns:
    
    The URLs in DAV:principal-collection-set
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - get
```
public ContentLengthInputStream get(String url)
                             throws IOException
```
    Description copied from interface: Sardine
    
    Uses HTTP GET to download data from a server. The stream must be closed after reading.
    
    Specified by:
    
    get in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    Returns:
    
    Data stream to read from
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - get
```
public ContentLengthInputStream get(String url,
                                    Map<String,String> headers)
                             throws IOException
```
    Description copied from interface: Sardine
    
    Uses HTTP GET to download data from a server. The stream must be closed after reading.
    
    Specified by:
    
    get in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    headers - Additional HTTP headers to add to the request
    
    Returns:
    
    Data stream to read from
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - get
```
public ContentLengthInputStream get(String url,
                                    List<org.apache.http.Header> headers)
                             throws IOException
```
    Throws:
    
    IOException
  - put
```
public void put(String url,
                byte[] data)
         throws IOException
```
    Description copied from interface: Sardine
    
    Uses HTTP PUT to send data to a server. Repeatable on authentication failure.
    
    Specified by:
    
    put in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    data - Input source
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - put
```
public void put(String url,
                byte[] data,
                String contentType)
         throws IOException
```
    Description copied from interface: Sardine
    
    Uses PUT to send data to a server with a specific content type header. Repeatable on authentication failure.
    
    Specified by:
    
    put in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    data - Input source
    
    contentType - MIME type to add to the HTTP request header
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - put
```
public void put(String url,
                InputStream dataStream)
         throws IOException
```
    Description copied from interface: Sardine
    
    Uses PUT to send data to a server. Not repeatable on authentication failure.
    
    Specified by:
    
    put in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    dataStream - Input source
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - put
```
public void put(String url,
                InputStream dataStream,
                String contentType)
         throws IOException
```
    Description copied from interface: Sardine
    
    Uses PUT to send data to a server with a specific content type header. Not repeatable on authentication failure.
    
    Specified by:
    
    put in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    dataStream - Input source
    
    contentType - MIME type to add to the HTTP request header
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - put
```
public void put(String url,
                InputStream dataStream,
                String contentType,
                boolean expectContinue)
         throws IOException
```
    Description copied from interface: Sardine
    
    Uses PUT to send data to a server with a specific content type header. Not repeatable on authentication failure.
    
    Specified by:
    
    put in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    dataStream - Input source
    
    contentType - MIME type to add to the HTTP request header
    
    expectContinue - Enable Expect: continue header for PUT requests.
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - put
```
public void put(String url,
                InputStream dataStream,
                String contentType,
                boolean expectContinue,
                long contentLength)
         throws IOException
```
    Description copied from interface: Sardine
    
    Uses PUT to send data to a server with a specific content type header. Not repeatable on authentication failure.
    
    Specified by:
    
    put in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    dataStream - Input source
    
    contentType - MIME type to add to the HTTP request header
    
    expectContinue - Enable Expect: continue header for PUT requests.
    
    contentLength - data size in bytes to set to Content-Length header
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - put
```
public void put(String url,
                InputStream dataStream,
                Map<String,String> headers)
         throws IOException
```
    Description copied from interface: Sardine
    
    Uses PUT to send data to a server with specific headers. Not repeatable on authentication failure.
    
    Specified by:
    
    put in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    dataStream - Input source
    
    headers - Additional HTTP headers to add to the request
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - put
```
public void put(String url,
                InputStream dataStream,
                List<org.apache.http.Header> headers)
         throws IOException
```
    Throws:
    
    IOException
  - put
```
public void put(String url,
                org.apache.http.HttpEntity entity,
                String contentType,
                boolean expectContinue)
         throws IOException
```
    Upload the entity using PUT
    
    Parameters:
    
    url - Resource
    
    entity - The entity to read from
    
    contentType - Content Type header
    
    expectContinue - Add Expect: continue header
    
    Throws:
    
    IOException
  - put
```
public void put(String url,
                org.apache.http.HttpEntity entity,
                List<org.apache.http.Header> headers)
         throws IOException
```
    Upload the entity using PUT
    
    Parameters:
    
    url - Resource
    
    entity - The entity to read from
    
    headers - Headers to add to request
    
    Throws:
    
    IOException
  - put
```
public <T> T put(String url,
                 org.apache.http.HttpEntity entity,
                 List<org.apache.http.Header> headers,
                 org.apache.http.client.ResponseHandler<T> handler)
          throws IOException
```
    Throws:
    
    IOException
  - put
```
public void put(String url,
                File localFile,
                String contentType)
         throws IOException
```
    Description copied from interface: Sardine
    
    Uses PUT to upload file to a server with specific contentType. Repeatable on authentication failure.
    
    Specified by:
    
    put in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    localFile - local file to send
    
    contentType - MIME type to add to the HTTP request header
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - put
```
public void put(String url,
                File localFile,
                String contentType,
                boolean expectContinue)
         throws IOException
```
    Description copied from interface: Sardine
    
    Uses PUT to upload file to a server with specific contentType. Repeatable on authentication failure.
    
    Specified by:
    
    put in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    localFile - local file to send
    
    contentType - MIME type to add to the HTTP request header
    
    expectContinue - Enable Expect: continue header for PUT requests.
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - delete
```
public void delete(String url)
            throws IOException
```
    Description copied from interface: Sardine
    
    Delete a resource using HTTP DELETE at the specified url
    
    Specified by:
    
    delete in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - move
```
public void move(String sourceUrl,
                 String destinationUrl)
          throws IOException
```
    Description copied from interface: Sardine
    
    Move a url to from source to destination using WebDAV MOVE. Assumes overwrite.
    
    Specified by:
    
    move in interface Sardine
    
    Parameters:
    
    sourceUrl - Path to the resource including protocol and hostname
    
    destinationUrl - Path to the resource including protocol and hostname
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - move
```
public void move(String sourceUrl,
                 String destinationUrl,
                 boolean overwrite)
          throws IOException
```
    Description copied from interface: Sardine
    
    Move a url to from source to destination using WebDAV MOVE.
    
    Specified by:
    
    move in interface Sardine
    
    Parameters:
    
    sourceUrl - Path to the resource including protocol and hostname
    
    destinationUrl - Path to the resource including protocol and hostname
    
    overwrite - true to overwrite if the destination exists, false otherwise.
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - copy
```
public void copy(String sourceUrl,
                 String destinationUrl)
          throws IOException
```
    Description copied from interface: Sardine
    
    Copy a url from source to destination using WebDAV COPY. Assumes overwrite.
    
    Specified by:
    
    copy in interface Sardine
    
    Parameters:
    
    sourceUrl - Path to the resource including protocol and hostname
    
    destinationUrl - Path to the resource including protocol and hostname
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - copy
```
public void copy(String sourceUrl,
                 String destinationUrl,
                 boolean overwrite)
          throws IOException
```
    Description copied from interface: Sardine
    
    Copy a url from source to destination using WebDAV COPY.
    
    Specified by:
    
    copy in interface Sardine
    
    Parameters:
    
    sourceUrl - Path to the resource including protocol and hostname
    
    destinationUrl - Path to the resource including protocol and hostname
    
    overwrite - true to overwrite if the destination exists, false otherwise.
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - createDirectory
```
public void createDirectory(String url)
                     throws IOException
```
    Description copied from interface: Sardine
    
    Uses WebDAV MKCOL to create a directory at the specified url
    
    Specified by:
    
    createDirectory in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - exists
```
public boolean exists(String url)
               throws IOException
```
    Description copied from interface: Sardine
    
    Performs a HTTP HEAD request to see if a resource exists or not.
    
    Specified by:
    
    exists in interface Sardine
    
    Parameters:
    
    url - Path to the resource including protocol and hostname
    
    Returns:
    
    Anything outside of the 200-299 response code range returns false.
    
    Throws:
    
    IOException - I/O error or HTTP response validation failure
  - execute
```
protected <T> T execute(org.apache.http.client.methods.HttpRequestBase request,
                        org.apache.http.client.ResponseHandler<T> responseHandler)
                 throws IOException
```
    Validate the response using the response handler. Aborts the request if there is an exception.
    
    Type Parameters:
    
    T - Return type
    
    Parameters:
    
    request - Request to execute
    
    responseHandler - Determines the return type.
    
    Returns:
    
    parsed response
    
    Throws:
    
    IOException
  - execute
```
protected org.apache.http.HttpResponse execute(org.apache.http.client.methods.HttpRequestBase request)
                                        throws IOException
```
    No validation of the response. Aborts the request if there is an exception.
    
    Parameters:
    
    request - Request to execute
    
    Returns:
    
    The response to check the reply status code
    
    Throws:
    
    IOException
  - execute
```
protected <T> T execute(org.apache.http.client.protocol.HttpClientContext context,
                        org.apache.http.client.methods.HttpRequestBase request,
                        org.apache.http.client.ResponseHandler<T> responseHandler)
                 throws IOException
```
    Common method as single entry point responsible fo request execution
    
    Type Parameters:
    
    T - will return raw HttpResponse when responseHandler is null or value reslved using provided ResponseHandler instance
    
    Parameters:
    
    context - clientContext to be used when executing request
    
    request - Request to execute
    
    responseHandler - can be null if you need raw HttpResponse or not null response handler for result handling.
    
    Returns:
    
    value resolved using response handler or raw HttpResponse when responseHandler is null
    
    Throws:
    
    IOException
  - shutdown
```
public void shutdown()
              throws IOException
```
    Description copied from interface: Sardine
    
    Releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface Sardine
    
    Throws:
    
    IOException
  - configure
```
protected org.apache.http.impl.client.HttpClientBuilder configure(ProxySelector selector,
                                                                  org.apache.http.client.CredentialsProvider credentials)
```
    Creates a client with all of the defaults.
    
    Parameters:
    
    selector - Proxy configuration or null
    
    credentials - Authentication credentials or null
  - createDefaultSchemePortResolver
```
protected org.apache.http.impl.conn.DefaultSchemePortResolver createDefaultSchemePortResolver()
```
  - createDefaultRedirectStrategy
```
protected SardineRedirectStrategy createDefaultRedirectStrategy()
```
  - createDefaultSchemeRegistry
```
protected org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> createDefaultSchemeRegistry()
```
    Creates a new registry for default ports with socket factories.
  - createDefaultSocketFactory
```
protected org.apache.http.conn.socket.ConnectionSocketFactory createDefaultSocketFactory()
```
    Returns:
    
    Default socket factory
  - createDefaultSecureSocketFactory
```
protected org.apache.http.conn.socket.ConnectionSocketFactory createDefaultSecureSocketFactory()
```
    Returns:
    
    Default SSL socket factory
  - createDefaultConnectionManager
```
protected org.apache.http.conn.HttpClientConnectionManager createDefaultConnectionManager(org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> schemeRegistry)
```
    Use fail fast connection manager when connections are not released properly.
    
    Parameters:
    
    schemeRegistry - Protocol registry
    
    Returns:
    
    Default connection manager
  - createDefaultRoutePlanner
```
protected org.apache.http.conn.routing.HttpRoutePlanner createDefaultRoutePlanner(org.apache.http.conn.SchemePortResolver resolver,
                                                                                  ProxySelector selector)
```
    Override to provide proxy configuration
    
    Parameters:
    
    resolver - Protocol registry
    
    selector - Proxy configuration
    
    Returns:
    
    ProxySelectorRoutePlanner configured with schemeRegistry and selector

Class SardineImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

client

context

Constructor Detail

SardineImpl

SardineImpl

SardineImpl

SardineImpl

SardineImpl

SardineImpl

Method Detail

setCredentials

setCredentials

setCredentials

enableCompression

disableCompression

ignoreCookies

enablePreemptiveAuthentication

enablePreemptiveAuthentication

enablePreemptiveAuthentication

enablePreemptiveAuthentication

disablePreemptiveAuthentication

getResources

list

list

list

list

propfind

propfind

report

search

setCustomProps

patch

patch

patch

lock

refreshLock

unlock

setAcl

getAcl

getQuota

getPrincipals

getPrincipalCollectionSet

get

get

get

put

put

put

put

put

put

put

put

put

put

put

put

put

delete

move

move

copy

copy

createDirectory

exists

execute

execute

execute

shutdown

configure

createDefaultSchemePortResolver

createDefaultRedirectStrategy

createDefaultSchemeRegistry

createDefaultSocketFactory