* This task handler provides the necessary functionality to process incoming * requests for local logout in J2EE Policy mode. *
*/ public class LocalLogoutTaskHandler extends AmFilterTaskHandler implements ILocalLogoutTaskHandler { /** * The constructor that takes aManager intance in order
* to gain access to the infrastructure services such as configuration
* and log access.
*
* @param manager the Manager for the filter
* subsystem.
* @throws AgentException if this task handler could not be initialized
*/
public LocalLogoutTaskHandler(Manager manager) throws AgentException {
super(manager);
}
public void initialize(ISSOContext context, AmFilterMode mode)
throws AgentException {
super.initialize(context, mode);
setGlobalLogoutHandler();
initCookieResetHelper();
}
public boolean isActive() {
return isModeJ2EEPolicyActive();
}
private void initCookieResetHelper() throws AgentException {
CookieResetInitializer cookieResetInitializer =
new CookieResetInitializer(getManager());
CommonFactory cf = new CommonFactory(getModule());
setCookieResetHelper(cf.newCookieResetHelper(cookieResetInitializer));
}
/**
* Processes the incoming requests for local logout and suggests
* any necessary action needed in order to achieve this functionality.
*
* @param ctx the AmFilterRequestContext that carries
* information about the incoming request and response objects.
*
* @return null if no action is necessary, or
* AmFilterResult object indicating the necessary action in
* order to handle logout.
* @throws AgentException if this request cannot be handled by the task
* handler successfully.
*/
public AmFilterResult process(AmFilterRequestContext ctx)
throws AgentException
{
AmFilterResult result = null;
//For new feature to allow session data to not be destroyed when a user
//authenticates to AM server and new session is created. RFE issue #763
if (!isSessionBindingEnabled()) {
return result;
}
HttpServletRequest request = ctx.getHttpServletRequest();
HttpServletResponse response = ctx.getHttpServletResponse();
IJ2EELogoutHandler logoutHandler = getLogoutHandler(
getApplicationName(ctx.getHttpServletRequest()));
String userName = ctx.getUserId();
String userDN = ctx.getSSOValidationResult().getUserPrincipal();
String authUser = request.getRemoteUser();
AmFilterMode filterMode = ctx.getFilterMode();
if ( ctx.getSSOValidationResult() != null && logoutHandler != null) {
if (logoutHandler.needToLogoutUser(request, response, userName,
userDN, filterMode, null)){
boolean logoutResult = false;
try {
logoutResult = logoutHandler.logout(request, response, null);
} catch(Exception ex) {
logError(
"AmFilter: Exception caught while doing local logout");
throw new AgentException("Error in local logout", ex);
}
if(logoutResult) {
if(isLogMessageEnabled()) {
logMessage(
"AmFilter: logout successful for user "
+ authUser );
}
doCookiesReset(ctx);
result = ctx.getRedirectToSelfResult();
} else {
if(isLogWarningEnabled()) {
logWarning(
"amFilter: logout failed for user "
+ authUser + ", Access will be denied" );
}
result = ctx.getBlockAccessResult();
}
} else {
if(isLogMessageEnabled()) {
logMessage("AmFilter: local logout skipped"
+ " SSO User => " + userName
+ ", principal =>" + authUser);
}
}
}
return result;
}
private void doCookiesReset(AmFilterRequestContext ctx)
{
HttpServletRequest request = ctx.getHttpServletRequest();
HttpServletResponse response = ctx.getHttpServletResponse();
ICookieResetHelper cookieResetHelper = getCookieResetHelper();
if (cookieResetHelper != null && cookieResetHelper.isActive()) {
cookieResetHelper.doCookiesReset(request, response);
}
}
/**
* Returns a String that can be used to identify this task handler
* @return the name of this task handler
*/
public String getHandlerName() {
return AM_FILTER_LOCAL_LOGOUT_TASK_HANDLER_NAME;
}
private boolean needToLogoutLocally(
HttpServletRequest request,
String ssoUser) {
boolean needToLogout = false;
if (ssoUser != null) {
Principal user = request.getUserPrincipal();
String userName = null;
if (user != null) {
userName = user.getName();
}
if ( userName != null &&
!userName.equals(ssoUser)){
needToLogout = true;
}
if (!needToLogout) {
String remoteUser = request.getRemoteUser();
if (remoteUser != null &&
!remoteUser.equals(ssoUser)) {
needToLogout = true;
}
}
}
return needToLogout;
}
private boolean doLocalLogout(
IJ2EELogoutHandler logoutHandler,
HttpServletRequest request,
HttpServletResponse response)
throws AgentException {
if(isLogMessageEnabled()) {
logMessage(
"LocalLogoutTaskHandler: doing local logout");
}
boolean logoutResult = false;
try {
logoutResult = logoutHandler.logout(request, response, null);
} catch(Exception ex) {
if(isLogMessageEnabled()) {
logMessage(
"LocalLogoutTaskHandler: Exception caught while doing "
+ "local logout");
}
throw new AgentException("Error in local logout", ex);
}
return logoutResult;
}
private void setGlobalLogoutHandler() throws AgentException {
String logoutHandlerClassName =
getResolver().getGlobalJ2EELogoutHandlerImpl();
try {
_globalLogoutHandler = (IJ2EELogoutHandler) Class.forName(
logoutHandlerClassName).newInstance();
} catch(Exception ex) {
throw new AgentException(
"Unable to load Global Logout handler:"
+ logoutHandlerClassName, ex);
}
}
private IJ2EELogoutHandler getGlobalLogoutHandler() {
return _globalLogoutHandler;
}
private void setCookieResetHelper(ICookieResetHelper cookieHelper){
_cookieResetHelper = cookieHelper;
}
protected ICookieResetHelper getCookieResetHelper(){
return _cookieResetHelper;
}
/**
* Method getJ2EEAuthHandler
*
*
* @return
*
*/
private IJ2EELogoutHandler getLogoutHandler(String applicationName)
throws AgentException {
IJ2EELogoutHandler result =
(IJ2EELogoutHandler) getLogoutHandlers().get(applicationName);
if (result == null) {
synchronized(this) {
result = (IJ2EELogoutHandler) getLogoutHandlers().get(
applicationName);
if (result == null) {
Map handlerMap = getManager().getConfigurationMap(
CONFIG_LOGOUT_HANDLER_MAP);
String className = null;
if (handlerMap != null) {
className = (String) handlerMap.get(applicationName);
}
if(className != null) {
try {
result = (IJ2EELogoutHandler)
Class.forName(className).newInstance();
} catch (Exception ex) {
throw new AgentException(
"Unable to initialize logout handler: "
+ className + " for application: "
+ applicationName, ex);
}
}
if (result == null) {
if (isLogMessageEnabled()) {
logMessage(
"AmFilter: using global logout handler for app: "
+ applicationName);
}
result = getGlobalLogoutHandler();
}
getLogoutHandlers().put(applicationName, result);
}
}
}
return result;
}
private Hashtable getLogoutHandlers() {
return _logoutHandlers;
}
private IJ2EELogoutHandler _globalLogoutHandler;
private Hashtable _logoutHandlers = new Hashtable();
private ICookieResetHelper _cookieResetHelper;
}