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    
020    package org.apache.isis.core.progmodel.facets.actions.executed.annotation;
021    
022    import org.apache.isis.applib.annotation.Executed;
023    import org.apache.isis.core.metamodel.facetapi.FacetHolder;
024    import org.apache.isis.core.metamodel.facetapi.FacetUtil;
025    import org.apache.isis.core.metamodel.facetapi.FeatureType;
026    import org.apache.isis.core.metamodel.facets.AnnotationBasedFacetFactoryAbstract;
027    import org.apache.isis.core.metamodel.facets.actions.executed.ExecutedFacet;
028    import org.apache.isis.core.progmodel.facets.actions.invoke.ActionInvocationFacetFactory;
029    
030    /**
031     * Creates an {@link ExecutedFacet} based on the presence of an {@link Executed} annotation.
032     * 
033     * <p>
034     * {@link ExecutedFacet} can also be installed via a naming convention, see {@link ActionInvocationFacetFactory}.
035     */
036    public class ExecutedAnnotationFacetFactory extends AnnotationBasedFacetFactoryAbstract {
037    
038        public ExecutedAnnotationFacetFactory() {
039            super(FeatureType.ACTIONS_ONLY);
040        }
041    
042        @Override
043        public void process(final ProcessMethodContext processMethodContext) {
044            final Executed annotation = getAnnotation(processMethodContext.getMethod(), Executed.class);
045            FacetUtil.addFacet(create(annotation, processMethodContext.getFacetHolder()));
046        }
047    
048        private ExecutedFacet create(final Executed annotation, final FacetHolder holder) {
049            return annotation == null ? null : new ExecutedFacetAnnotation(decodeWhere(annotation.value()), holder);
050        }
051    
052        protected ExecutedFacet.Where decodeWhere(final Executed.Where where) {
053            if (where == Executed.Where.LOCALLY) {
054                return ExecutedFacet.Where.LOCALLY;
055            }
056            if (where == Executed.Where.REMOTELY) {
057                return ExecutedFacet.Where.REMOTELY;
058            }
059            return null;
060        }
061    
062    }