SardineImpl (Sardine WEBDAV client 5.0 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.

Version:

$Id$

Author:

jonstevens

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`copy(String sourceUrl, String destinationUrl)` Copy a url from source to destination using WebDAV `COPY`.
`protected org.apache.http.impl.client.AbstractHttpClient`	`createDefaultClient(ProxySelector selector)` Creates an AbstractHttpClient with all of the defaults.
`protected org.apache.http.conn.ClientConnectionManager`	`createDefaultConnectionManager(org.apache.http.conn.scheme.SchemeRegistry schemeRegistry)` Use fail fast connection manager when connections are not released properly.
`protected org.apache.http.params.HttpParams`	`createDefaultHttpParams()` Creates default params setting the user agent.
`protected org.apache.http.conn.routing.HttpRoutePlanner`	`createDefaultRoutePlanner(org.apache.http.conn.scheme.SchemeRegistry schemeRegistry, ProxySelector selector)` Override to provide proxy configuration
`protected org.apache.http.conn.scheme.SchemeRegistry`	`createDefaultSchemeRegistry()` Creates a new `SchemeRegistry` for default ports with socket factories.
`protected org.apache.http.conn.ssl.SSLSocketFactory`	`createDefaultSecureSocketFactory()`
`protected org.apache.http.conn.scheme.PlainSocketFactory`	`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.
`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.
`InputStream`	`get(String url)` Uses HTTP `GET` to download data from a server.
`InputStream`	`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
`List<DavResource>`	`getResources(String url)`
`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`.
`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`.
`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.
`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, org.apache.http.HttpEntity entity, Map<String,String> headers)` Upload the entity using `PUT`
`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, 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`	`setAcl(String url, List<DavAce> aces)` Write access control list for resource
`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

- Constructor Detail
  - SardineImpl
```
public SardineImpl()
```
    Access resources with no authentication
  - 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.AbstractHttpClient http)
```
    Parameters:
    http - Custom client configuration
  - SardineImpl
```
public SardineImpl(org.apache.http.impl.client.AbstractHttpClient http,
           String username,
           String password)
```
    Parameters:
    http - 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 credentialsn
    domain - NTLM authentication
    workstation - NTLM authentication
  - 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()
  - enablePreemptiveAuthentication
```
public void enablePreemptiveAuthentication(String hostname)
```
    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.
  - 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 ressource, 1 for directory listing)
    
    Returns:
    List of resources for this URI including the parent resource itself
    
    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
  - 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
  - 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
  - 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 InputStream 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 InputStream 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
  - 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,
       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,
       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,
       Map<String,String> 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
  - 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
  - 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
  - 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
  - shutdown
```
public void shutdown()
```
    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
  - createDefaultClient
```
protected org.apache.http.impl.client.AbstractHttpClient createDefaultClient(ProxySelector selector)
```
    Creates an AbstractHttpClient with all of the defaults.
  - createDefaultHttpParams
```
protected org.apache.http.params.HttpParams createDefaultHttpParams()
```
    Creates default params setting the user agent.
    
    Returns:
    Basic HTTP parameters with a custom user agent
  - createDefaultSchemeRegistry
```
protected org.apache.http.conn.scheme.SchemeRegistry createDefaultSchemeRegistry()
```
    Creates a new SchemeRegistry for default ports with socket factories.
    
    Returns:
    a new SchemeRegistry.
  - createDefaultSocketFactory
```
protected org.apache.http.conn.scheme.PlainSocketFactory createDefaultSocketFactory()
```
    Returns:
    Default socket factory
  - createDefaultSecureSocketFactory
```
protected org.apache.http.conn.ssl.SSLSocketFactory createDefaultSecureSocketFactory()
```
    Returns:
    Default SSL socket factory
  - createDefaultConnectionManager
```
protected org.apache.http.conn.ClientConnectionManager createDefaultConnectionManager(org.apache.http.conn.scheme.SchemeRegistry 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.scheme.SchemeRegistry schemeRegistry,
                                                                      ProxySelector selector)
```
    Override to provide proxy configuration
    
    Parameters:
    schemeRegistry - Protocol registry
    selector - Proxy configuration
    
    Returns:
    ProxySelectorRoutePlanner configured with schemeRegistry and selector

Class SardineImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SardineImpl

SardineImpl

SardineImpl

SardineImpl

SardineImpl

Method Detail

setCredentials

setCredentials

enableCompression

disableCompression

enablePreemptiveAuthentication

disablePreemptiveAuthentication

getResources

list

list

setCustomProps

patch

patch

lock

unlock

setAcl

getAcl

getPrincipals

getPrincipalCollectionSet

get

get

put

put

put

put

put

put

put

put

delete

move

copy

createDirectory

exists

execute

execute

shutdown

createDefaultClient

createDefaultHttpParams

createDefaultSchemeRegistry

createDefaultSocketFactory

createDefaultSecureSocketFactory

createDefaultConnectionManager

createDefaultRoutePlanner