davmail.exchange.auth

Class ExchangeFormAuthenticator

java.lang.Object

davmail.exchange.auth.ExchangeFormAuthenticator

All Implemented Interfaces:

ExchangeAuthenticator

public class ExchangeFormAuthenticator
extends Object
implements ExchangeAuthenticator

New Exchange form authenticator based on HttpClient 4.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	LOGGER
protected static Set<String>	PASSWORD_FIELDS Various password fields found on custom Exchange authentication forms
protected static Set<String>	TOKEN_FIELDS Various OTP (one time password) fields found on custom Exchange authentication forms.
protected static Set<String>	USER_NAME_FIELDS Various username fields found on custom Exchange authentication forms

Constructor Summary

Constructors

Constructor and Description
ExchangeFormAuthenticator()

Method Summary

Modifier and Type	Method and Description
void	authenticate() Authenticate against Exchange or O365
protected PostRequest	buildLogonMethod(HttpClientAdapter httpClient, ResponseWrapper responseWrapper) Try to find logon method path from logon form body.
protected void	checkFormLoginQueryString(ResponseWrapper logonMethod)
void	close() Close session.
protected void	formLogin(HttpClientAdapter httpClient, ResponseWrapper initRequest, String password)
protected URI	getAbsoluteUri(URI uri, String path)
String	getAliasFromLogin() Get current Exchange alias name from login name
URI	getExchangeUri() Base Exchange URL.
HttpClientAdapter	getHttpClientAdapter() Return authenticated HttpClient 4 HttpClientAdapter
protected URI	getScriptBasedFormURL(URI uri, String pathQuery)
O365Token	getToken() Oauth token.
String	getUsername() Actual username.
protected boolean	isAuthenticated(ResponseWrapper getRequest) Look for session cookies.
protected boolean	isHttpAuthentication(HttpClientAdapter httpClient, String url) Test authentication mode : form based or basic.
protected ResponseWrapper	postLogonMethod(HttpClientAdapter httpClient, PostRequest logonMethod, String password)
protected void	setAuthFormFields(org.apache.http.client.methods.HttpRequestBase logonMethod, HttpClientAdapter httpClient, String password)
void	setPassword(String password)
void	setUrl(String url)
void	setUsername(String username)
protected ResponseWrapper	submitLanguageSelectionForm(URI uri, String responseBodyAsString)
protected void	throwAuthenticationFailed()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.apache.log4j.Logger LOGGER

USER_NAME_FIELDS

protected static final Set<String> USER_NAME_FIELDS

Various username fields found on custom Exchange authentication forms

PASSWORD_FIELDS

protected static final Set<String> PASSWORD_FIELDS

Various password fields found on custom Exchange authentication forms

TOKEN_FIELDS

protected static final Set<String> TOKEN_FIELDS

Various OTP (one time password) fields found on custom Exchange authentication forms. Used to open OTP dialog

Constructor Detail

ExchangeFormAuthenticator

public ExchangeFormAuthenticator()

Method Detail

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface ExchangeAuthenticator

setPassword

public void setPassword(String password)

Specified by:

setPassword in interface ExchangeAuthenticator

setUrl

public void setUrl(String url)

authenticate

public void authenticate()
                  throws DavMailException

Description copied from interface: ExchangeAuthenticator

Authenticate against Exchange or O365

Specified by:

authenticate in interface ExchangeAuthenticator

Throws:

DavMailException

isHttpAuthentication

protected boolean isHttpAuthentication(HttpClientAdapter httpClient,
                                       String url)

Test authentication mode : form based or basic.

Parameters:

url - exchange base URL

httpClient - httpClientAdapter instance

Returns:

true if basic authentication detected

isAuthenticated

protected boolean isAuthenticated(ResponseWrapper getRequest)

Look for session cookies.

Returns:

true if session cookies are available

formLogin

protected void formLogin(HttpClientAdapter httpClient,
                         ResponseWrapper initRequest,
                         String password)
                  throws IOException

Throws:

IOException

buildLogonMethod

protected PostRequest buildLogonMethod(HttpClientAdapter httpClient,
                                       ResponseWrapper responseWrapper)

Try to find logon method path from logon form body.

Parameters:

httpClient - httpClientAdapter instance

responseWrapper - init request response wrapper

Returns:

logon method

postLogonMethod

protected ResponseWrapper postLogonMethod(HttpClientAdapter httpClient,
                                          PostRequest logonMethod,
                                          String password)
                                   throws IOException

Throws:

IOException

submitLanguageSelectionForm

protected ResponseWrapper submitLanguageSelectionForm(URI uri,
                                                      String responseBodyAsString)
                                               throws IOException

Throws:

IOException

setAuthFormFields

protected void setAuthFormFields(org.apache.http.client.methods.HttpRequestBase logonMethod,
                                 HttpClientAdapter httpClient,
                                 String password)
                          throws IllegalArgumentException

Throws:

IllegalArgumentException

getAbsoluteUri

protected URI getAbsoluteUri(URI uri,
                             String path)
                      throws URISyntaxException

Throws:

URISyntaxException

getScriptBasedFormURL

protected URI getScriptBasedFormURL(URI uri,
                                    String pathQuery)
                             throws URISyntaxException,
                                    IOException

Throws:

URISyntaxException

IOException

checkFormLoginQueryString

protected void checkFormLoginQueryString(ResponseWrapper logonMethod)
                                  throws DavMailAuthenticationException

Throws:

DavMailAuthenticationException

throwAuthenticationFailed

protected void throwAuthenticationFailed()
                                  throws DavMailAuthenticationException

Throws:

DavMailAuthenticationException

getAliasFromLogin

public String getAliasFromLogin()

Get current Exchange alias name from login name

Returns:

user name

close

public void close()

Close session. Shutdown http client connection manager

getToken

public O365Token getToken()

Oauth token. Only for Office 365 authenticators

Specified by:

getToken in interface ExchangeAuthenticator

Returns:

unsupported

getExchangeUri

public URI getExchangeUri()

Base Exchange URL. Welcome page for Exchange 2003, EWS url for Exchange 2007 and later

Specified by:

getExchangeUri in interface ExchangeAuthenticator

Returns:

Exchange url

getHttpClientAdapter

public HttpClientAdapter getHttpClientAdapter()

Return authenticated HttpClient 4 HttpClientAdapter

Specified by:

getHttpClientAdapter in interface ExchangeAuthenticator

Returns:

HttpClientAdapter instance

getUsername

public String getUsername()

Actual username. may be different from input username with preauth

Returns:

username