Required Parameters

Name	Type	Description
file	File	The file to be deployed
repositoryLayout	String	The type of remote repository layout to deploy to. Try legacy for a Maven 1.x-style repository layout. Default value is default.

Optional Parameters

Name	Type	Description
artifactFactory	ArtifactFactory	Used to create artifacts
artifactId	String	ArtifactId of the artifact to be installed. Retrieved from POM file if specified.
classifier	String	Classifier type of the artifact to be installed. For example, "sources" or "javadoc". Defaults to none which means this is the project's main jar.
createChecksum	boolean	Flag Whether to create checksums(MD5, SHA1) or not. Default value is false.
generatePom	boolean	Install a POM for this artifact. Will generate a default POM if none is supplied with the pomFile argument. Default value is false.
groupId	String	GroupId of the artifact to be installed. Retrieved from POM file if specified.
localRepositoryId	String	The id for the localRepo
localRepositoryPath	File	The path for a specific local repository directory. It will wrap into an ArtifactRepository with localRepoId as id and with default repositoryLayout
md5Digester	Digester	Digester for MD5.
packaging	String	Packaging type of the artifact to be installed. Retrieved from POM file if specified
pomFile	File	Location of an existing POM file to be deployed alongside the main artifact, given by the ${file} parameter.
repositoryLayouts	Map	Map that contains the layouts
sha1Digester	Digester	Digester for SHA-1.
version	String	Version of the artifact to be installed. Retrieved from POM file if specified

Parameter Details

artifactFactory

Used to create artifacts

• Type: org.apache.maven.artifact.factory.ArtifactFactory
• Required: No

---

artifactId ArtifactId of the artifact to be installed. Retrieved from POM file if specified.

• Type: java.lang.String
• Required: No
• Expression: ${artifactId}

---

classifier Classifier type of the artifact to be installed. For example, "sources" or "javadoc". Defaults to none which means this is the project's main jar.

• Type: java.lang.String
• Required: No
• Expression: ${classifier}

---

createChecksum Flag Whether to create checksums(MD5, SHA1) or not.

• Type: boolean
• Required: No
• Expression: ${createChecksum}
• Default: false

---

file The file to be deployed

• Type: java.io.File
• Required: Yes
• Expression: ${file}

---

generatePom Install a POM for this artifact. Will generate a default POM if none is supplied with the pomFile argument.

• Type: boolean
• Required: No
• Expression: ${generatePom}
• Default: false

---

groupId GroupId of the artifact to be installed. Retrieved from POM file if specified.

• Type: java.lang.String
• Required: No
• Expression: ${groupId}

---

localRepositoryId The id for the localRepo

• Type: java.lang.String
• Required: No
• Expression: ${localRepositoryId}

---

localRepositoryPath The path for a specific local repository directory. It will wrap into an ArtifactRepository with localRepoId as id and with default repositoryLayout

• Type: java.io.File
• Required: No
• Expression: ${localRepositoryPath}

---

md5Digester Digester for MD5.

• Type: org.codehaus.plexus.digest.Digester
• Required: No

---

packaging Packaging type of the artifact to be installed. Retrieved from POM file if specified

• Type: java.lang.String
• Required: No
• Expression: ${packaging}

---

pomFile Location of an existing POM file to be deployed alongside the main artifact, given by the ${file} parameter.

• Type: java.io.File
• Required: No
• Expression: ${pomFile}

---

repositoryLayout The type of remote repository layout to deploy to. Try legacy for a Maven 1.x-style repository layout.

• Type: java.lang.String
• Required: Yes
• Expression: ${repositoryLayout}
• Default: default

---

repositoryLayouts Map that contains the layouts

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

---

sha1Digester Digester for SHA-1.

• Type: org.codehaus.plexus.digest.Digester
• Required: No

---

version Version of the artifact to be installed. Retrieved from POM file if specified

• Type: java.lang.String
• Required: No
• Expression: ${version}