org.jasig.portlet.proxy.service.web.interceptor

Class AbstractBasicAuthenticationPreInterceptor

java.lang.Object

org.jasig.portlet.proxy.service.web.interceptor.AuthenticationPreInterceptor

org.jasig.portlet.proxy.service.web.interceptor.AbstractBasicAuthenticationPreInterceptor

All Implemented Interfaces:

IPreInterceptor

Direct Known Subclasses:

PortletPreferencesBasicAuthenticationPreInterceptor, UserInfoBasicAuthenticationPreInterceptor

public abstract class AbstractBasicAuthenticationPreInterceptor
extends AuthenticationPreInterceptor

AbstractBasicAuthenticationPreInterceptor provides common logic for any authentication implementations using BASIC auth.

Version:

$Id: $Id

Author:

Jen Bourey, jennifer.bourey@gmail.com

Field Summary

Fields inherited from class org.jasig.portlet.proxy.service.web.interceptor.AuthenticationPreInterceptor

AUTHENTICATION_TIMEOUT_KEY, AUTHENTICATION_TIMESTAMP_KEY, log

Constructor Summary

Constructors

Constructor and Description
AbstractBasicAuthenticationPreInterceptor()

Method Summary

Modifier and Type	Method and Description
protected abstract org.apache.http.auth.Credentials	getCredentials(javax.portlet.PortletRequest portletRequest) Provide credentials for the current user for this target service.
protected void	prepareAuthentication(HttpContentRequestImpl contentRequest, javax.portlet.PortletRequest portletRequest) Perform authentication or prepare the content request to include authentication parameters.
void	setHttpClientService(IHttpClientService httpClientService) Setter for the field httpClientService.
boolean	validate(HttpContentRequestImpl proxyRequest, javax.portlet.PortletRequest portletRequest) Confirm that the proxyRequest has all of the information required to execute.

Methods inherited from class org.jasig.portlet.proxy.service.web.interceptor.AuthenticationPreInterceptor

intercept, isAlreadyAuthenticated

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBasicAuthenticationPreInterceptor

public AbstractBasicAuthenticationPreInterceptor()

Method Detail

setHttpClientService

@Autowired(required=true)
public void setHttpClientService(IHttpClientService httpClientService)

Setter for the field httpClientService.

Parameters:

httpClientService - a IHttpClientService object

validate

public boolean validate(HttpContentRequestImpl proxyRequest,
                        javax.portlet.PortletRequest portletRequest)

Confirm that the proxyRequest has all of the information required to execute. Refer to the specific implementation for details.

Parameters:

proxyRequest - a HttpContentRequestImpl object

portletRequest - a PortletRequest object

Returns:

true if the proxyRequest has all of the necessary information to be successfully run, otherwise false

prepareAuthentication

protected void prepareAuthentication(HttpContentRequestImpl contentRequest,
                                     javax.portlet.PortletRequest portletRequest)

Perform authentication or prepare the content request to include authentication parameters. Add BASIC authentication credentials to the user's HttpClientService.

Specified by:

prepareAuthentication in class AuthenticationPreInterceptor

Parameters:

contentRequest - a HttpContentRequestImpl object

portletRequest - a PortletRequest object

getCredentials

protected abstract org.apache.http.auth.Credentials getCredentials(javax.portlet.PortletRequest portletRequest)

Provide credentials for the current user for this target service.

Parameters:

portletRequest - a PortletRequest object

Returns:

a Credentials object