org.openmdx.base.aop0.UpdateAvoidance_1 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmdx-dalvik Show documentation
openMDX/Dalvik Library
There is a newer version: 2.18.10
/*
 * ====================================================================
 * Project:     openMDX, http://www.openmdx.org/
 * Description: Refreshing Plug-In
 * Owner:       OMEX AG, Switzerland, http://www.omex.ch
 * ====================================================================
 *
 * This software is published under the BSD license as listed below.
 * 
 * Copyright (c) 2011, 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 or is based on software developed by other 
 * organizations as listed in the NOTICE file.
 */
package org.openmdx.base.aop0;

import javax.jdo.JDOHelper;
import javax.jdo.ObjectState;
import javax.jdo.PersistenceManager;
import javax.jdo.listener.InstanceLifecycleEvent;

import org.openmdx.base.accessor.rest.DataObject_1;
import org.openmdx.base.accessor.rest.UnitOfWork_1;
import org.openmdx.base.accessor.spi.AbstractUnitOfWork_1;
import org.openmdx.base.exception.ServiceException;
import org.openmdx.base.persistence.cci.PersistenceHelper;


/**
 * This Plug-In avoids unnecessary updates by removing idempotent modifications.
 */
public class UpdateAvoidance_1 extends PlugIn_1 {

    /**
     * The configuration object
     */
    public static final UpdateAvoidance plugInObject = new UpdateAvoidance() {
		
		public void touchAllDirtyObjects(PersistenceManager persistenceManager) {
			AbstractUnitOfWork_1.getDelegate(
			    UnitOfWork_1.class, 
			    PersistenceHelper.currentUnitOfWork(persistenceManager)
			).disableUpdateAvoidance();
		}
		
	};

    /* (non-Javadoc)
     * @see org.openmdx.base.aop0.PlugIn_1#preStore(javax.jdo.listener.InstanceLifecycleEvent)
     */
    @Override
    public void preStore(InstanceLifecycleEvent event) {
        DataObject_1 dataObject = (DataObject_1) event.getPersistentInstance();
        if(dataObject.getUnitOfWork().isUpdateAvoidanceEnabled() && JDOHelper.getObjectState(dataObject) == ObjectState.PERSISTENT_DIRTY) {
        	try {
	            dataObject.makePersistentCleanWhenUnmodified();
	        } catch (ServiceException exception) {
	            throw new javax.jdo.JDOUserCallbackException(
	                "Update avoidance failure",
	                exception
	            );
	        }
        }
        super.preStore(event);
    }

	/* (non-Javadoc)
	 * @see org.openmdx.base.aop0.PlugIn_1#getPlugInObject(java.lang.Class)
	 */
	@Override
	public  T getPlugInObject(Class type) {
		return type == UpdateAvoidance.class ? type.cast(plugInObject) : super.getPlugInObject(type);
	}

}