JpaBatchMetadataProvider.java

/*
 * gvNIX is an open source tool for rapid application development (RAD).
 * Copyright (C) 2010 Generalitat Valenciana
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program. If not, see <http://www.gnu.org/licenses/>.
 */
package org.gvnix.addon.jpa.addon.batch;

import static org.springframework.roo.classpath.customdata.CustomDataKeys.PERSISTENT_TYPE;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.logging.Logger;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.gvnix.addon.jpa.addon.audit.JpaAuditMetadata;
import org.gvnix.addon.jpa.addon.entitylistener.JpaOrmEntityListenerOperations;
import org.gvnix.addon.jpa.annotations.batch.GvNIXJpaBatch;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;
import org.osgi.service.component.ComponentContext;
import org.springframework.roo.addon.jpa.addon.activerecord.JpaActiveRecordMetadata;
import org.springframework.roo.addon.jpa.addon.activerecord.JpaCrudAnnotationValues;
import org.springframework.roo.addon.plural.addon.PluralMetadata;
import org.springframework.roo.classpath.PhysicalTypeIdentifier;
import org.springframework.roo.classpath.PhysicalTypeMetadata;
import org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails;
import org.springframework.roo.classpath.details.FieldMetadata;
import org.springframework.roo.classpath.details.ItdTypeDetails;
import org.springframework.roo.classpath.details.MemberFindingUtils;
import org.springframework.roo.classpath.details.MemberHoldingTypeDetails;
import org.springframework.roo.classpath.itd.AbstractMemberDiscoveringItdMetadataProvider;
import org.springframework.roo.classpath.itd.ItdTypeDetailsProvidingMetadataItem;
import org.springframework.roo.classpath.scanner.MemberDetails;
import org.springframework.roo.model.JavaType;
import org.springframework.roo.project.LogicalPath;
import org.springframework.roo.support.logging.HandlerUtils;

/**
 * Provides {@link JpaBatchMetadata}. Prepares all required information to
 * construct a new instance of {@link JpaBatchMetadata}. Also register metadata
 * dependencies.
 * 
 * @author <a href="http://www.disid.com">DISID Corporation S.L.</a> made for <a
 *         href="http://www.dgti.gva.es">General Directorate for Information
 *         Technologies (DGTI)</a>
 * @since 1.1
 */
@Component
@Service
public final class JpaBatchMetadataProvider extends
        AbstractMemberDiscoveringItdMetadataProvider {

    protected final static Logger LOGGER = HandlerUtils
            .getLogger(JpaBatchMetadataProvider.class);

    private JpaOrmEntityListenerOperations entityListenerOperations;

    private Map<JavaType, String> entityToBatchMidMap = new HashMap<JavaType, String>();

    /**
     * The activate method for this OSGi component, this will be called by the
     * OSGi container upon bundle activation (result of the 'addon install'
     * command)
     * 
     * @param context the component context can be used to get access to the
     *        OSGi container (ie find out if certain bundles are active)
     */
    protected void activate(ComponentContext cContext) {
        context = cContext.getBundleContext();
        getMetadataDependencyRegistry().registerDependency(
                PhysicalTypeIdentifier.getMetadataIdentiferType(),
                getProvidesType());
        addMetadataTrigger(new JavaType(GvNIXJpaBatch.class.getName()));
    }

    /**
     * The deactivate method for this OSGi component, this will be called by the
     * OSGi container upon bundle deactivation (result of the 'addon uninstall'
     * command)
     * 
     * @param context the component context can be used to get access to the
     *        OSGi container (ie find out if certain bundles are active)
     */
    protected void deactivate(ComponentContext context) {
        getMetadataDependencyRegistry().deregisterDependency(
                PhysicalTypeIdentifier.getMetadataIdentiferType(),
                getProvidesType());
        removeMetadataTrigger(new JavaType(GvNIXJpaBatch.class.getName()));
    }

    /**
     * Return an instance of the Metadata offered by this add-on
     */
    protected ItdTypeDetailsProvidingMetadataItem getMetadata(
            String metadataIdentificationString, JavaType aspectName,
            PhysicalTypeMetadata governorPhysicalTypeMetadata,
            String itdFilename) {

        final JpaBatchAnnotationValues annotationValues = new JpaBatchAnnotationValues(
                governorPhysicalTypeMetadata);

        final JavaType targetEntity = annotationValues.getEntity();
        if (!annotationValues.isAnnotationFound() || targetEntity == null) {
            return null;
        }

        final MemberDetails targetEntityMemberDetails = getMemberDetails(targetEntity);
        if (targetEntityMemberDetails == null) {
            return null;
        }

        final MemberHoldingTypeDetails targetMHTD = MemberFindingUtils
                .getMostConcreteMemberHoldingTypeDetailsWithTag(
                        targetEntityMemberDetails, PERSISTENT_TYPE);
        if (targetMHTD == null) {
            return null;
        }

        // get target entity MID
        final String domainTypeMid = typeLocationService
                .getPhysicalTypeIdentifier(targetEntity);
        if (domainTypeMid == null) {
            return null;
        }

        LogicalPath path = JpaBatchMetadata
                .getPath(metadataIdentificationString);

        String entityMetadataKey = JpaActiveRecordMetadata.createIdentifier(
                targetEntity, path);

        List<FieldMetadata> identifiers = getPersistenceMemberLocator()
                .getIdentifierFields(targetEntity);

        // register downstream dependency (entityActiveRecord --> jpaBatch)
        getMetadataDependencyRegistry().registerDependency(entityMetadataKey,
                metadataIdentificationString);

        // check if entity use audit
        String auditMetatadaKey = JpaAuditMetadata.createIdentifier(
                targetEntity, path);
        JpaAuditMetadata auditMetada = (JpaAuditMetadata) getMetadataService()
                .get(auditMetatadaKey);

        // Register dependency with audit metadata
        getMetadataDependencyRegistry().registerDependency(auditMetatadaKey,
                metadataIdentificationString);

        boolean hasEntityListeners = getEntityListenerOperations()
                .hasAnyListener(targetEntity);

        // Getting plural
        final String pluralId = PluralMetadata.createIdentifier(targetEntity,
                path);
        final PluralMetadata pluralMetadata = (PluralMetadata) getMetadataService()
                .get(pluralId);
        if (pluralMetadata == null) {
            // Can't acquire the plural
            return null;
        }

        // TODO get more data
        return new JpaBatchMetadata(metadataIdentificationString, aspectName,
                governorPhysicalTypeMetadata, annotationValues, identifiers,
                pluralMetadata.getPlural(), auditMetada, hasEntityListeners);
    }

    /**
     * Define the unique ITD file name extension, here the resulting file name
     * will be **_ROO_GvNIXJpaBatch.aj
     */
    public String getItdUniquenessFilenameSuffix() {
        return "GvNIXJpaBatch";
    }

    protected String getGovernorPhysicalTypeIdentifier(
            String metadataIdentificationString) {
        JavaType javaType = JpaBatchMetadata
                .getJavaType(metadataIdentificationString);
        LogicalPath path = JpaBatchMetadata
                .getPath(metadataIdentificationString);
        return PhysicalTypeIdentifier.createIdentifier(javaType, path);
    }

    protected String createLocalIdentifier(JavaType javaType, LogicalPath path) {
        return JpaBatchMetadata.createIdentifier(javaType, path);
    }

    public String getProvidesType() {
        return JpaBatchMetadata.getMetadataIdentiferType();
    }

    @Override
    protected String getLocalMidToRequest(final ItdTypeDetails itdTypeDetails) {
        final JavaType governor = itdTypeDetails.getName();

        // If the governor is a form backing object, refresh its local metadata
        final String localMid = entityToBatchMidMap.get(governor);
        if (localMid != null) {
            return localMid;
        }

        // If the governor is a layer component that manages a form backing
        // object, refresh that object's local metadata
        return getRelatedEntityComponent(governor);
    }

    /**
     * If the given governor is a layer component (service, repository, etc.)
     * that manages an entity for which we maintain web scaffold metadata,
     * returns the ID of that metadata, otherwise returns <code>null</code>.
     * TODO doesn't handle the case where the governor is a component that
     * manages multiple entities, as it always returns the MID for the first
     * entity found (in annotation order) for which we provide web metadata. We
     * would need to enhance
     * {@link AbstractMemberDiscoveringItdMetadataProvider#getLocalMidToRequest}
     * to return a list of MIDs, rather than only one.
     * 
     * @param governor the governor to check (required)
     * @return see above
     */
    private String getRelatedEntityComponent(final JavaType governor) {
        final ClassOrInterfaceTypeDetails governorTypeDetails = typeLocationService
                .getTypeDetails(governor);
        if (governorTypeDetails != null) {
            for (final JavaType type : governorTypeDetails.getLayerEntities()) {
                final String localMid = entityToBatchMidMap.get(type);
                if (localMid != null) {
                    /*
                     * The ITD's governor is a layer component that manages an
                     * entity for which we maintain web scaffold metadata =>
                     * refresh that MD in case a layer has appeared or gone
                     * away.
                     */
                    return localMid;
                }
            }
        }
        return null;
    }

    public JpaOrmEntityListenerOperations getEntityListenerOperations() {
        if (entityListenerOperations == null) {
            // Get all Services JpaOrmEntityListenerOperations
            // interface
            try {
                ServiceReference<?>[] references = this.context
                        .getAllServiceReferences(
                                JpaOrmEntityListenerOperations.class.getName(),
                                null);

                for (ServiceReference<?> ref : references) {
                    return (JpaOrmEntityListenerOperations) this.context
                            .getService(ref);
                }

                return null;

            }
            catch (InvalidSyntaxException e) {
                LOGGER.warning("Cannot load JpaOrmEntityListenerOperations on JpaBatchMetadataProvider.");
                return null;
            }
        }
        else {
            return entityListenerOperations;
        }

    }
}