com.google.code.rees.scope.conversation.context.TimeoutConversationContextManager Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of struts2-conversation-scope-plugin Show documentation
A Struts2 plugin for leveraging conversation scopes in Struts2
There is a newer version: 1.7.4
Show newest version
/***********************************************************************************************************************
 *
 * Struts2-Conversation-Plugin - An Open Source Conversation- and Flow-Scope Solution for Struts2-based Applications
 * =================================================================================================================
 *
 * Copyright (C) 2012 by Rees Byars
 * http://code.google.com/p/struts2-conversation/
 *
 ***********************************************************************************************************************
 *
 * 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.
 *
 ***********************************************************************************************************************
 *
 * $Id: TimeoutConversationContextManager.java Apr 19, 2012 6:27:47 PM reesbyars $
 *
 **********************************************************************************************************************/
package com.google.code.rees.scope.conversation.context;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.code.rees.scope.util.monitor.TimeoutListener;
import com.google.code.rees.scope.util.monitor.TimeoutMonitor;

/**
 * This class extends the {@link DefaultConversationContextManager} and uses a {@link TimeoutMonitor} to
 * monitor conversations for timeouts.  Using the {@link TimeoutListener} interface, it removes conversations
 * from its cache when they have expired.
 * 
 * @author rees.byars
 *
 */
public class TimeoutConversationContextManager extends DefaultConversationContextManager implements TimeoutListener {

	private static final long serialVersionUID = -4431057690602876686L;
	
	private static final Logger LOG = LoggerFactory.getLogger(TimeoutConversationContextManager.class);
	
	protected TimeoutMonitor conversationTimeoutMonitor;
	
	public void setTimeoutMonitor(TimeoutMonitor conversationTimeoutMonitor) {
		this.conversationTimeoutMonitor = conversationTimeoutMonitor;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public ConversationContext getContext(String conversationName, String conversationId) {
		ConversationContext context = super.getContext(conversationName, conversationId);
		context.addTimeoutListener(this);
		this.conversationTimeoutMonitor.addTimeoutable(context);
		return context;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public ConversationContext remove(String conversationName, String conversationId) {
		ConversationContext context = super.remove(conversationName, conversationId);
		if (context != null) {
			if (LOG.isDebugEnabled()) {
				LOG.debug("Conversation has ended, removing from TimeoutMonitor:  " + conversationName + " with ID " + conversationId);
			}
			this.conversationTimeoutMonitor.removeTimeoutable(context);
		}
		return context;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void onTimeout(ConversationContext expiredConversation) {
		if (LOG.isDebugEnabled()) {
			LOG.debug("Conversation has timed out:  " + expiredConversation.getConversationName() + " with ID " + expiredConversation.getId());
		}
		super.remove(expiredConversation.getConversationName(), expiredConversation.getId());
	}
	
	/**
	 * {@inheritDoc}
	 */
	public void destroy() {
		LOG.debug("Destroying TimeoutConversationContextManager.");
		super.destroy();
		LOG.debug("Destroying TimeoutMonitor.");
		this.conversationTimeoutMonitor.destroy();
		LOG.debug("TimeoutConversationContextManager and TimeoutMonitor destroyed.");
	}

}