001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  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,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019
020package org.apache.isis.core.progmodel.facets.actions.homepage;
021
022import java.util.List;
023
024import com.google.common.base.Joiner;
025import com.google.common.collect.Lists;
026
027import org.apache.isis.applib.annotation.HomePage;
028import org.apache.isis.applib.services.homepage.AbstractHomePageDashboardService;
029import org.apache.isis.core.commons.config.IsisConfiguration;
030import org.apache.isis.core.metamodel.facetapi.FacetUtil;
031import org.apache.isis.core.metamodel.facetapi.FeatureType;
032import org.apache.isis.core.metamodel.facetapi.MetaModelValidatorRefiner;
033import org.apache.isis.core.metamodel.facets.Annotations;
034import org.apache.isis.core.metamodel.facets.FacetFactoryAbstract;
035import org.apache.isis.core.metamodel.facets.FacetedMethod;
036import org.apache.isis.core.metamodel.facets.actions.homepage.HomePageFacet;
037import org.apache.isis.core.metamodel.spec.ObjectSpecification;
038import org.apache.isis.core.metamodel.spec.feature.Contributed;
039import org.apache.isis.core.metamodel.spec.feature.ObjectAction;
040import org.apache.isis.core.metamodel.specloader.validator.MetaModelValidatorComposite;
041import org.apache.isis.core.metamodel.specloader.validator.MetaModelValidatorVisiting;
042import org.apache.isis.core.metamodel.specloader.validator.MetaModelValidatorVisiting.Visitor;
043import org.apache.isis.core.metamodel.specloader.validator.ValidationFailures;
044
045public class HomePageAnnotationFacetFactory extends FacetFactoryAbstract implements MetaModelValidatorRefiner{
046
047    public HomePageAnnotationFacetFactory() {
048        super(FeatureType.ACTIONS_ONLY);
049    }
050
051    @Override
052    public void process(ProcessMethodContext processMethodContext) {
053        final HomePage annotation = Annotations.getAnnotation(processMethodContext.getMethod(), HomePage.class);
054        if (annotation == null) {
055            return;
056        } 
057        final FacetedMethod facetHolder = processMethodContext.getFacetHolder();
058        FacetUtil.addFacet(new HomePageFacetAnnotation(facetHolder));
059    }
060
061    /* (non-Javadoc)
062     * @see org.apache.isis.core.metamodel.facetapi.MetaModelValidatorRefiner#refineMetaModelValidator(org.apache.isis.core.metamodel.specloader.validator.MetaModelValidatorComposite, org.apache.isis.core.commons.config.IsisConfiguration)
063     */
064    @Override
065    public void refineMetaModelValidator(MetaModelValidatorComposite metaModelValidator, IsisConfiguration configuration) {
066        metaModelValidator.add(new MetaModelValidatorVisiting(newValidatorVisitor()));
067    }
068
069    private Visitor newValidatorVisitor() {
070        return new MetaModelValidatorVisiting.SummarizingVisitor() {
071
072            private final List<String> annotated = Lists.newArrayList();
073            
074            @Override
075            public boolean visit(ObjectSpecification objectSpec, ValidationFailures validationFailures) {
076                final List<ObjectAction> objectActions = objectSpec.getObjectActions(Contributed.EXCLUDED);
077                if(objectSpec.getCorrespondingClass() == AbstractHomePageDashboardService.class) {
078                    // ignore this one
079                    return true;
080                }
081                for (ObjectAction objectAction : objectActions) {
082                    if(objectAction.containsFacet(HomePageFacet.class)) {
083                        final String fullIdentifier = objectAction.getIdentifier().toClassAndNameIdentityString();
084                        
085                        // TODO: it would good to flag if the facet is found on any non-services, however
086                        // ObjectSpecification.isService(...) can only be trusted once a PersistenceSession exists.
087                        // this ought to be improved upon at some point...
088                        annotated.add(fullIdentifier);
089                        
090                    }
091                }
092                return true; // keep searching
093            }
094
095            @Override
096            public void summarize(ValidationFailures validationFailures) {
097                if(annotated.size()>1) {
098                    final String nonServiceNamesStr = Joiner.on(", ").join(annotated);
099                    validationFailures.add(
100                            "Only one service action can be specified as the dashboard; "
101                            + "found HomePageFacet on these actions: %s", nonServiceNamesStr);
102                }
103            }
104        };
105    }
106}