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.members.disable.staticmethod;
021    
022    import java.lang.reflect.Method;
023    
024    import org.apache.isis.core.commons.lang.NameUtils;
025    import org.apache.isis.core.metamodel.adapter.util.InvokeUtils;
026    import org.apache.isis.core.metamodel.exceptions.MetaModelException;
027    import org.apache.isis.core.metamodel.facetapi.Facet;
028    import org.apache.isis.core.metamodel.facetapi.FacetHolder;
029    import org.apache.isis.core.metamodel.facetapi.FacetUtil;
030    import org.apache.isis.core.metamodel.facetapi.FeatureType;
031    import org.apache.isis.core.metamodel.methodutils.MethodScope;
032    import org.apache.isis.core.progmodel.facets.MethodFinderUtils;
033    import org.apache.isis.core.progmodel.facets.MethodPrefixBasedFacetFactoryAbstract;
034    import org.apache.isis.core.progmodel.facets.MethodPrefixConstants;
035    
036    public class DisabledFacetViaProtectMethodFacetFactory extends MethodPrefixBasedFacetFactoryAbstract {
037    
038        private static final String[] PREFIXES = { MethodPrefixConstants.PROTECT_PREFIX };
039    
040        /**
041         * Note that the {@link Facet}s registered are the generic ones from noa-architecture (where they exist)
042         */
043        public DisabledFacetViaProtectMethodFacetFactory() {
044            super(FeatureType.MEMBERS, PREFIXES);
045        }
046    
047        // ///////////////////////////////////////////////////////
048        // Actions
049        // ///////////////////////////////////////////////////////
050    
051        @Override
052        public void process(final ProcessMethodContext processMethodContext) {
053            attachDisabledFacetIfProtectMethodIsFound(processMethodContext);
054        }
055    
056        public static void attachDisabledFacetIfProtectMethodIsFound(final ProcessMethodContext processMethodContext) {
057    
058            final Class<?>[] paramTypes = new Class[] {};
059    
060            final Class<?> type = processMethodContext.getCls();
061            final Method method = processMethodContext.getMethod();
062    
063            final String capitalizedName = NameUtils.javaBaseNameStripAccessorPrefixIfRequired(method.getName());
064    
065            final Method protectMethod =
066                MethodFinderUtils.findMethodWithOrWithoutParameters(type, MethodScope.CLASS,
067                    MethodPrefixConstants.PROTECT_PREFIX + capitalizedName, boolean.class, paramTypes);
068            if (protectMethod == null) {
069                return;
070            }
071    
072            processMethodContext.removeMethod(protectMethod);
073    
074            final Boolean protectMethodReturnValue = invokeProtectMethod(protectMethod);
075            if (!protectMethodReturnValue.booleanValue()) {
076                return;
077            }
078    
079            final FacetHolder facetedMethod = processMethodContext.getFacetHolder();
080            FacetUtil.addFacet(new DisabledFacetAlways(facetedMethod));
081        }
082    
083        private static Boolean invokeProtectMethod(final Method protectMethod) {
084            Boolean protectMethodReturnValue = null;
085            try {
086                protectMethodReturnValue = (Boolean) InvokeUtils.invokeStatic(protectMethod);
087            } catch (final ClassCastException ex) {
088                // ignore
089            }
090            if (protectMethodReturnValue == null) {
091                throw new MetaModelException("method " + protectMethod + "must return a boolean");
092            }
093            return protectMethodReturnValue;
094        }
095    
096    }