org.jasig.portlet.emailpreview.service.auth

Interface IAuthenticationService

All Known Implementing Classes:

BaseCredentialsAuthenticationService, CachedPasswordAuthenticationService, CasAuthenticationService, DemoAuthenticationService, PortletPreferencesCredentialsAuthenticationService

public interface IAuthenticationService

Method Summary

Methods

Modifier and Type	Method and Description
List<ConfigurationParameter>	getAdminConfigurationParameters()
javax.mail.Authenticator	getAuthenticator(javax.portlet.PortletRequest request, MailStoreConfiguration config)
Map<String,ConfigurationParameter>	getConfigurationParametersMap()
org.apache.http.auth.Credentials	getCredentials(javax.portlet.PortletRequest req, MailStoreConfiguration config) Returns a credentials object.
String	getKey() Return the unique key for this authentication service.
String	getMailAccountName(javax.portlet.PortletRequest request, MailStoreConfiguration config)
List<ConfigurationParameter>	getUserConfigurationParameters()
boolean	isConfigured(javax.portlet.PortletRequest request, MailStoreConfiguration config) True if the specified parameters contain enough information to build a valid Authenticator if they were passed to the getAuthenticator(PortletRequest, MailStoreConfiguration) method.

Method Detail

getKey

String getKey()

Return the unique key for this authentication service. This key will be used to retrieve an authentication service instance from the registry.

Returns:

isConfigured

boolean isConfigured(javax.portlet.PortletRequest request,
                   MailStoreConfiguration config)

True if the specified parameters contain enough information to build a valid Authenticator if they were passed to the getAuthenticator(PortletRequest, MailStoreConfiguration) method.

Parameters:

request -

config -

Returns:

getAuthenticator

javax.mail.Authenticator getAuthenticator(javax.portlet.PortletRequest request,
                                        MailStoreConfiguration config)

Parameters:

request -

config -

Returns:

getCredentials

org.apache.http.auth.Credentials getCredentials(javax.portlet.PortletRequest req,
                                              MailStoreConfiguration config)

Returns a credentials object. This is for Exchange integration.

Parameters:

req -

config -

Returns:

getMailAccountName

String getMailAccountName(javax.portlet.PortletRequest request,
                        MailStoreConfiguration config)

getAdminConfigurationParameters

List<ConfigurationParameter> getAdminConfigurationParameters()

getUserConfigurationParameters

List<ConfigurationParameter> getUserConfigurationParameters()

getConfigurationParametersMap

Map<String,ConfigurationParameter> getConfigurationParametersMap()