com.google.code.rees.scope.struts2.programmatic.ProgrammaticModelDrivenConversationUtil Maven / Gradle / Ivy

Go to download

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: ProgrammaticModelDrivenConversationUtil.java reesbyars $
 ******************************************************************************/
package com.google.code.rees.scope.struts2.programmatic;

import java.io.Serializable;

import com.google.code.rees.scope.conversation.ConversationUtil;
import com.google.code.rees.scope.conversation.context.ConversationContext;

/**
 * Utility class that uses the {@link ConversationUtil} and
 * {@link ProgrammaticModelDrivenConversation} interface
 * to assist in programmatic conversation management. Used by the
 * {@link ProgrammaticModelDrivenConversationSupport} class.
 * 
 * In most uses, actions should inherit from the
 * ProgrammaticModelDrivenConversationSupport rather than using this class
 * directly.
 * 
 * @author rees.byars
 * 
 */
public class ProgrammaticModelDrivenConversationUtil {

    public static > void begin(T controller, long maxIdleTime) {
        Object model = controller.getModel();
        for (String conversationName : controller.getConversations()) {
            ConversationContext conversationContext = ConversationUtil.begin(conversationName, maxIdleTime);
            conversationContext.put(conversationName, model);
        }
    }

    public static > void persist(T controller) {
        for (String conversationName : controller.getConversations()) {
            ConversationUtil.persist(conversationName);
        }
    }

    public static > void end(T controller) {
        for (String conversationName : controller.getConversations()) {
            ConversationUtil.end(conversationName);
        }
    }

    @SuppressWarnings("unchecked")
    public static > M getModel(T controller, String modelKey) {
        return (M) ConversationUtil.getField(modelKey);
    }

    public static > void setModel(M model, T controller, String modelKey) {
        ConversationUtil.setField(modelKey, model);
    }

}