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