/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.isis.core.progmodel.facets.actions.invoke;
import java.lang.reflect.Method;
import org.apache.isis.core.commons.lang.NameUtils;
import org.apache.isis.core.commons.lang.StringUtils;
import org.apache.isis.core.metamodel.adapter.map.AdapterMap;
import org.apache.isis.core.metamodel.adapter.map.AdapterMapAware;
import org.apache.isis.core.metamodel.facetapi.Facet;
import org.apache.isis.core.metamodel.facetapi.FacetHolder;
import org.apache.isis.core.metamodel.facetapi.FacetUtil;
import org.apache.isis.core.metamodel.facetapi.FeatureType;
import org.apache.isis.core.metamodel.facets.actions.debug.DebugFacet;
import org.apache.isis.core.metamodel.facets.actions.executed.ExecutedFacet;
import org.apache.isis.core.metamodel.facets.actions.executed.ExecutedFacet.Where;
import org.apache.isis.core.metamodel.facets.actions.exploration.ExplorationFacet;
import org.apache.isis.core.metamodel.facets.actions.invoke.ActionInvocationFacet;
import org.apache.isis.core.metamodel.facets.named.NamedFacet;
import org.apache.isis.core.metamodel.facets.named.NamedFacetInferred;
import org.apache.isis.core.metamodel.spec.ObjectSpecification;
import org.apache.isis.core.progmodel.facets.MethodPrefixBasedFacetFactoryAbstract;
/**
* Sets up {@link ActionInvocationFacet}, along with a number of supporting
* facets that are based on the action's name.
*
* <p>
* The supporting methods are: {@link ExecutedFacet}, {@link ExplorationFacet}
* and {@link DebugFacet}. In addition a {@link NamedFacet} is inferred from the
* name (taking into account the above well-known prefixes).
*/
public class ActionInvocationFacetFactory extends MethodPrefixBasedFacetFactoryAbstract implements AdapterMapAware {
private static final String EXPLORATION_PREFIX = "Exploration";
private static final String DEBUG_PREFIX = "Debug";
private static final String[] PREFIXES = { EXPLORATION_PREFIX, DEBUG_PREFIX, ExecutedFacet.Where.REMOTE_PREFIX, ExecutedFacet.Where.LOCAL_PREFIX };
private AdapterMap adapterMap;
/**
* Note that the {@link Facet}s registered are the generic ones from
* noa-architecture (where they exist)
*/
public ActionInvocationFacetFactory() {
super(FeatureType.ACTIONS_ONLY, PREFIXES);
}
// ///////////////////////////////////////////////////////
// Actions
// ///////////////////////////////////////////////////////
@Override
public void process(final ProcessMethodContext processMethodContext) {
// InvocationFacet
attachInvocationFacet(processMethodContext);
// DebugFacet, ExplorationFacet, ExecutedFacet
attachDebugFacetIfActionMethodNamePrefixed(processMethodContext);
attachExplorationFacetIfActionMethodNamePrefixed(processMethodContext);
attachExecutedFacetIfActionMethodNamePrefixed(processMethodContext);
// inferred name
attachNamedFacetInferredFromMethodName(processMethodContext); // must be
// called
// after
// the
// attachinvocationFacet
// methods
}
private void attachInvocationFacet(final ProcessMethodContext processMethodContext) {
final Method actionMethod = processMethodContext.getMethod();
try {
final Class<?> returnType = actionMethod.getReturnType();
final ObjectSpecification returnSpec = getSpecificationLookup().loadSpecification(returnType);
if (returnSpec == null) {
return;
}
final Class<?> cls = processMethodContext.getCls();
final ObjectSpecification typeSpec = getSpecificationLookup().loadSpecification(cls);
final FacetHolder holder = processMethodContext.getFacetHolder();
FacetUtil.addFacet(new ActionInvocationFacetViaMethod(actionMethod, typeSpec, returnSpec, holder, getAdapterMap()));
} finally {
processMethodContext.removeMethod(actionMethod);
}
}
/**
* Adds the {@link ExecutedFacet} (indicating where the action should be
* executed, either {@link Where#LOCALLY locally} or {@link Where#REMOTELY
* remotely}.
*/
private void attachExecutedFacetIfActionMethodNamePrefixed(final ProcessMethodContext processMethodContext) {
final Method actionMethod = processMethodContext.getMethod();
final Where where = Where.lookup(actionMethod);
if (where == null) {
return;
}
final FacetHolder facetedMethod = processMethodContext.getFacetHolder();
FacetUtil.addFacet(new ExecutedFacetViaNamingConvention(where, facetedMethod));
}
private void attachDebugFacetIfActionMethodNamePrefixed(final ProcessMethodContext processMethodContext) {
final Method actionMethod = processMethodContext.getMethod();
final String capitalizedName = NameUtils.capitalizeName(actionMethod.getName());
if (!capitalizedName.startsWith(DEBUG_PREFIX)) {
return;
}
final FacetHolder facetedMethod = processMethodContext.getFacetHolder();
FacetUtil.addFacet(new DebugFacetViaNamingConvention(facetedMethod));
}
private void attachExplorationFacetIfActionMethodNamePrefixed(final ProcessMethodContext processMethodContext) {
final Method actionMethod = processMethodContext.getMethod();
final String capitalizedName = NameUtils.capitalizeName(actionMethod.getName());
if (!capitalizedName.startsWith(EXPLORATION_PREFIX)) {
return;
}
final FacetHolder facetedMethod = processMethodContext.getFacetHolder();
FacetUtil.addFacet(new ExplorationFacetViaNamingConvention(facetedMethod));
}
/**
* Must be called after added the debug, exploration etc facets.
*
* <p>
* TODO: remove this hack
*/
private void attachNamedFacetInferredFromMethodName(final ProcessMethodContext processMethodContext) {
final Method method = processMethodContext.getMethod();
final String capitalizedName = NameUtils.capitalizeName(method.getName());
// this is nasty...
String name = StringUtils.removePrefix(capitalizedName, ExecutedFacet.Where.LOCAL_PREFIX);
name = StringUtils.removePrefix(name, ExecutedFacet.Where.REMOTE_PREFIX);
name = StringUtils.removePrefix(name, DEBUG_PREFIX);
name = StringUtils.removePrefix(name, EXPLORATION_PREFIX);
name = StringUtils.removePrefix(name, ExecutedFacet.Where.LOCAL_PREFIX);
name = StringUtils.removePrefix(name, ExecutedFacet.Where.REMOTE_PREFIX);
name = NameUtils.naturalName(name);
final FacetHolder facetedMethod = processMethodContext.getFacetHolder();
FacetUtil.addFacet(new NamedFacetInferred(name, facetedMethod));
}
// ///////////////////////////////////////////////////////////////
// Dependencies
// ///////////////////////////////////////////////////////////////
@Override
public void setAdapterMap(final AdapterMap adapterMap) {
this.adapterMap = adapterMap;
}
private AdapterMap getAdapterMap() {
return adapterMap;
}
}