richfaces-resources:process

Full name:

org.richfaces.cdk:maven-richfaces-resources-plugin:4.3.1.Final:process

Description:

Scans for resource dependencies (ResourceDependency annotations) on the class-path and collect them in order to pre-generate resources them and optionally pack or compress them.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Binds by default to the lifecycle phase: process-classes.

Required Parameters

Name Type Since Description
resourcesOutputDir String - Output directory for processed resources
skins String[] - The list of RichFaces skins to be processed
staticResourceMappingFile String - Output file for resource mapping configuration

Optional Parameters

Name Type Since Description
compress boolean - Turns on compression with YUI Compressor (JavaScript/CSS compression)
encoding String - The encoding used for resource processing
Default value is: ${project.build.sourceEncoding}.
excludedContentTypes List - The list of mime-types to be excluded in processing
excludedFiles List - List of excluded files
fileNameMappings FileNameMapping[] - Mapping of file names to output file names
includedContentTypes List - The list of mime-types to be included in processing
includedFiles List - List of included files.
pack boolean - Turns on packing of JavaScript/CSS resources
processMode ProcessMode - (no description)
staticResourcePrefix String - Configures what prefix should be placed to each file before the library and name of the resource
webRoot String - The expression determines the root of the webapp resources
Default value is: ${basedir}/src/main/webapp.

Parameter Details

compress:

Turns on compression with YUI Compressor (JavaScript/CSS compression)
  • Type: boolean
  • Required: No
  • Expression: ${compress}

encoding:

The encoding used for resource processing
  • Type: java.lang.String
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

excludedContentTypes:

The list of mime-types to be excluded in processing
  • Type: java.util.List
  • Required: No

excludedFiles:

List of excluded files
  • Type: java.util.List
  • Required: No

fileNameMappings:

Mapping of file names to output file names
  • Type: org.richfaces.cdk.FileNameMapping[]
  • Required: No

includedContentTypes:

The list of mime-types to be included in processing
  • Type: java.util.List
  • Required: No

includedFiles:

List of included files.
  • Type: java.util.List
  • Required: No

pack:

Turns on packing of JavaScript/CSS resources
  • Type: boolean
  • Required: No
  • Expression: ${pack}

processMode:

(no description)
  • Type: org.richfaces.cdk.ProcessMode
  • Required: No

resourcesOutputDir:

Output directory for processed resources
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${resourcesOutputDir}

skins:

The list of RichFaces skins to be processed
  • Type: java.lang.String[]
  • Required: Yes
  • Expression: ${skins}

staticResourceMappingFile:

Output file for resource mapping configuration
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${staticResourceMappingFile}

staticResourcePrefix:

Configures what prefix should be placed to each file before the library and name of the resource
  • Type: java.lang.String
  • Required: No
  • Expression: ${staticResourcePrefix}

webRoot:

The expression determines the root of the webapp resources
  • Type: java.lang.String
  • Required: No
  • Default: ${basedir}/src/main/webapp