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.members.hidden.forsession;
021
022import java.lang.reflect.Method;
023import java.util.Collections;
024import java.util.List;
025
026import org.apache.isis.core.commons.authentication.AuthenticationSession;
027import org.apache.isis.core.commons.authentication.AuthenticationSessionUtils;
028import org.apache.isis.core.commons.lang.MethodExtensions;
029import org.apache.isis.core.metamodel.facetapi.FacetHolder;
030import org.apache.isis.core.metamodel.facets.ImperativeFacet;
031import org.apache.isis.core.metamodel.facets.ImperativeFacet.Intent;
032import org.apache.isis.core.progmodel.facets.members.hidden.HideForSessionFacetAbstract;
033
034public class HideForSessionFacetViaMethod extends HideForSessionFacetAbstract implements ImperativeFacet {
035
036    private final Method method;
037
038    public HideForSessionFacetViaMethod(final Method method, final FacetHolder holder) {
039        super(holder);
040        this.method = method;
041    }
042
043    /**
044     * Returns a singleton list of the {@link Method} provided in the
045     * constructor.
046     */
047    @Override
048    public List<Method> getMethods() {
049        return Collections.singletonList(method);
050    }
051
052    @Override
053    public Intent getIntent(final Method method) {
054        return Intent.CHECK_IF_HIDDEN;
055    }
056
057    @Override
058    public boolean impliesResolve() {
059        return true;
060    }
061
062    @Override
063    public boolean impliesObjectChanged() {
064        return false;
065    }
066
067    /**
068     * Will only check provided that a {@link AuthenticationSession} has been
069     * provided.
070     */
071    @Override
072    public String hiddenReason(final AuthenticationSession session) {
073        if (session == null) {
074            return null;
075        }
076        final int len = method.getParameterTypes().length;
077        final Object[] parameters = new Object[len];
078        parameters[0] = AuthenticationSessionUtils.createUserMemento(session);
079        // TODO: need to change to pick up as non-static rather than static
080        final Boolean isHidden = (Boolean) MethodExtensions.invokeStatic(method, parameters);
081        return isHidden.booleanValue() ? "Hidden" : null;
082    }
083
084    @Override
085    protected String toStringValues() {
086        return "method=" + method;
087    }
088
089}