BennuSpringModule.java

/**
 * Copyright © 2014 Instituto Superior Técnico
 *
 * This file is part of Bennu Spring.
 *
 * Bennu Spring is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Bennu Spring 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Bennu Spring.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.fenixedu.bennu.spring;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ReloadableResourceBundleMessageSource;

/***
 * Indicates that an annotated class is a configuration Bennu Spring Module.
 * Specifies basePackages for {@link ComponentScan} and baseNames for {@link ReloadableResourceBundleMessageSource}
 * 
 * @author Sérgio Silva (sergio.silva@tecnico.ulisboa.pt)
 * 
 */
@ComponentScan
@Configuration
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface BennuSpringModule {
    /**
     * The base packages within this module for component scanning.
     * 
     * @return packages configuration for @{link @ComponentScan} annotation
     */
    String[] basePackages() default {};

    /**
     * The resource bundles relative to "/WEB-INF/resources/" in this module.
     * The bundle definition must not include file extensions.
     * 
     * Example
     * 
     * <pre class="code">
     * @BennuSpringResource(bundles="MyModuleResources")
     * </pre>
     * 
     * It will search for the following files:
     * <ul>
     * <li>/WEB-INF/resources/MyModuleResources.properties</li>
     * <li>/WEB-INF/resources/MyModuleResources_<locale>.properties</li>
     * </ul>
     * 
     * @return bundle names which will be available as messageSource providers.
     * @see BennuSpringConfiguration#messageSource(org.springframework.context.ApplicationContext)
     */
    String[] bundles() default {};
}