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 */
019package org.apache.isis.core.metamodel.facets.object.audit.configuration;
020
021
022import org.apache.isis.applib.services.HasTransactionId;
023import org.apache.isis.core.commons.config.IsisConfiguration;
024import org.apache.isis.core.commons.config.IsisConfigurationAware;
025import org.apache.isis.core.metamodel.facetapi.FacetHolder;
026import org.apache.isis.core.metamodel.facetapi.FacetUtil;
027import org.apache.isis.core.metamodel.facetapi.FeatureType;
028import org.apache.isis.core.metamodel.facets.FacetFactoryAbstract;
029import org.apache.isis.core.metamodel.facets.object.audit.AuditableFacet;
030
031
032public class AuditableFromConfigurationFacetFactory extends FacetFactoryAbstract implements IsisConfigurationAware {
033
034    private static final String AUDIT_OBJECTS_KEY = "isis.services.audit.objects";
035
036    private IsisConfiguration configuration;
037
038    private static enum ObjectCategorization {
039        ALL,
040        NONE;
041        public static ObjectCategorization parse(final String value) {
042            if ("all".equalsIgnoreCase(value)) {
043                return ALL;
044            } else {
045                return NONE;
046            }
047        }
048    }
049    
050
051    public AuditableFromConfigurationFacetFactory() {
052        super(FeatureType.OBJECTS_ONLY);
053    }
054
055    @Override
056    public void process(ProcessClassContext processClassContext) {
057        final String configuredValue = configuration.getString(AUDIT_OBJECTS_KEY);
058        final ObjectCategorization categorization = ObjectCategorization.parse(configuredValue);
059        if(categorization == ObjectCategorization.NONE) {
060            return;
061        }
062        final Class<?> cls = processClassContext.getCls();
063        final FacetHolder facetHolder = processClassContext.getFacetHolder();
064        
065        if(facetHolder.containsDoOpFacet(AuditableFacet.class)) {
066            // do not replace
067            return;
068        }
069        if(HasTransactionId.class.isAssignableFrom(cls)) {
070            // do not install on any implementation of HasTransactionId
071            // (ie commands, audit entries, published events).
072            return; 
073        }
074        
075        FacetUtil.addFacet(new AuditableFacetFromConfiguration(facetHolder));
076        return;
077    }
078
079    // //////////////////////////////////////
080
081    
082    @Override
083    public void setConfiguration(IsisConfiguration configuration) {
084        this.configuration = configuration;
085    }
086
087
088}