org.jahia.params.valves

Class AuthValveContext

java.lang.Object

org.jahia.params.valves.AuthValveContext

public class AuthValveContext
extends Object

User: toto Date: May 14, 2010 Time: 11:18:26 AM

Constructor Summary

Constructors

Constructor and Description
AuthValveContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, JCRSessionFactory sessionFactory)

Method Summary

Modifier and Type	Method and Description
javax.servlet.http.HttpServletRequest	getRequest()
javax.servlet.http.HttpServletResponse	getResponse()
JCRSessionFactory	getSessionFactory()
boolean	isAuthRetrievedFromSession() This method will return true if the auth was indeed retrieved by the session.
void	setAuthRetrievedFromSession(boolean authRetrievedFromSession) A valve that resolves the authentication from an HttpSession attribute should set this value to true.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthValveContext

public AuthValveContext(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        JCRSessionFactory sessionFactory)

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

getSessionFactory

public JCRSessionFactory getSessionFactory()

isAuthRetrievedFromSession

public boolean isAuthRetrievedFromSession()

This method will return true if the auth was indeed retrieved by the session. It is the responsability of the valve to set this value using the setAuthRetrievedFromSession method

Returns:

true if the authentifcation was retrieved from the HttpSession object, false otherwise

setAuthRetrievedFromSession

public void setAuthRetrievedFromSession(boolean authRetrievedFromSession)

A valve that resolves the authentication from an HttpSession attribute should set this value to true. This value will then be used by the JCRSessionFilter and possibly other classes to avoid setting the session attribute once again if the value was read from the session.

Parameters:

authRetrievedFromSession - set to true if the authentication was read from the session, false otherwise. if not yet the default value is false.