org.jasig.portlet.calendar.adapter.exchange

Class ExchangeCredentialsInitializationService

java.lang.Object

org.jasig.portlet.calendar.adapter.exchange.ExchangeCredentialsInitializationService

All Implemented Interfaces:

IExchangeCredentialsInitializationService, IInitializationService

public class ExchangeCredentialsInitializationService
extends Object
implements IExchangeCredentialsInitializationService

ExchangeCredentialsInitializationService creates a Credentials object from the first one of the following sources (in priority order) and saves it to a ThreadLocal for later use:

1. The configured Exchange Impersonation trusted service account credentials if the username and password are configured in portlet preferences
2. The user's username (login id) and cached password if the Exchange NTLM domain is specified. Typically used for an on-premise Exchange server without using Exchange Impersonation.
3. The user's email address and cached password if the Exchange NTLM domain is not specified. Typically used for Office365 integration without using Exchange Impersonation.

To allow for multiple exchange destinations (on-premise Exchange Server and off-premise Office365) and potentially different environments (different credentials for test environment) the credentials are obtained from a combination of portlet preferences and bean configuration (property files).

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFS_IMPERSONATION_PASSWORD
static String	PREFS_IMPERSONATION_USERNAME
static String	PREFS_NTDOMAIN

Constructor Summary

Constructors

Constructor and Description
ExchangeCredentialsInitializationService()

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.auth.Credentials	createNTCredentials(String ntlmDomain, String username, String password)
String	getImpersonatedAccountId(javax.portlet.PortletRequest request) Calculate the account ID string of the user whose account is being accessed if Exchange Impersonation is being used, else null if not using Exchange Impersonation.
String	getNtlmDomain(javax.portlet.PortletRequest request) Return the configured NTLM Domain if set.
void	initialize(javax.portlet.PortletRequest request) Perform some action.
void	setEnabled(boolean enabled) For unit testing.
void	setMailAttribute(String mailAttribute) Set the name of the user attribute used for retrieving the user's email address.
void	setNtlmDomain(String ntlmDomain) Set the domain to use NTLM authentication.
void	setPasswordAttribute(String passwordAttribute) Set the name of the user attribute to be used for retrieving the Exchange authentication password from the portlet UserInfo map.
void	setUsernameAttribute(String usernameAttribute) Set the name of the user attribute to be used for retrieving the Exchange authentication username from the portlet UserInfo map.
boolean	usesExchangeImpersonation(javax.portlet.PortletRequest request) Returns true if this portlet is configured to use Exchange Impersonation, else false.

Methods inherited from class java.lang.Object

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

Field Detail

PREFS_NTDOMAIN

public static final String PREFS_NTDOMAIN

See Also:

Constant Field Values

PREFS_IMPERSONATION_USERNAME

public static final String PREFS_IMPERSONATION_USERNAME

See Also:

Constant Field Values

PREFS_IMPERSONATION_PASSWORD

public static final String PREFS_IMPERSONATION_PASSWORD

See Also:

Constant Field Values

Constructor Detail

ExchangeCredentialsInitializationService

public ExchangeCredentialsInitializationService()

Method Detail

setEnabled

public void setEnabled(boolean enabled)

For unit testing.

setUsernameAttribute

public void setUsernameAttribute(String usernameAttribute)

Set the name of the user attribute to be used for retrieving the Exchange authentication username from the portlet UserInfo map.

Parameters:

usernameAttribute -

setPasswordAttribute

public void setPasswordAttribute(String passwordAttribute)

Set the name of the user attribute to be used for retrieving the Exchange authentication password from the portlet UserInfo map.

Parameters:

passwordAttribute -

setMailAttribute

public void setMailAttribute(String mailAttribute)

Set the name of the user attribute used for retrieving the user's email address. This is used for Office365 integration when not using Exchange Impersonation.

Parameters:

mailAttribute - name of the user attribute to obtain the user's email address from.

getNtlmDomain

public String getNtlmDomain(javax.portlet.PortletRequest request)

Return the configured NTLM Domain if set. May be null or empty string. Portlet preference value overrides bean configuration value to allow for multiple EWS integrations (on premise plus off-premise).

Specified by:

getNtlmDomain in interface IExchangeCredentialsInitializationService

Parameters:

request - Portlet Request

Returns:

Configured NTLM Domain (may be null or empty string).

setNtlmDomain

public void setNtlmDomain(String ntlmDomain)

Set the domain to use NTLM authentication.

Parameters:

ntlmDomain - NT Domain

initialize

public void initialize(javax.portlet.PortletRequest request)

Description copied from interface: IInitializationService

Perform some action.

Specified by:

initialize in interface IInitializationService

Parameters:

request - user's portlet request

usesExchangeImpersonation

public boolean usesExchangeImpersonation(javax.portlet.PortletRequest request)

Description copied from interface: IExchangeCredentialsInitializationService

Returns true if this portlet is configured to use Exchange Impersonation, else false.

Specified by:

usesExchangeImpersonation in interface IExchangeCredentialsInitializationService

Parameters:

request - Portlet Request

Returns:

true if this portlet is configured to use Exchange Impersonation, else false.

getImpersonatedAccountId

public String getImpersonatedAccountId(javax.portlet.PortletRequest request)

Calculate the account ID string of the user whose account is being accessed if Exchange Impersonation is being used, else null if not using Exchange Impersonation.

Specified by:

getImpersonatedAccountId in interface IExchangeCredentialsInitializationService

Parameters:

request - Portlet Request

Returns:

account ID of the user whose account is being accessed with Exchange Impersonation, else null

createNTCredentials

protected org.apache.http.auth.Credentials createNTCredentials(String ntlmDomain,
                                                               String username,
                                                               String password)