davmail.http

Class DavGatewayHttpClientFacade

java.lang.Object

davmail.http.DavGatewayHttpClientFacade

public final class DavGatewayHttpClientFacade
extends Object

Create HttpClient instance according to DavGateway Settings

Field Summary

Fields

Modifier and Type	Field and Description
static String	IE_USER_AGENT

Method Summary

Modifier and Type	Method and Description
static boolean	acceptsNTLMOnly(org.apache.commons.httpclient.HttpMethod getMethod) Test method header for supported authentication mode, return true if Basic authentication is not available
static void	addNTLM(org.apache.commons.httpclient.HttpClient httpClient) Enable NTLM authentication on http client
static org.apache.http.client.HttpResponseException	buildHttpResponseException(org.apache.commons.httpclient.HttpMethod method) Build Http Exception from method status
static void	close(org.apache.commons.httpclient.HttpClient httpClient) Make sure we close all connections immediately after a session creation failure.
static void	configureClient(org.apache.commons.httpclient.HttpClient httpClient, String url) Update http client configuration (proxy)
static void	createMultiThreadedHttpConnectionManager(org.apache.commons.httpclient.HttpClient httpClient) Create and set connection pool.
static int	executeDeleteMethod(org.apache.commons.httpclient.HttpClient httpClient, String path) Execute a delete method on the given path with httpClient.
static org.apache.commons.httpclient.HttpMethod	executeFollowRedirects(org.apache.commons.httpclient.HttpClient httpClient, org.apache.commons.httpclient.HttpMethod method) Execute method with httpClient, follow 30x redirects.
static org.apache.commons.httpclient.HttpMethod	executeFollowRedirects(org.apache.commons.httpclient.HttpClient httpClient, String url) Execute given url, manually follow redirects.
static void	executeGetMethod(org.apache.commons.httpclient.HttpClient httpClient, org.apache.commons.httpclient.methods.GetMethod method, boolean followRedirects) Execute Get method, do not follow redirects.
static int	executeHttpMethod(org.apache.commons.httpclient.HttpClient httpClient, org.apache.commons.httpclient.HttpMethod method) Execute method with httpClient.
static org.apache.jackrabbit.webdav.MultiStatusResponse[]	executeMethod(org.apache.commons.httpclient.HttpClient httpClient, org.apache.jackrabbit.webdav.client.methods.DavMethodBase method) Execute webdav request.
static org.apache.jackrabbit.webdav.MultiStatusResponse[]	executeMethod(org.apache.commons.httpclient.HttpClient httpClient, ExchangeDavMethod method) Execute webdav request.
protected static int	executeMethodFollowRedirectOnce(org.apache.commons.httpclient.HttpClient httpClient, org.apache.commons.httpclient.HttpMethod method) Execute method, redirect once if returned status is redirect.
static int	executeNoRedirect(org.apache.commons.httpclient.HttpClient httpClient, org.apache.commons.httpclient.HttpMethod method) Execute method with httpClient, do not follow 30x redirects.
static org.apache.jackrabbit.webdav.MultiStatusResponse[]	executePropFindMethod(org.apache.commons.httpclient.HttpClient httpClient, String path, int depth, org.apache.jackrabbit.webdav.property.DavPropertyNameSet properties) Execute webdav propfind method.
static org.apache.jackrabbit.webdav.MultiStatusResponse[]	executeSearchMethod(org.apache.commons.httpclient.HttpClient httpClient, String path, String searchRequest, int maxCount) Execute webdav search method.
static int	executeTestMethod(org.apache.commons.httpclient.HttpClient httpClient, org.apache.commons.httpclient.methods.GetMethod method) Execute test method from checkConfig, with proxy credentials, but without Exchange credentials.
static int	getHttpStatus(org.apache.commons.httpclient.HttpClient httpClient, String url) Get Http Status code for the given URL
static org.apache.commons.httpclient.HttpClient	getInstance(String url) Create a configured HttpClient instance.
static String	getUserAgent()
static boolean	hasNTLMorNegotiate(org.apache.commons.httpclient.HttpClient httpClient) Test if NTLM auth scheme is enabled.
static boolean	isGzipEncoded(org.apache.commons.httpclient.HttpMethod method) Test if the method response is gzip encoded
protected static boolean	isNoProxyFor(URI uri)
static boolean	isRedirect(int status) Check if status is a redirect (various 30x values).
static void	setClientHost(org.apache.commons.httpclient.HttpClient httpClient, String url) Set http client current host configuration.
static void	setCredentials(org.apache.commons.httpclient.HttpClient httpClient, String userName, String password) Set credentials on HttpClient instance.
static void	start() Create and start a new HttpConnectionManager, close idle connections every minute.
static void	stop() Stop HttpConnectionManager.

Methods inherited from class java.lang.Object

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

Field Detail

IE_USER_AGENT

public static final String IE_USER_AGENT

See Also:

Constant Field Values

Method Detail

getInstance

public static org.apache.commons.httpclient.HttpClient getInstance(String url)
                                                            throws DavMailException

Create a configured HttpClient instance.

Parameters:

url - target url

Returns:

httpClient

Throws:

DavMailException - on error

setCredentials

public static void setCredentials(org.apache.commons.httpclient.HttpClient httpClient,
                                  String userName,
                                  String password)

Set credentials on HttpClient instance.

Parameters:

httpClient - httpClient instance

userName - user name

password - user password

setClientHost

public static void setClientHost(org.apache.commons.httpclient.HttpClient httpClient,
                                 String url)
                          throws DavMailException

Set http client current host configuration.

Parameters:

httpClient - current Http client

url - target url

Throws:

DavMailException - on error

isNoProxyFor

protected static boolean isNoProxyFor(URI uri)

configureClient

public static void configureClient(org.apache.commons.httpclient.HttpClient httpClient,
                                   String url)
                            throws DavMailException

Update http client configuration (proxy)

Parameters:

httpClient - current Http client

url - target url

Throws:

DavMailException - on error

close

public static void close(org.apache.commons.httpclient.HttpClient httpClient)

Make sure we close all connections immediately after a session creation failure.

Parameters:

httpClient - http client to close

getHttpStatus

public static int getHttpStatus(org.apache.commons.httpclient.HttpClient httpClient,
                                String url)

Get Http Status code for the given URL

Parameters:

httpClient - httpClient instance

url - url string

Returns:

HttpStatus code

isRedirect

public static boolean isRedirect(int status)

Check if status is a redirect (various 30x values).

Parameters:

status - Http status

Returns:

true if status is a redirect

executeFollowRedirects

public static org.apache.commons.httpclient.HttpMethod executeFollowRedirects(org.apache.commons.httpclient.HttpClient httpClient,
                                                                              String url)
                                                                       throws IOException

Execute given url, manually follow redirects. Workaround for HttpClient bug (GET full URL over HTTPS and proxy)

Parameters:

httpClient - HttpClient instance

url - url string

Returns:

executed method

Throws:

IOException - on error

executeFollowRedirects

public static org.apache.commons.httpclient.HttpMethod executeFollowRedirects(org.apache.commons.httpclient.HttpClient httpClient,
                                                                              org.apache.commons.httpclient.HttpMethod method)
                                                                       throws IOException

Execute method with httpClient, follow 30x redirects.

Parameters:

httpClient - Http client instance

method - Http method

Returns:

last http method after redirects

Throws:

IOException - on error

executeNoRedirect

public static int executeNoRedirect(org.apache.commons.httpclient.HttpClient httpClient,
                                    org.apache.commons.httpclient.HttpMethod method)
                             throws IOException

Execute method with httpClient, do not follow 30x redirects.

Parameters:

httpClient - Http client instance

method - Http method

Returns:

status

Throws:

IOException - on error

executeSearchMethod

public static org.apache.jackrabbit.webdav.MultiStatusResponse[] executeSearchMethod(org.apache.commons.httpclient.HttpClient httpClient,
                                                                                     String path,
                                                                                     String searchRequest,
                                                                                     int maxCount)
                                                                              throws IOException

Execute webdav search method.

Parameters:

httpClient - http client instance

path - encoded searched folder path

searchRequest - (SQL like) search request

maxCount - max item count

Returns:

Responses enumeration

Throws:

IOException - on error

executePropFindMethod

public static org.apache.jackrabbit.webdav.MultiStatusResponse[] executePropFindMethod(org.apache.commons.httpclient.HttpClient httpClient,
                                                                                       String path,
                                                                                       int depth,
                                                                                       org.apache.jackrabbit.webdav.property.DavPropertyNameSet properties)
                                                                                throws IOException

Execute webdav propfind method.

Parameters:

httpClient - http client instance

path - encoded searched folder path

depth - propfind request depth

properties - propfind requested properties

Returns:

Responses enumeration

Throws:

IOException - on error

executeDeleteMethod

public static int executeDeleteMethod(org.apache.commons.httpclient.HttpClient httpClient,
                                      String path)
                               throws IOException

Execute a delete method on the given path with httpClient.

Parameters:

httpClient - Http client instance

path - Path to be deleted

Returns:

http status

Throws:

IOException - on error

executeMethod

public static org.apache.jackrabbit.webdav.MultiStatusResponse[] executeMethod(org.apache.commons.httpclient.HttpClient httpClient,
                                                                               org.apache.jackrabbit.webdav.client.methods.DavMethodBase method)
                                                                        throws IOException

Execute webdav request.

Parameters:

httpClient - http client instance

method - webdav method

Returns:

Responses enumeration

Throws:

IOException - on error

executeMethodFollowRedirectOnce

protected static int executeMethodFollowRedirectOnce(org.apache.commons.httpclient.HttpClient httpClient,
                                                     org.apache.commons.httpclient.HttpMethod method)
                                              throws IOException

Execute method, redirect once if returned status is redirect.

Parameters:

httpClient - http client

method - http method

Returns:

status

Throws:

IOException - on error

executeMethod

public static org.apache.jackrabbit.webdav.MultiStatusResponse[] executeMethod(org.apache.commons.httpclient.HttpClient httpClient,
                                                                               ExchangeDavMethod method)
                                                                        throws IOException

Execute webdav request.

Parameters:

httpClient - http client instance

method - webdav method

Returns:

Responses enumeration

Throws:

IOException - on error

executeHttpMethod

public static int executeHttpMethod(org.apache.commons.httpclient.HttpClient httpClient,
                                    org.apache.commons.httpclient.HttpMethod method)
                             throws IOException

Execute method with httpClient.

Parameters:

httpClient - Http client instance

method - Http method

Returns:

Http status

Throws:

IOException - on error

hasNTLMorNegotiate

public static boolean hasNTLMorNegotiate(org.apache.commons.httpclient.HttpClient httpClient)

Test if NTLM auth scheme is enabled.

Parameters:

httpClient - HttpClient instance

Returns:

true if NTLM is enabled

addNTLM

public static void addNTLM(org.apache.commons.httpclient.HttpClient httpClient)

Enable NTLM authentication on http client

Parameters:

httpClient - HttpClient instance

acceptsNTLMOnly

public static boolean acceptsNTLMOnly(org.apache.commons.httpclient.HttpMethod getMethod)

Test method header for supported authentication mode, return true if Basic authentication is not available

Parameters:

getMethod - http method

Returns:

true if only NTLM is enabled

executeTestMethod

public static int executeTestMethod(org.apache.commons.httpclient.HttpClient httpClient,
                                    org.apache.commons.httpclient.methods.GetMethod method)
                             throws IOException

Execute test method from checkConfig, with proxy credentials, but without Exchange credentials.

Parameters:

httpClient - Http client instance

method - Http method

Returns:

Http status

Throws:

IOException - on error

executeGetMethod

public static void executeGetMethod(org.apache.commons.httpclient.HttpClient httpClient,
                                    org.apache.commons.httpclient.methods.GetMethod method,
                                    boolean followRedirects)
                             throws IOException

Execute Get method, do not follow redirects.

Parameters:

httpClient - Http client instance

method - Http method

followRedirects - Follow redirects flag

Throws:

IOException - on error

buildHttpResponseException

public static org.apache.http.client.HttpResponseException buildHttpResponseException(org.apache.commons.httpclient.HttpMethod method)

Build Http Exception from method status

Parameters:

method - Http Method

Returns:

Http Exception

isGzipEncoded

public static boolean isGzipEncoded(org.apache.commons.httpclient.HttpMethod method)

Test if the method response is gzip encoded

Parameters:

method - http method

Returns:

true if response is gzip encoded

stop

public static void stop()

Stop HttpConnectionManager.

createMultiThreadedHttpConnectionManager

public static void createMultiThreadedHttpConnectionManager(org.apache.commons.httpclient.HttpClient httpClient)

Create and set connection pool.

Parameters:

httpClient - httpClient instance

start

public static void start()

Create and start a new HttpConnectionManager, close idle connections every minute.

getUserAgent

public static String getUserAgent()