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

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.springframework.web.bind.annotation.RequestMapping;

import com.google.code.rees.scope.conversation.annotations.ConversationController;
import com.google.code.rees.scope.conversation.configuration.DefaultConversationArbitrator;
import com.google.code.rees.scope.util.NamingUtil;

/**
 * A {@link com.google.code.rees.scope.conversation.configuration.ConversationArbitrator
 * ConversationArbitrator} for use with Spring MVC. Looks for
 * {@link RequestMapping} annotations
 * to identify controller action methods.
 * 
 * @author rees.byars
 */
public class SpringConversationArbitrator extends DefaultConversationArbitrator {

    private static final long serialVersionUID = -2131295964932528989L;

    @Override
    protected String[] getConversationsWithInheritance(Class clazz,
            String actionSuffix) {
        List conversations = new ArrayList();
        for (Class conversationControllerClass : getConversationControllers(clazz)) {
            if (clazz.isAnnotationPresent(ConversationController.class)) {
                ConversationController controller = conversationControllerClass
                        .getAnnotation(ConversationController.class);
                String[] newConversations = controller.conversations();
                if (controller.value().equals(
                        ConversationController.DEFAULT_VALUE)) {
                    if (newConversations.length == 0) {
                        newConversations = new String[] { NamingUtil
                                .getConventionName(conversationControllerClass,
                                        actionSuffix) };
                    }
                } else {
                    conversations.add(controller.value());
                }
                conversations.addAll(Arrays.asList(newConversations));
            } else {
                com.google.code.rees.scope.spring.ConversationController controller = conversationControllerClass
                        .getAnnotation(com.google.code.rees.scope.spring.ConversationController.class);
                String[] newConversations = controller.conversations();
                if (controller
                        .value()
                        .equals(com.google.code.rees.scope.spring.ConversationController.DEFAULT_VALUE)) {
                    if (newConversations.length == 0) {
                        newConversations = new String[] { NamingUtil
                                .getConventionName(conversationControllerClass,
                                        actionSuffix) };
                    }
                } else {
                    conversations.add(controller.value());
                }
                conversations.addAll(Arrays.asList(newConversations));
            }
        }
        return conversations.toArray(new String[] {});
    }

    @Override
    protected Set> getConversationControllers(Class clazz) {
        Set> annotatedClasses = new HashSet>();
        for (Class clazzClass : clazz.getInterfaces()) {
            if (clazzClass.isAnnotationPresent(ConversationController.class)
                    || clazzClass
                            .isAnnotationPresent(com.google.code.rees.scope.spring.ConversationController.class)) {
                annotatedClasses.add(clazzClass);
            }
        }
        if (clazz.isAnnotationPresent(ConversationController.class)
                || clazz.isAnnotationPresent(com.google.code.rees.scope.spring.ConversationController.class)) {
            annotatedClasses.add(clazz);
        }
        Class superClass = clazz.getSuperclass();
        if (superClass != null) {
            annotatedClasses.addAll(getConversationControllers(superClass));
        }
        return annotatedClasses;
    }

    @Override
    protected boolean isAction(Method method) {
        return method.isAnnotationPresent(RequestMapping.class);
    }
}