org.jasig.portlet.emailpreview.service

Interface ICredentialsProvider

All Known Implementing Classes:

MailCredentialsProvider

public interface ICredentialsProvider

Obtains the credentials and stores them into accessible location for mail server communication.

Author:

James Wennmacher, jwennmacher@unicon.net

Method Summary

Methods

Modifier and Type	Method and Description
javax.mail.Authenticator	getAuthenticator() Returns a Javamail Authenticator object for the current operation.
org.apache.http.auth.Credentials	getCredentials() Returns an Apache Credentials object for the current operation.
String	getUsername() Returns the username.
void	initialize(javax.portlet.PortletRequest request, MailStoreConfiguration config, IAuthenticationService authService) Initializes the credentials provider service.

Method Detail

initialize

void initialize(javax.portlet.PortletRequest request,
              MailStoreConfiguration config,
              IAuthenticationService authService)

Initializes the credentials provider service.

Parameters:

request - Portlet request

config - Mail configuration

authService - Authentication service

getCredentials

org.apache.http.auth.Credentials getCredentials()

Returns an Apache Credentials object for the current operation.

Returns:

Credentials object

getAuthenticator

javax.mail.Authenticator getAuthenticator()

Returns a Javamail Authenticator object for the current operation.

Returns:

Javamail Authenticator object

getUsername

String getUsername()

Returns the username.

Returns:

Current user's Username