All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.openmdx.audit2.aop1.Involvement_1 Maven / Gradle / Ivy

Go to download

openMDX/Client Library

There is a newer version: 2.18.10
Show newest version
/*
 * ====================================================================
 * Project:     openMDX/Core, http://www.openmdx.org/
 * Description: Involvement_1 
 * Owner:       OMEX AG, Switzerland, http://www.omex.ch
 * ====================================================================
 *
 * This software is published under the BSD license as listed below.
 * 
 * Copyright (c) 2009-2014, OMEX AG, Switzerland
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 * 
 * * Neither the name of the openMDX team nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * ------------------
 * 
 * This product includes software developed by other organizations as
 * listed in the NOTICE file.
 */
package org.openmdx.audit2.aop1;

import java.util.Collections;
import java.util.Date;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import javax.jdo.JDOObjectNotFoundException;

import org.openmdx.audit2.spi.Configuration;
import org.openmdx.audit2.spi.InvolvementPersistence;
import org.openmdx.base.accessor.cci.Container_1_0;
import org.openmdx.base.accessor.cci.DataObject_1_0;
import org.openmdx.base.accessor.cci.SystemAttributes;
import org.openmdx.base.accessor.view.Interceptor_1;
import org.openmdx.base.accessor.view.ObjectView_1_0;
import org.openmdx.base.exception.ServiceException;
import org.openmdx.base.mof.cci.ModelElement_1_0;
import org.openmdx.base.mof.cci.ModelHelper;
import org.openmdx.base.naming.Path;
import org.openmdx.base.persistence.spi.ExtentCollection;
import org.openmdx.base.persistence.spi.SharedObjects;
import org.openmdx.base.query.Filter;
import org.openmdx.base.query.IsInCondition;
import org.openmdx.base.query.IsInstanceOfCondition;
import org.openmdx.base.query.IsLikeCondition;
import org.openmdx.base.query.Quantifier;

/**
 * Involvement_1
 */
public class Involvement_1 extends Interceptor_1 {

    /**
     * Constructor 
     *
     * @param self
     * @param next
     */
    protected Involvement_1(
        ObjectView_1_0 self, 
        Interceptor_1 next
    ) {
        super(self, next);
    }

    /**
     * Retrieve the audit configuration
     * 
     * @return the audit configuration
     */
    protected Configuration getConfiguration(
    ){
        return SharedObjects.getPlugInObject(
            self.jdoGetPersistenceManager(), 
            Configuration.class
        );
    }
    
    /**
     * Retrieve the set of modified features
     * 
     * @return the set of modified features
     * 
     * @throws ServiceException
     */
    protected Set getModifiedFeature(
    ) throws ServiceException{
        ObjectView_1_0 beforeImage = (ObjectView_1_0) self.objGetValue("beforeImage");
        ObjectView_1_0 afterImage = (ObjectView_1_0) self.objGetValue("afterImage");
        if(beforeImage == null || afterImage == null){
            return Collections.emptySet();
        }
        if(SharedObjects.getPlugInObject(self.jdoGetPersistenceManager(), Configuration.class).getPersistenceMode() == InvolvementPersistence.EXTENDED) {
            return super.objGetSet("modifiedFeature");
        }
        ModelElement_1_0 classDef = self.getModel().getElement(beforeImage.objGetClass());
        Map nonDerivedAttributes = self.getModel().getStructuralFeatureDefs(
            classDef, 
            false, // includeSubtypes
            false, // includeDerived
            true // attributesOnly
        );  
        Set modifiedFeatures = new HashSet();
        for(ModelElement_1_0 attribute : nonDerivedAttributes.values()) {
            if(isFeatureModified(attribute, beforeImage, afterImage)){
                modifiedFeatures.add(
                    attribute.getQualifiedName()
                );
            }
        }
        return modifiedFeatures;
    }
    
    private static boolean areEqual(
    	Object left,
    	Object right
    ){
    	return left == null ? right == null : left.equals(right); 
    }
    
    private static boolean isFeatureModified(
        ModelElement_1_0 feature,
        ObjectView_1_0 beforeImage,
        ObjectView_1_0 afterImage
    ) throws ServiceException {
        String featureName = feature.getName();
        switch(ModelHelper.getMultiplicity(feature)){
	        case OPTIONAL: case SINGLE_VALUE: 
	            return !areEqual(beforeImage.objGetValue(featureName), afterImage.objGetValue(featureName));
	        case LIST:
	        	return !beforeImage.objGetList(featureName).equals(afterImage.objGetList(featureName));
	        case SET:
	        	return !beforeImage.objGetSet(featureName).equals(afterImage.objGetSet(featureName));
	        case SPARSEARRAY:
	        	return !beforeImage.objGetSparseArray(featureName).equals(afterImage.objGetSparseArray(featureName));
	        default:
	            return false; // as we don't know...
        }
    }

    
    /* (non-Javadoc)
     * @see org.openmdx.base.accessor.spi.DelegatingObject_1#objGetSet(java.lang.String)
     */
    @Override
    public Set objGetSet(
        String feature
    ) throws ServiceException {
        return "modifiedFeature".equals(feature) ? getModifiedFeature() : super.objGetSet(feature);
    }

    /**
     * Retrieve the object's XRI
     * 
     * @return the object's XRI
     */
    protected Path getObjectPath(
    ){
        return new Path(self.jdoGetObjectId().getLastSegment().toClassicRepresentation());
    }

    /**
     * Retrieve the involved object
     * 
     * @return the involved object unless it has been removed in the meanwhile
     */
    protected ObjectView_1_0 getObject(
    ){
        try {
            return (ObjectView_1_0) super.self.jdoGetPersistenceManager().getObjectById(
                getObjectPath()
            );
        } catch (JDOObjectNotFoundException exception) {
            //
            // It has been deleted in the meanwhile
            //
            return null; // that's why the "object" feature is optional
        }
    }

    /**
     * Derive the unit of work's object id
     * 
     * @return the unit of work's object id
     */
    protected Path getUnitOfWorkPath(
    ){
        return self.jdoGetObjectId().getPrefix(7);
    }

    /**
     * Derive involvement pattern
     * 
     * @return the involvements own pattern
     */
    protected Path getInvolvementPattern(
    ){
        return self.jdoGetObjectId().getPrefix(6).getDescendant(":*", "involvement", ":*");
    }
    
    /**
     * Derive the unit of work id
     * 
     * @return the unit of work id
     */
    protected String getUnitOfWorkId(
    ){
        return self.jdoGetObjectId().getSegment(6).toClassicRepresentation();
    }

    /**
     * Retrieve the unit of work 
     * 
     * @return the unit of work 
     * 
     * @throws ServiceException
     */
    protected ObjectView_1_0 getUnitOfWork(){
        return (ObjectView_1_0) self.jdoGetPersistenceManager().getObjectById(
            getUnitOfWorkPath()
        );
    }

    protected Container_1_0 getExtent() throws ServiceException{
        ObjectView_1_0 segment = (ObjectView_1_0) self.jdoGetPersistenceManager().getObjectById(
            self.jdoGetObjectId().getPrefix(5)
        );
        return segment.objGetContainer("extent");
    }
    
    protected ObjectView_1_0 getAfterImage() throws ServiceException{
        Path xri = this.getObjectPath();
        Container_1_0 involvements = getExtent().subMap(
            new Filter(
                new IsInstanceOfCondition(
                    "org:openmdx:audit2:Involvement"
                ),
                new IsLikeCondition(
                    Quantifier.THERE_EXISTS,
                    SystemAttributes.OBJECT_IDENTITY,
                    true,
                    ExtentCollection.toIdentityPattern(
                        this.getInvolvementPattern()
                    )
                ),
                new IsInCondition(
                    Quantifier.THERE_EXISTS,
                    "object",
                    true,
                    xri
                )
            )
        );
        Date expected = (Date) getUnitOfWork().objGetValue(SystemAttributes.CREATED_AT);
        for(DataObject_1_0 involvement : involvements.values()) {
            DataObject_1_0 beforeImage = (DataObject_1_0) involvement.objGetValue("beforeImage");
            if(equal(beforeImage.jdoGetObjectId(),expected,(Date)beforeImage.objGetValue(SystemAttributes.MODIFIED_AT))) {
                return (ObjectView_1_0) beforeImage;
            }
        }
        try {
            ObjectView_1_0 afterImage = (ObjectView_1_0) self.jdoGetPersistenceManager().getObjectById(xri);
            if(afterImage.jdoIsDeleted() || !equal(xri,expected,(Date)afterImage.objGetValue(SystemAttributes.MODIFIED_AT))){
                return null;
            } else {
                return afterImage;
            }
        } catch (Exception exception) {
            return null;
        }
    }
    
    private static boolean equal(Path xri, Date left, Date right){
        return left == null ? right == null : left.equals(right);
    }
    
    /* (non-Javadoc)
     * @see org.openmdx.base.accessor.spi.DelegatingObject_1#objGetValue(java.lang.String)
     */
    @Override
    public Object objGetValue(
        String feature
    ) throws ServiceException {
        return
            "object".equals(feature) ? getObject() : 
            "objectId".equals(feature) ? getObjectPath().toXRI() :
            "taskId".equals(feature) ? getUnitOfWork().objGetValue("taskId") :
            "unitOfWork".equals(feature) ? getUnitOfWork() :
            "unitOfWorkId".equals(feature) ? getUnitOfWorkPath().getLastSegment().toClassicRepresentation() :
            "afterImage".equals(feature) ? getAfterImage() :    
            super.objGetValue(feature);
    }
    
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy