org.jahia.params.valves

Class SsoValve

java.lang.Object

org.jahia.params.valves.BaseAuthValve

org.jahia.params.valves.SsoValve

All Implemented Interfaces:

Valve, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public abstract class SsoValve
extends BaseAuthValve

Title: Generic SSO auth valve

Description: authenticate users with a SSO server.

Copyright: Copyright (c) 2005 - Pascal Aubry

Company: University of Rennes 1

Version:

1.0

Author:

Pascal Aubry

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SsoValve.LoginEvent

Constructor Summary

Constructors

Constructor and Description
SsoValve()

Method Summary

Modifier and Type	Method and Description
abstract String	getRedirectUrl(javax.servlet.http.HttpServletRequest request) Return the URL to redirect to for authentication.
void	invoke(Object context, ValveContext valveContext)
boolean	isSkipAuthentication()
abstract Object	retrieveCredentials(javax.servlet.http.HttpServletRequest request) Retrieve the credentials from the request.
void	setFireLoginEvent(boolean fireLoginEvent)
void	setSkipAuthentication(boolean skipAuthentication)
abstract String	validateCredentials(Object credentials, javax.servlet.http.HttpServletRequest request) Validate the credentials.

Methods inherited from class org.jahia.params.valves.BaseAuthValve

addValve, equals, getId, hashCode, indexOf, initialize, isEnabled, removeValve, setBeanName, setEnabled, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

SsoValve

public SsoValve()

Method Detail

setFireLoginEvent

public void setFireLoginEvent(boolean fireLoginEvent)

retrieveCredentials

public abstract Object retrieveCredentials(javax.servlet.http.HttpServletRequest request)
                                    throws Exception

Retrieve the credentials from the request.

Parameters:

request - current request

Returns:

an object.

Throws:

Exception - any exception

validateCredentials

public abstract String validateCredentials(Object credentials,
                                           javax.servlet.http.HttpServletRequest request)
                                    throws JahiaException

Validate the credentials.

Parameters:

credentials - the crendentials.

request - current request

Returns:

the id of user that was authenticated, or null if none.

Throws:

Exception - any exception

JahiaException

invoke

public void invoke(Object context,
                   ValveContext valveContext)
            throws PipelineException

Throws:

PipelineException

See Also:

Valve.invoke(java.lang.Object, org.jahia.pipelines.valves.ValveContext)

getRedirectUrl

public abstract String getRedirectUrl(javax.servlet.http.HttpServletRequest request)
                               throws JahiaException

Return the URL to redirect to for authentication.

Parameters:

request - current request

Returns:

a URL.

Throws:

JahiaInitializationException

JahiaException

isSkipAuthentication

public boolean isSkipAuthentication()

setSkipAuthentication

public void setSkipAuthentication(boolean skipAuthentication)