Required Parameters

Name	Type	Since	Description
injar	String	-	Specifies the input jar name (or wars, ears, zips) of the application to be processed. You may specify a classes directory e.g. 'classes'. This way plugin will processed the classes instead of jar. You would need to bind the execution to phase 'compile' or 'process-classes' in this case.
outputDirectory	File	-	Directory containing the input and generated JAR.

Optional Parameters

Name	Type	Since	Description
addMavenDescriptor	boolean	-	Set to true to include META-INF/maven/** maven descriptord Default value is: false.
appendClassifier	boolean	-	Set to false to exclude the attachArtifactClassifier from the Artifact final name. Default value is true. Default value is: true.
archive	MavenArchiveConfiguration	-	The maven archive configuration to use. only if assembly is used.
assembly	Assembly	-	Bundle project dependency to resulting jar. Specifies list of artifact inclusions
attach	boolean	-	Specifies whether or not to attach the created artifact to the project Default value is: false.
attachArtifactClassifier	String	-	Specifies attach artifact Classifier, Ignored if attach=false Default value is: small.
attachArtifactType	String	-	Specifies attach artifact type Default value is: jar.
exclusions	List	-	List of dependency exclusions
inFilter	String	-	Apply ProGuard classpathentry Filters to input jar. e.g. !**.gif,!**/tests/**'
includeDependency	boolean	-	Specifies that project compile dependencies be added as -libraryjars to proguard arguments. Dependency itself is not included in resulting jar Default value is: true.
injarNotExistsSkip	boolean	-	Set this to 'true' to bypass ProGuard processing when injar does not exists. Default value is: false.
libs	List	-	Additional -libraryjars e.g. ${java.home}/lib/rt.jar Project compile dependency are added automatically. See exclusions
maxMemory	String	-	The max memory the forked java process should use, e.g. 256m
obfuscate	boolean	-	Specifies not to obfuscate the input class files. Default value is: true.
options	String[]	-	ProGuard configuration options
outjar	String	-	Specifies the names of the output jars. If attach=true the value ignored and name constructed base on classifier If empty input jar would be overdriven.
proguardInclude	File	-	Recursively reads configuration options from the given file filename Default value is: ${basedir}/proguard.conf.
proguardMainClass	String	-	ProGuard main class name. Default value is: proguard.ProGuard.
proguardVersion	String	-	Select specific ProGuard version from plugin dependencies
skip	boolean	-	Set this to 'true' to bypass ProGuard processing entirely.

Parameter Details

addMavenDescriptor:

• Type: boolean
• Required: No
• Default: false

---

appendClassifier:

• Type: boolean
• Required: No
• Default: true

---

archive:

• Type: org.apache.maven.archiver.MavenArchiveConfiguration
• Required: No

---

assembly:

• Type: com.pyx4me.maven.proguard.Assembly
• Required: No

---

attach:

• Type: boolean
• Required: No
• Default: false

---

attachArtifactClassifier:

• Type: java.lang.String
• Required: No
• Default: small

---

attachArtifactType:

• Type: java.lang.String
• Required: No
• Default: jar

---

exclusions:

• Type: java.util.List
• Required: No

---

inFilter:

• Type: java.lang.String
• Required: No

---

includeDependency:

• Type: boolean
• Required: No
• Default: true

---

injar:

• Type: java.lang.String
• Required: Yes
• Expression: ${project.build.finalName}.jar

---

injarNotExistsSkip:

• Type: boolean
• Required: No
• Default: false

---

libs:

• Type: java.util.List
• Required: No

---

maxMemory:

• Type: java.lang.String
• Required: No

---

obfuscate:

• Type: boolean
• Required: No
• Default: true

---

options:

• Type: java.lang.String[]
• Required: No

---

outjar:

• Type: java.lang.String
• Required: No

---

outputDirectory:

• Type: java.io.File
• Required: Yes
• Expression: ${project.build.directory}

---

proguardInclude:

• Type: java.io.File
• Required: No
• Default: ${basedir}/proguard.conf

---

proguardMainClass:

• Type: java.lang.String
• Required: No
• Default: proguard.ProGuard

---

proguardVersion:

• Type: java.lang.String
• Required: No

---

skip:

• Type: boolean
• Required: No
• Expression: ${proguard.skip}