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.object.bookmarkable.annotation;
021
022import java.lang.reflect.Method;
023import java.util.List;
024
025import org.apache.isis.applib.annotation.ActionSemantics.Of;
026import org.apache.isis.applib.annotation.BookmarkPolicy;
027import org.apache.isis.applib.annotation.Bookmarkable;
028import org.apache.isis.applib.annotation.Title;
029import org.apache.isis.core.commons.config.IsisConfiguration;
030import org.apache.isis.core.metamodel.adapter.mgr.AdapterManagerAware;
031import org.apache.isis.core.metamodel.facetapi.FacetHolder;
032import org.apache.isis.core.metamodel.facetapi.FacetUtil;
033import org.apache.isis.core.metamodel.facetapi.FeatureType;
034import org.apache.isis.core.metamodel.facetapi.MetaModelValidatorRefiner;
035import org.apache.isis.core.metamodel.facets.Annotations;
036import org.apache.isis.core.metamodel.facets.FacetFactoryAbstract;
037import org.apache.isis.core.metamodel.facets.actions.semantics.ActionSemanticsFacet;
038import org.apache.isis.core.metamodel.facets.object.bookmarkable.BookmarkPolicyFacet;
039import org.apache.isis.core.metamodel.facets.object.bookmarkable.BookmarkPolicyFacetFallback;
040import org.apache.isis.core.metamodel.facets.object.bookmarkable.BookmarkPolicyFacetViaBookmarkableAnnotation;
041import org.apache.isis.core.metamodel.methodutils.MethodScope;
042import org.apache.isis.core.metamodel.spec.ObjectSpecification;
043import org.apache.isis.core.metamodel.spec.feature.Contributed;
044import org.apache.isis.core.metamodel.spec.feature.ObjectAction;
045import org.apache.isis.core.metamodel.specloader.validator.MetaModelValidatorComposite;
046import org.apache.isis.core.metamodel.specloader.validator.MetaModelValidatorVisiting;
047import org.apache.isis.core.metamodel.specloader.validator.ValidationFailures;
048import org.apache.isis.core.progmodel.facets.MethodFinderUtils;
049import org.apache.isis.core.progmodel.facets.object.title.TitleMethodFacetFactory;
050
051public class BookmarkableAnnotationFacetFactory extends FacetFactoryAbstract implements MetaModelValidatorRefiner {
052
053    public BookmarkableAnnotationFacetFactory() {
054        super(FeatureType.OBJECTS_AND_ACTIONS);
055    }
056
057    @Override
058    public void process(final ProcessClassContext processClassContext) {
059        final Bookmarkable annotation = Annotations.getAnnotation(processClassContext.getCls(), Bookmarkable.class);
060        FacetUtil.addFacet(create(annotation, processClassContext.getFacetHolder()));
061    }
062
063    @Override
064    public void process(final ProcessMethodContext processMethodContext) {
065        final Bookmarkable annotation = Annotations.getAnnotation(processMethodContext.getMethod(), Bookmarkable.class);
066        FacetUtil.addFacet(create(annotation, processMethodContext.getFacetHolder()));
067    }
068
069    private BookmarkPolicyFacet create(final Bookmarkable annotation, final FacetHolder holder) {
070        return annotation == null ? new BookmarkPolicyFacetFallback(holder) : new BookmarkPolicyFacetViaBookmarkableAnnotation(holder, annotation.value());
071    }
072
073
074    /**
075     * Violation if there is an action that is bookmarkable but does not have safe action semantics.
076     */
077    @Override
078    public void refineMetaModelValidator(MetaModelValidatorComposite metaModelValidator, IsisConfiguration configuration) {
079        metaModelValidator.add(new MetaModelValidatorVisiting(new MetaModelValidatorVisiting.Visitor() {
080
081            @Override
082            public boolean visit(ObjectSpecification objectSpec, ValidationFailures validationFailures) {
083                final Class<?> cls = objectSpec.getCorrespondingClass();
084                
085                final List<ObjectAction> objectActions = objectSpec.getObjectActions(Contributed.EXCLUDED);
086                for (final ObjectAction objectAction : objectActions) {
087                    final BookmarkPolicyFacet bookmarkFacet = objectAction.getFacet(BookmarkPolicyFacet.class);
088                    if(bookmarkFacet == null || bookmarkFacet.isNoop() || bookmarkFacet.value() == BookmarkPolicy.NEVER) {
089                        continue;
090                    }
091                    final ActionSemanticsFacet semanticsFacet = objectAction.getFacet(ActionSemanticsFacet.class);
092                    if(semanticsFacet == null || semanticsFacet.isNoop() || semanticsFacet.value() != Of.SAFE) {
093                      validationFailures.add(
094                      "Action %s is bookmarkable but action semantics are not explicitly indicated as being safe.  Either add @ActionSemantics(Of.Safe), or remove @Bookmarkable.", 
095                      objectAction.getIdentifier().toClassAndNameIdentityString());
096                    }
097                }
098                return true;
099            }
100        }));
101    }
102
103}