de.cismet.commons.security

Class WebDavClient

java.lang.Object

de.cismet.commons.security.WebDavClient

public class WebDavClient
extends Object

Communicates with a web dav server.

Version:

$Revision$, $Date$

Author:

therter

Constructor Summary

Constructors

Constructor and Description
WebDavClient(Proxy proxy, String username, String password) Creates a new WebDavClient object.
WebDavClient(Proxy proxy, String username, String password, boolean useNTAuth) Creates a new WebDavClient object.

Method Summary

Modifier and Type	Method and Description
int	delete(String path) delete the given path.
InputStream	getInputStream(String path) DOCUMENT ME!
InputStream	getInputStream(String path, Map<String,String> responseHeaders, Map<String,Object> statusValues) DOCUMENT ME!
InputStream	getInputStream(String path, Map<String,String> requestHeaders, Map<String,String> responseHeaders, Map<String,Object> statusValues) DOCUMENT ME!
int	getStatusCode(String url) Gets the http status code via an head request.
void	init(String host) DOCUMENT ME!
void	init(String host, int connectionTimeout) initialises the http client for the given host.
int	mkCol(String url) DOCUMENT ME!
int	put(String path, File input) copies the content of the given file to the given path.
int	put(String path, InputStream input) copies the content of the given InputStream to the given path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebDavClient

public WebDavClient(Proxy proxy,
                    String username,
                    String password)

Creates a new WebDavClient object.

Parameters:

proxy - the currently used proxy or null, if no proxy is used

username - can be null, if no authentication is required

password - can be null, if no authentication is required

WebDavClient

public WebDavClient(Proxy proxy,
                    String username,
                    String password,
                    boolean useNTAuth)

Creates a new WebDavClient object.

Parameters:

proxy - DOCUMENT ME!

username - DOCUMENT ME!

password - DOCUMENT ME!

useNTAuth - DOCUMENT ME!

Method Detail

init

public void init(String host)

DOCUMENT ME!

Parameters:

host - DOCUMENT ME!

init

public void init(String host,
                 int connectionTimeout)

initialises the http client for the given host.

Parameters:

host - DOCUMENT ME!

connectionTimeout - DOCUMENT ME!

delete

public int delete(String path)
           throws MalformedURLException,
                  IOException,
                  org.apache.commons.httpclient.HttpException

delete the given path.

Parameters:

path - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

MalformedURLException - DOCUMENT ME!

IOException - DOCUMENT ME!

org.apache.commons.httpclient.HttpException - DOCUMENT ME!

getInputStream

public InputStream getInputStream(String path)
                           throws MalformedURLException,
                                  IOException,
                                  org.apache.commons.httpclient.HttpException

DOCUMENT ME!

Parameters:

path - DOCUMENT ME!

Returns:

an InputStream from the given path

Throws:

MalformedURLException - DOCUMENT ME!

IOException - DOCUMENT ME!

org.apache.commons.httpclient.HttpException - DOCUMENT ME!

getInputStream

public InputStream getInputStream(String path,
                                  Map<String,String> responseHeaders,
                                  Map<String,Object> statusValues)
                           throws MalformedURLException,
                                  IOException,
                                  org.apache.commons.httpclient.HttpException

DOCUMENT ME!

Parameters:

path - DOCUMENT ME!

responseHeaders - if this is not null, then the given map will be filled with the response headers

statusValues - responseHeaders if this is not null, then the given map will be filled with status code, line, text

Returns:

an InputStream from the given path

Throws:

MalformedURLException - DOCUMENT ME!

IOException - DOCUMENT ME!

org.apache.commons.httpclient.HttpException - DOCUMENT ME!

getInputStream

public InputStream getInputStream(String path,
                                  Map<String,String> requestHeaders,
                                  Map<String,String> responseHeaders,
                                  Map<String,Object> statusValues)
                           throws MalformedURLException,
                                  IOException,
                                  org.apache.commons.httpclient.HttpException

DOCUMENT ME!

Parameters:

path - DOCUMENT ME!

requestHeaders - DOCUMENT ME!

responseHeaders - if this is not null, then the given map will be filled with the response headers

statusValues - responseHeaders if this is not null, then the given map will be filled with status code, line, text

Returns:

an InputStream from the given path

Throws:

MalformedURLException - DOCUMENT ME!

IOException - DOCUMENT ME!

org.apache.commons.httpclient.HttpException - DOCUMENT ME!

mkCol

public int mkCol(String url)
          throws IOException

DOCUMENT ME!

Parameters:

url - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

IOException - DOCUMENT ME!

getStatusCode

public int getStatusCode(String url)
                  throws IOException

Gets the http status code via an head request.

Parameters:

url - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

IOException - DOCUMENT ME!

put

public int put(String path,
               InputStream input)
        throws MalformedURLException,
               IOException,
               org.apache.commons.httpclient.HttpException

copies the content of the given InputStream to the given path.

Parameters:

path - DOCUMENT ME!

input - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

MalformedURLException - DOCUMENT ME!

IOException - DOCUMENT ME!

org.apache.commons.httpclient.HttpException - DOCUMENT ME!

put

public int put(String path,
               File input)
        throws MalformedURLException,
               IOException,
               org.apache.commons.httpclient.HttpException

copies the content of the given file to the given path. This method does use preemptive authentication. So the put request will be only sent once, even if authentication is required

Parameters:

path - DOCUMENT ME!

input - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

MalformedURLException - DOCUMENT ME!

IOException - DOCUMENT ME!

org.apache.commons.httpclient.HttpException - DOCUMENT ME!