com.ephesoft.dcma.workflows.aspects.DCMAPreProcessAspect.java Source code

Introduction

Here is the source code for com.ephesoft.dcma.workflows.aspects.DCMAPreProcessAspect.java

Source

/********************************************************************************* 
* Ephesoft is a Intelligent Document Capture and Mailroom Automation program 
* developed by Ephesoft, Inc. Copyright (C) 2015 Ephesoft Inc. 
* 
* This program is free software; you can redistribute it and/or modify it under 
* the terms of the GNU Affero General Public License version 3 as published by the 
* Free Software Foundation with the addition of the following permission added 
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK 
* IN WHICH THE COPYRIGHT IS OWNED BY EPHESOFT, EPHESOFT DISCLAIMS THE WARRANTY 
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. 
* 
* This program is distributed in the hope that it will be useful, but WITHOUT 
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
* FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more 
* details. 
* 
* You should have received a copy of the GNU Affero General Public License along with 
* this program; if not, see http://www.gnu.org/licenses or write to the Free 
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 
* 02110-1301 USA. 
* 
* You can contact Ephesoft, Inc. headquarters at 111 Academy Way, 
* Irvine, CA 92617, USA. or at email address info@ephesoft.com. 
* 
* The interactive user interfaces in modified source and object code versions 
* of this program must display Appropriate Legal Notices, as required under 
* Section 5 of the GNU Affero General Public License version 3. 
* 
* In accordance with Section 7(b) of the GNU Affero General Public License version 3, 
* these Appropriate Legal Notices must retain the display of the "Ephesoft" logo. 
* If the display of the logo is not reasonably feasible for 
* technical reasons, the Appropriate Legal Notices must display the words 
* "Powered by Ephesoft". 
********************************************************************************/

package com.ephesoft.dcma.workflows.aspects;

import java.lang.annotation.Annotation;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

import org.apache.commons.lang.ArrayUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.util.ClassUtils;

import com.ephesoft.dcma.core.DCMAException;
import com.ephesoft.dcma.core.annotation.PreProcess;
import com.ephesoft.dcma.da.id.BatchInstanceID;
import com.ephesoft.dcma.util.logger.EphesoftLogger;
import com.ephesoft.dcma.util.logger.EphesoftLoggerFactory;

/**
 * This class represents the aspects for Pre-processing for batches for every plugin of execution.
 * 
 * @author Ephesoft
 * 
 *         <b>created on</b> Oct 21, 2014 <br/>
 * @version $LastChangedDate:$ <br/>
 *          $LastChangedRevision:$ <br/>
 */
public class DCMAPreProcessAspect {

    /**
     * {@link EphesoftLogger} Instance of logger.
     */
    private static final EphesoftLogger LOGGER = EphesoftLoggerFactory.getLogger(DCMAPreProcessAspect.class);

    /**
     * Executes pre-process annotation methods in a service for a batch.
     * 
     * @param joinPoint {@link JoinPoint}
     * @throws DCMAException {@link DCMAException}
     */
    @Before("execution(* com.ephesoft.dcma.*.service.*.*(..)) " + "&& !within(com.ephesoft.dcma.da.service.*) "
            + "&& !within(com.ephesoft.dcma.workflows.service.*)")
    public void preprocess(JoinPoint joinPoint) throws DCMAException {
        try {
            Object target = joinPoint.getTarget();
            if (null != target) {
                Class<?> clazz = ClassUtils.getUserClass(target);
                Method[] methods = clazz.getMethods();
                if (!ArrayUtils.isEmpty(methods)) {
                    findAspectMethodsToExecute(joinPoint, target, methods);
                }
            }
        } catch (Exception exception) {
            LOGGER.error("Exception in Pre-processing", exception);
            throw new DCMAException("Exception in Pre-processing", exception);
        }
    }

    /**
     * Find and execute the method for this aspect.
     * 
     * @param joinPoint {@link JoinPoint}
     * @param target {@link Object}
     * @param methods {@link Method}[]
     * @throws IllegalAccessException
     * @throws InvocationTargetException
     */
    private void findAspectMethodsToExecute(final JoinPoint joinPoint, final Object target, final Method[] methods)
            throws IllegalAccessException, InvocationTargetException {
        for (int methodIndex = 0; methodIndex < methods.length; methodIndex++) {
            Method method = methods[methodIndex];
            Annotation annotation = method.getAnnotation(PreProcess.class);
            if (null != annotation && joinPoint.getArgs().length >= 1) {
                Object aJoinPoint = joinPoint.getArgs()[0];
                if (aJoinPoint instanceof BatchInstanceID) {
                    method.invoke(target, aJoinPoint, joinPoint.getArgs()[1]);
                } else {
                    LOGGER.info("Method ", method,
                            " does not comply to Pre-process agreement, thus method not invoked.");
                }
            }
        }
    }
}