JpaAuditRevisionEntityMetadataProvider.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.audit;

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.providers.RevisionLogProvider;
import org.gvnix.addon.jpa.addon.audit.providers.RevisionLogRevisionEntityMetadataBuilder;
import org.gvnix.addon.jpa.annotations.audit.GvNIXJpaAudit;
import org.gvnix.addon.jpa.annotations.audit.GvNIXJpaAuditRevisionEntity;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;
import org.osgi.service.component.ComponentContext;
import org.springframework.roo.classpath.PhysicalTypeIdentifier;
import org.springframework.roo.classpath.PhysicalTypeMetadata;
import org.springframework.roo.classpath.itd.AbstractItdMetadataProvider;
import org.springframework.roo.classpath.itd.ItdTypeDetailsProvidingMetadataItem;
import org.springframework.roo.model.JavaType;
import org.springframework.roo.project.LogicalPath;
import org.springframework.roo.support.logging.HandlerUtils;

/**
 * Provides {@link JpaAuditRevisionEntityMetadata}. This type is called by Roo
 * to retrieve the metadata for this add-on. Use this type to reference external
 * types and services needed by the metadata type. Register metadata triggers
 * and dependencies here. Also define the unique add-on ITD identifier.
 * 
 * @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.3.0
 */
@Component
@Service
public final class JpaAuditRevisionEntityMetadataProvider extends
        AbstractItdMetadataProvider {

    private static final Logger LOGGER = HandlerUtils
            .getLogger(JpaAuditRevisionEntityMetadataProvider.class);

    private JpaAuditOperationsMetadata operations;

    /**
     * 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(
                GvNIXJpaAuditRevisionEntity.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(GvNIXJpaAudit.class.getName()));
    }

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

        // Gets annotation values
        final JpaAuditRevisionEntityAnnotationValues annotationValues = new JpaAuditRevisionEntityAnnotationValues(
                governorPhysicalTypeMetadata);

        RevisionLogProvider logProvider = getOperations()
                .getActiveRevisionLogProvider();

        if (logProvider == null) {
            LOGGER.severe(String
                    .format("%s is annotated with @%s but no revisionLog provider is active.",
                            governorPhysicalTypeMetadata.getType()
                                    .getFullyQualifiedTypeName(),
                            GvNIXJpaAuditRevisionEntity.class.getSimpleName()));
            return null;
        }

        LogicalPath path = JpaAuditRevisionEntityMetadata
                .getPath(metadataIdentificationString);

        JavaType userService = getOperations().getUserServiceType();
        if (userService == null) {
            // No user type: do nothing
            return null;
        }

        String userServiceId = JpaAuditUserServiceMetadata.createIdentifier(
                userService, path);

        JpaAuditUserServiceMetadata userServiceMetadata = (JpaAuditUserServiceMetadata) getMetadataService()
                .get(userServiceId);

        if (userServiceMetadata == null) {
            // No user type: do nothing
            return null;
        }

        // Add dependency with UserService metadata
        getMetadataDependencyRegistry().registerDependency(userServiceId,
                metadataIdentificationString);

        RevisionLogRevisionEntityMetadataBuilder revisionLogBuilder = logProvider
                .getRevisonEntityMetadataBuilder(getOperations(),
                        governorPhysicalTypeMetadata);

        // Pass dependencies required by the metadata in through its constructor
        return new JpaAuditRevisionEntityMetadata(metadataIdentificationString,
                aspectName, governorPhysicalTypeMetadata, annotationValues,
                revisionLogBuilder, userServiceMetadata.userType(),
                userService, userServiceMetadata.isUserTypeEntity(),
                userServiceMetadata.isUserTypeSpringSecUserDetails(),
                userServiceMetadata.usePatternForTimestamp(),
                userServiceMetadata.getPatternForTimestamp(),
                userServiceMetadata.getTimestampStyle());
    }

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

    /* (non-Javadoc)
     * @see org.springframework.roo.classpath.itd.AbstractItdMetadataProvider#getGovernorPhysicalTypeIdentifier(java.lang.String)
     */
    protected String getGovernorPhysicalTypeIdentifier(
            String metadataIdentificationString) {
        JavaType javaType = JpaAuditRevisionEntityMetadata
                .getJavaType(metadataIdentificationString);
        LogicalPath path = JpaAuditRevisionEntityMetadata
                .getPath(metadataIdentificationString);
        return PhysicalTypeIdentifier.createIdentifier(javaType, path);
    }

    /* (non-Javadoc)
     * @see org.springframework.roo.classpath.itd.AbstractItdMetadataProvider#createLocalIdentifier(org.springframework.roo.model.JavaType, org.springframework.roo.project.LogicalPath)
     */
    protected String createLocalIdentifier(JavaType javaType, LogicalPath path) {
        return JpaAuditRevisionEntityMetadata.createIdentifier(javaType, path);
    }

    /* (non-Javadoc)
     * @see org.springframework.roo.metadata.MetadataProvider#getProvidesType()
     */
    public String getProvidesType() {
        return JpaAuditRevisionEntityMetadata.getMetadataIdentiferType();
    }

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

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

                return null;

            }
            catch (InvalidSyntaxException e) {
                LOGGER.warning("Cannot load JpaAuditOperationsMetadata on JpaAuditRevisionEntityMetadataProvider.");
                return null;
            }
        }
        else {
            return operations;
        }

    }
}