spring:loadxml

Full name:

org.kuali.maven.plugins:spring-maven-plugin:3.0.1:loadxml

Description:

Load a Spring context from an XML file.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Invokes the execution of this plugin's goal loadxml prior to executing itself.

Optional Parameters

Name Type Since Description
activeProfileExcludes String - Comma separated list of active profiles to exclude. By default, all active Maven profiles plus any profiles from activeProfiles are activated.
Default value is: NONE.
User property is: spring.activeProfileExcludes.
activeProfileIncludes String - Comma separated list of active profiles to include. By default, all active Maven profiles plus any profiles from activeProfiles are activated.
User property is: spring.activeProfileIncludes.
activeProfiles String - Comma separated list of profiles to activate. By default the profile maven is activated.
Default value is: maven.
User property is: spring.profiles.active.
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.
defaultProfileExcludes String - Comma separated list of default profiles to exclude. Spring uses the profile "default" when no other active or default profiles are specified.
Default value is: NONE.
User property is: spring.defaultProfileExcludes.
defaultProfileIncludes String - Comma separated list of default profiles to include. Spring uses the profile default when no other active or default profiles are specified.
User property is: spring.defaultProfileIncludes.
defaultProfiles String - Comma separated list of default profiles. Spring always uses a single profile named default if no default profiles are provided.
User property is: spring.profiles.default.
forceMojoExecution boolean - If true, the mojo will always execute
Default value is: false.
User property is: spring.forceMojoExecution.
injectMavenMojo boolean - If true, this Maven mojo object is injected into the context under the name mavenMojo
Default value is: false.
User property is: spring.injectMavenMojo.
injectMavenProject boolean - If true, the Maven project object is injected into the context under the name mavenProject
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 under the name mavenProperties
Default value is: true.
User property is: spring.injectMavenProperties.
location String - Location of a Spring context XML file. This can be a file on the local file system, or any URL Spring's Resource loading framework understands eg
If not provided, a context based on ${project.groupId} + ${project.artifactId} is used.
Given a groupId of org.kuali.rice and an artifactId of rice-sampleapp this mojo will load classpath:org/kuali/rice/spring/rice-sampleapp-context.xml
User property is: spring.location.
locations List - List of additional Spring context XML files to load (if any).
mojoExecutableConfig String - The Spring config class execution is delegated to. This defaults to org.kuali.maven.plugins.spring.config.MojoExecutableConfig
User property is: spring.mojoExecutableConfig.
properties Properties - Extra properties supplied directly to the mojo
User property is: spring.properties.
propertySourcesLocation String - This context registers a single PropertySource bean backed by Maven properties
Default value is: classpath:org/kuali/maven/plugins/spring/property-sources-context.xml.
removeExistingPropertySources boolean - If true, any existing PropertySource's are removed before adding property sources supplied to the plugin
Default value is: false.
User property is: spring.removeExistingPropertySources.
skip boolean - If true, the mojo execution will always be skipped (unless forceMojoExecution is true)
Default value is: false.
User property is: spring.skip.
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

activeProfileExcludes:

Comma separated list of active profiles to exclude. By default, all active Maven profiles plus any profiles from activeProfiles are activated.
  • Type: java.lang.String
  • Required: No
  • User Property: spring.activeProfileExcludes
  • Default: NONE

activeProfileIncludes:

Comma separated list of active profiles to include. By default, all active Maven profiles plus any profiles from activeProfiles are activated.
  • Type: java.lang.String
  • Required: No
  • User Property: spring.activeProfileIncludes

activeProfiles:

Comma separated list of profiles to activate. By default the profile maven is activated.
  • Type: java.lang.String
  • Required: No
  • User Property: spring.profiles.active
  • Default: maven

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

defaultProfileExcludes:

Comma separated list of default profiles to exclude. Spring uses the profile "default" when no other active or default profiles are specified.
  • Type: java.lang.String
  • Required: No
  • User Property: spring.defaultProfileExcludes
  • Default: NONE

defaultProfileIncludes:

Comma separated list of default profiles to include. Spring uses the profile default when no other active or default profiles are specified.
  • Type: java.lang.String
  • Required: No
  • User Property: spring.defaultProfileIncludes

defaultProfiles:

Comma separated list of default profiles. Spring always uses a single profile named default if no default profiles are provided.
  • Type: java.lang.String
  • Required: No
  • User Property: spring.profiles.default

forceMojoExecution:

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

injectMavenMojo:

If true, this Maven mojo object is injected into the context under the name mavenMojo
  • Type: boolean
  • Required: No
  • User Property: spring.injectMavenMojo
  • Default: false

injectMavenProject:

If true, the Maven project object is injected into the context under the name mavenProject
  • 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 under the name mavenProperties
  • Type: boolean
  • Required: No
  • User Property: spring.injectMavenProperties
  • Default: true

location:

Location of a Spring context XML file. This can be a file on the local file system, or any URL Spring's Resource loading framework understands eg
If not provided, a context based on ${project.groupId} + ${project.artifactId} is used.
Given a groupId of org.kuali.rice and an artifactId of rice-sampleapp this mojo will load classpath:org/kuali/rice/spring/rice-sampleapp-context.xml
  • Type: java.lang.String
  • Required: No
  • User Property: spring.location

locations:

List of additional Spring context XML files to load (if any).
  • Type: java.util.List
  • Required: No

mojoExecutableConfig:

The Spring config class execution is delegated to. This defaults to org.kuali.maven.plugins.spring.config.MojoExecutableConfig
  • Type: java.lang.String
  • Required: No
  • User Property: spring.mojoExecutableConfig

properties:

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

propertySourcesLocation:

This context registers a single PropertySource bean backed by Maven properties
  • Type: java.lang.String
  • Required: No
  • Default: classpath:org/kuali/maven/plugins/spring/property-sources-context.xml

removeExistingPropertySources:

If true, any existing PropertySource's are removed before adding property sources supplied to the plugin
  • Type: boolean
  • Required: No
  • User Property: spring.removeExistingPropertySources
  • Default: false

skip:

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

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