spring:load

Full name:

org.kuali.maven.plugins:spring-maven-plugin:2.0.5:load

Description:

Load a Spring context from an annotated class

Attributes:

  • Requires a Maven project to be executed.
  • Invokes the execution of this plugin's goal load prior to executing itself.

Optional Parameters

Name Type Since Description
addPropertySources boolean - If true, any PropertySource's supplied to the mojo are added to the configured Spring environment.
Default value is: true.
User property is: spring.addPropertySources.
annotatedClass String - The annotated class containing the Spring configuration. If not supplied, a class based on ${project.groupId} + ${project.artifactId} is used. Given a groupId of org.kuali.rice and an artifactId of rice-sampleapp, this mojo attempts to use org.kuali.rice.spring.RiceSampleappConfig
User property is: spring.annotatedClass.
annotatedClasses List - Additional annotated classes containing Spring configuration.
User property is: spring.annotatedClasses.
forceMojoExecution boolean - If true, the mojo will always execute
Default value is: false.
User property is: spring.forceMojoExecution.
injectMavenMojo boolean - If true, the Maven project object is injected into the context
Default value is: false.
User property is: spring.injectMavenMojo.
injectMavenProject boolean - If true, the Maven project object is injected into the context
Default value is: false.
User property is: spring.injectMavenProject.
injectMavenProperties boolean - If true, Maven properties are injected into the context as a java.util.Properties bean
Default value is: true.
User property is: spring.injectMavenProperties.
mavenMojoBeanName String - The name under which this mojo is injected
Default value is: mavenMojo.
User property is: spring.mavenMojoBeanName.
mavenProjectBeanName String - The name under which the Maven project object is injected
Default value is: mavenProject.
User property is: spring.mavenProjectBeanName.
mavenPropertiesBeanName String - The name under which the Maven properties object is injected
Default value is: mavenProperties.
User property is: spring.mavenPropertiesBeanName.
properties Properties - Extra properties supplied directly to the mojo
User property is: spring.properties.
propertySourcesConfig String - The annotated class containing PropertySource definitions. By default, this gets set to org.kuali.maven.plugins.spring.config.PropertySourcesConfig which registers a single PropertySource object backed by the full set of Maven properties.
User property is: spring.propertySourcesConfig.
skip boolean - If true, the mojo execution will always be skipped (unless forceMojoExecution is true)
Default value is: false.
User property is: spring.skip.
springMojoService String - The implementation of SpringMojoService to use. If not supplied this defaults to org.kuali.maven.plugins.spring.DefaultSpringMojoService
User property is: spring.springMojoService.
springService String - The implementation of SpringService to use. If not supplied this defaults to org.kuali.common.util.service.DefaultSpringService
User property is: spring.springService.

Parameter Details

addPropertySources:

If true, any PropertySource's supplied to the mojo are added to the configured Spring environment.
  • Type: boolean
  • Required: No
  • User Property: spring.addPropertySources
  • Default: true

annotatedClass:

The annotated class containing the Spring configuration. If not supplied, a class based on ${project.groupId} + ${project.artifactId} is used. Given a groupId of org.kuali.rice and an artifactId of rice-sampleapp, this mojo attempts to use org.kuali.rice.spring.RiceSampleappConfig
  • Type: java.lang.String
  • Required: No
  • User Property: spring.annotatedClass

annotatedClasses:

Additional annotated classes containing Spring configuration.
  • Type: java.util.List
  • Required: No
  • User Property: spring.annotatedClasses

forceMojoExecution:

If true, the mojo will always execute
  • Type: boolean
  • Required: No
  • User Property: spring.forceMojoExecution
  • Default: false

injectMavenMojo:

If true, the Maven project object is injected into the context
  • Type: boolean
  • Required: No
  • User Property: spring.injectMavenMojo
  • Default: false

injectMavenProject:

If true, the Maven project object is injected into the context
  • Type: boolean
  • Required: No
  • User Property: spring.injectMavenProject
  • Default: false

injectMavenProperties:

If true, Maven properties are injected into the context as a java.util.Properties bean
  • Type: boolean
  • Required: No
  • User Property: spring.injectMavenProperties
  • Default: true

mavenMojoBeanName:

The name under which this mojo is injected
  • Type: java.lang.String
  • Required: No
  • User Property: spring.mavenMojoBeanName
  • Default: mavenMojo

mavenProjectBeanName:

The name under which the Maven project object is injected
  • Type: java.lang.String
  • Required: No
  • User Property: spring.mavenProjectBeanName
  • Default: mavenProject

mavenPropertiesBeanName:

The name under which the Maven properties object is injected
  • Type: java.lang.String
  • Required: No
  • User Property: spring.mavenPropertiesBeanName
  • Default: mavenProperties

properties:

Extra properties supplied directly to the mojo
  • Type: java.util.Properties
  • Required: No
  • User Property: spring.properties

propertySourcesConfig:

The annotated class containing PropertySource definitions. By default, this gets set to org.kuali.maven.plugins.spring.config.PropertySourcesConfig which registers a single PropertySource object backed by the full set of Maven properties.
  • Type: java.lang.String
  • Required: No
  • User Property: spring.propertySourcesConfig

skip:

If true, the mojo execution will always be skipped (unless forceMojoExecution is true)
  • Type: boolean
  • Required: No
  • User Property: spring.skip
  • Default: false

springMojoService:

The implementation of SpringMojoService to use. If not supplied this defaults to org.kuali.maven.plugins.spring.DefaultSpringMojoService
  • Type: java.lang.String
  • Required: No
  • User Property: spring.springMojoService

springService:

The implementation of SpringService to use. If not supplied this defaults to org.kuali.common.util.service.DefaultSpringService
  • Type: java.lang.String
  • Required: No
  • User Property: spring.springService