GroovyAwareMVCGroupManager.java
001 /*
002  * SPDX-License-Identifier: Apache-2.0
003  *
004  * Copyright 2008-2017 the original author or authors.
005  *
006  * Licensed under the Apache License, Version 2.0 (the "License");
007  * you may not use this file except in compliance with the License.
008  * You may obtain a copy of the License at
009  *
010  *     http://www.apache.org/licenses/LICENSE-2.0
011  *
012  * Unless required by applicable law or agreed to in writing, software
013  * distributed under the License is distributed on an "AS IS" BASIS,
014  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015  * See the License for the specific language governing permissions and
016  * limitations under the License.
017  */
018 package org.codehaus.griffon.runtime.groovy.mvc;
019 
020 import griffon.core.ApplicationClassLoader;
021 import griffon.core.GriffonApplication;
022 import griffon.core.mvc.MVCGroup;
023 import griffon.util.BuilderCustomizer;
024 import griffon.util.CompositeBuilder;
025 import griffon.util.Instantiator;
026 import groovy.util.FactoryBuilderSupport;
027 import org.codehaus.griffon.runtime.core.mvc.DefaultMVCGroupManager;
028 import org.slf4j.Logger;
029 import org.slf4j.LoggerFactory;
030 
031 import javax.annotation.Nonnull;
032 import javax.inject.Inject;
033 import java.util.Collection;
034 import java.util.Map;
035 
036 import static griffon.core.GriffonExceptionHandler.sanitize;
037 import static griffon.util.AnnotationUtils.sortByDependencies;
038 import static org.codehaus.griffon.runtime.groovy.mvc.GroovyAwareMVCGroup.BUILDER;
039 import static org.codehaus.griffon.runtime.groovy.mvc.GroovyAwareMVCGroup.CURRENT_MVCGROUP;
040 
041 /**
042  @author Andres Almiray
043  */
044 public class GroovyAwareMVCGroupManager extends DefaultMVCGroupManager {
045     private static final Logger LOG = LoggerFactory.getLogger(DefaultMVCGroupManager.class);
046     private static final String BUILDER_CUSTOMIZER = "BuilderCustomizer";
047 
048     @Inject
049     public GroovyAwareMVCGroupManager(@Nonnull GriffonApplication application, @Nonnull ApplicationClassLoader applicationClassLoader, @Nonnull Instantiator instantiator) {
050         super(application, applicationClassLoader, instantiator);
051     }
052 
053     @Nonnull
054     @Override
055     @SuppressWarnings("unchecked")
056     protected Map<String, Object> instantiateMembers(@Nonnull Map<String, ClassHolder> classMap, @Nonnull Map<String, Object> args) {
057         Map<String, Object> map = super.instantiateMembers(classMap, args);
058         FactoryBuilderSupport builder = createBuilder(getApplication());
059         map.put(BUILDER, builder);
060         return map;
061     }
062 
063     @Nonnull
064     protected FactoryBuilderSupport createBuilder(@Nonnull GriffonApplication application) {
065         Collection<BuilderCustomizer> customizers = resolveBuilderCustomizers(application);
066         return new CompositeBuilder(customizers.toArray(new BuilderCustomizer[customizers.size()]));
067     }
068 
069     @Override
070     @SuppressWarnings("ConstantConditions")
071     protected void adjustMvcArguments(@Nonnull MVCGroup group, @Nonnull Map<String, Object> args) {
072         super.adjustMvcArguments(group, args);
073         FactoryBuilderSupport builder = (FactoryBuilderSupportgroup.getMember(BUILDER);
074         args.put(BUILDER, builder);
075         for (Map.Entry<String, Object> variable : args.entrySet()) {
076             builder.setVariable(variable.getKey(), variable.getValue());
077         }
078     }
079 
080     @Override
081     protected void initializeMembers(@Nonnull MVCGroup group, @Nonnull Map<String, Object> args) {
082         FactoryBuilderSupport builder = (FactoryBuilderSupportgroup.getMember(BUILDER);
083         builder.setVariable(CURRENT_MVCGROUP, group);
084         super.initializeMembers(group, args);
085     }
086 
087     @Override
088     protected void destroyMembers(@Nonnull MVCGroup group, boolean fireDestructionEvents) {
089         super.destroyMembers(group, fireDestructionEvents);
090 
091         try {
092             FactoryBuilderSupport builder = (FactoryBuilderSupportgroup.getMember(BUILDER);
093             if (builder != null) {
094                 builder.dispose();
095                 builder.getVariables().clear();
096             }
097         catch (Exception e) {
098             // TODO find out why this call breaks applet mode on shutdown
099             LOG.error("Application encountered an error while destroying group '" + group.getMvcId() "'", sanitize(e));
100         }
101     }
102 
103     @Nonnull
104     protected Collection<BuilderCustomizer> resolveBuilderCustomizers(@Nonnull GriffonApplication application) {
105         Collection<BuilderCustomizer> customizerInstances = application.getInjector().getInstances(BuilderCustomizer.class);
106         return sortByDependencies(customizerInstances, BUILDER_CUSTOMIZER, "customizer").values();
107     }
108 }