/**
* Copyright (C) 2015 Valkyrie RCP
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.valkyriercp.application.session;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.security.core.Authentication;
import org.valkyriercp.application.config.ApplicationConfig;
import org.valkyriercp.security.LoginEvent;
import org.valkyriercp.security.LogoutEvent;
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.util.HashMap;
import java.util.Map;
/**
* This object is a singleton that will: act as a storage for session and
* user variables, registers itself on ApplicationEvents and can be used
* to monitor changes on the contained variables.
*
* @author Jan Hoskens
*
*/
public final class ApplicationSession implements ApplicationListener
{
@Autowired
private ApplicationSessionInitializer applicationSessionInitializer;
/** Handler managing listeners registered on properties. */
private PropertyChangeSupport propertyChangeSupport = new PropertyChangeSupport(this);
/** Property that can be monitored. */
public static final String USER = "user";
/** Property that can be monitored. */
public static final String USER_ATTRIBUTES = "userAttributes";
/** Property that can be monitored. */
public static final String SESSION_ATTRIBUTES = "sessionAttributes";
/** User attributes map. */
private Map<String, Object> userAttributes = new HashMap<String, Object>();
/** Session attributes map. */
private Map<String, Object> sessionAttributes = new HashMap<String, Object>();
@Autowired
private ApplicationConfig applicationConfig;
/**
* Handle events that influence the session/user context.
*/
public void onApplicationEvent(ApplicationEvent event)
{
if ((event instanceof LoginEvent)
&& (event.getSource() != LoginEvent.NO_AUTHENTICATION))
handleLoginEvent((LoginEvent) event);
else if ((event instanceof LogoutEvent))
handleLogoutEvent((LogoutEvent) event);
}
/**
* When a correct login occurs, read all relevant userinformation into
* session.
*
* @param event
* the loginEvent that triggered this handler.
*/
protected void handleLoginEvent(LoginEvent event)
{
ApplicationSessionInitializer asi = getApplicationSessionInitializer();
if (asi != null)
{
asi.initializeUser();
Map<String, Object> userAttributes = asi.getUserAttributes();
if (userAttributes != null)
{
setUserAttributes(userAttributes);
}
}
Authentication auth = (Authentication) event.getSource();
propertyChangeSupport.firePropertyChange(USER, null, auth);
}
/**
* When a logout occurs, remove all user related information from the
* session.
*
* @param event
* the logoutEvent that triggered this handler.
*/
protected void handleLogoutEvent(LogoutEvent event)
{
clearUser();
Authentication auth = (Authentication) event.getSource();
propertyChangeSupport.firePropertyChange(USER, auth, null);
}
/**
* Set an initializer object containing vars/commands and custom init code.
*
* @param applicationSessionInitializer The application session initializer
*/
public void setApplicationSessionInitializer(ApplicationSessionInitializer applicationSessionInitializer)
{
this.applicationSessionInitializer = applicationSessionInitializer;
}
/**
* @return the applicationSessionInitializer.
*/
public ApplicationSessionInitializer getApplicationSessionInitializer()
{
if (applicationSessionInitializer == null)
{
applicationSessionInitializer = applicationConfig.applicationLifecycleAdvisor().getApplicationSessionInitializer();
}
return applicationSessionInitializer;
}
/**
* Register a listener on the specified property.
*
* @param property
* Property to monitor.
* @param listener
* PropertyChangeListener to add.
*/
public void addPropertyChangeListener(String property, PropertyChangeListener listener)
{
propertyChangeSupport.addPropertyChangeListener(property, listener);
}
/**
* Unregister a listener from the specified property.
*
* @param property
* Property that currently is being monitored.
* @param listener
* PropertyChangeListener to remove.
*/
public void removePropertyChangeListener(String property, PropertyChangeListener listener)
{
propertyChangeSupport.removePropertyChangeListener(property, listener);
}
/**
* Initialize the session attributes.
*/
public void initializeSession()
{
ApplicationSessionInitializer asi = getApplicationSessionInitializer();
if (asi != null)
{
asi.initializeSession();
Map<String, Object> sessionAttributes = asi.getSessionAttributes();
if (sessionAttributes != null)
{
setSessionAttributes(sessionAttributes);
}
propertyChangeSupport.firePropertyChange(SESSION_ATTRIBUTES, null, sessionAttributes);
}
}
/**
* gets a named attribute of the user associated to this context
*
* @param key
* name of the attribute
* @return the attribute value (attribute values are strings)
*/
public Object getUserAttribute(String key)
{
return this.getUserAttribute(key, null);
}
/**
* Get a value from the user attributes map.
*
* @param key
* name of the attribute
* @param defaultValue
* a default value to return if no value is found.
* @return the attribute value
*/
public Object getUserAttribute(String key, Object defaultValue)
{
Object attributeValue = this.userAttributes.get(key);
if (attributeValue == null)
attributeValue = defaultValue;
return attributeValue;
}
/**
* Add a key/value pair to the user attributes map.
*
* @param key
* a unique string code.
* @param newValue
* the associated value.
*/
public void setUserAttribute(String key, Object newValue)
{
Object oldValue = userAttributes.put(key, newValue);
propertyChangeSupport.firePropertyChange(key, oldValue, newValue);
propertyChangeSupport.firePropertyChange(USER_ATTRIBUTES, null, userAttributes);
}
/**
* Add the given key/value pairs to the user attributes.
*
* @param attributes
* a map of key/value pairs.
*/
public void setUserAttributes(Map<String, Object> attributes)
{
userAttributes.putAll(attributes);
propertyChangeSupport.firePropertyChange(USER_ATTRIBUTES, null, userAttributes);
}
/**
* Clear all user attributes.
*/
public void clearUser()
{
this.userAttributes.clear();
propertyChangeSupport.firePropertyChange(USER_ATTRIBUTES, null, null);
}
/**
* Get a value from the session attributes map.
*
* @param key
* name of the attribute
* @return the attribute value
*/
public Object getSessionAttribute(String key)
{
return this.getSessionAttribute(key, null);
}
/**
* Get a value from the session attributes map.
*
* @param key a unique string code
* @param defaultValue the default value if not found
* @return The session attibute or the default value if not found
*/
public Object getSessionAttribute(String key, Object defaultValue)
{
Object attributeValue = this.sessionAttributes.get(key);
if (attributeValue == null)
attributeValue = defaultValue;
return attributeValue;
}
/**
* Add a key/value pair to the session attributes map.
*
* @param key
* a unique string code.
* @param newValue
* the associated value.
*/
public void setSessionAttribute(String key, Object newValue)
{
Object oldValue = sessionAttributes.put(key, newValue);
propertyChangeSupport.firePropertyChange(key, oldValue, newValue);
propertyChangeSupport.firePropertyChange(SESSION_ATTRIBUTES, null, sessionAttributes);
}
/**
* Add the given key/value pairs to the session attributes.
*
* @param attributes
* a map of key/value pairs.
*/
public void setSessionAttributes(Map<String, Object> attributes)
{
this.sessionAttributes.putAll(attributes);
propertyChangeSupport.firePropertyChange(SESSION_ATTRIBUTES, null, sessionAttributes);
}
/**
* Clear all session attributes.
*/
public void clearSession()
{
this.sessionAttributes.clear();
propertyChangeSupport.firePropertyChange(SESSION_ATTRIBUTES, null, sessionAttributes);
}
/**
* Get a value from the user OR session attributes map.
*
* @param key
* name of the attribute
* @return the attribute value
*/
public Object getAttribute(String key)
{
return getAttribute(key, null);
}
/**
* Get a value from the user OR session attributes map.
*
* @param key
* name of the attribute
* @param defaultValue
* a default value to return if no value is found.
* @return the attribute value
*/
public Object getAttribute(String key, Object defaultValue)
{
Object attributeValue = getUserAttribute(key, null);
if (attributeValue != null)
return attributeValue;
attributeValue = getSessionAttribute(key, null);
if (attributeValue != null)
return attributeValue;
return defaultValue;
}
}