com.google.code.rees.scope.conversation.context.ConversationContextManager 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: ConversationContextManager.java reesbyars $
 ******************************************************************************/
package com.google.code.rees.scope.conversation.context;

import java.io.Serializable;

/**
 * Uses a {@link ConversationContextFactory} to manage the creation, caching,
 * retrieval, removal, and expiration of conversations
 * 
 * @author rees.byars
 * 
 */
public interface ConversationContextManager extends Serializable {
	
	/**
	 * Set the default max idle time for {@link ConversationContext ConversationContexts} managed by this manager
	 * 
	 * @param maxIdleTime
	 */
	public void setDefaultMaxIdleTime(long maxIdleTimeMillis);

	/**
	 * Set the max number of cached {@link ConversationContext
	 * ConversationContexts}.
	 * 
	 * @param maxInstances
	 */
	public void setMaxInstances(int maxInstances);

	/**
	 * Set the {@link ConversationContextFactory} to be used by this manager
	 * 
	 * @param contextFactory
	 */
	public void setContextFactory(ConversationContextFactory contextFactory);

	/**
	 * Retrieve the context identified by the given information, creating a new
	 * one if none exists.
	 * 
	 * @param conversationName
	 * @param conversationId
	 * @return
	 */
	public ConversationContext getContext(String conversationName, String conversationId);
	
	/**
	 * Retrieve the context identified by the given information, creating a new
	 * one if none exists.
	 * 
	 * @param conversationName
	 * @param conversationId
	 * @param maxIdleTimeMillis
	 * @return
	 */
	public ConversationContext getContext(String conversationName, String conversationId, long maxIdleTimeMillis);

	/**
	 * Remove the context identified by the given information, returning the
	 * context being removed
	 * 
	 * @param conversationName
	 * @param conversationId
	 * @return
	 */
	public ConversationContext remove(String conversationName, String conversationId);
	
	/**
	 * Cleanup and release the manager's resources
	 */
	public void destroy();

}