Maven Bundle Plugin - bundle:deploy-file

Maven Bundle Plugin

##### Overview

- Introduction
- Goals
- Wiki
- FAQ
- Release Notes

##### Project Documentation

- Project Information
- Project Reports

## bundle:deploy-file

Full name:

org.apache.felix:maven-bundle-plugin:2.3.5:deploy-file

Description:

Deploys bundle details to a remote OBR repository (command-line goal)

Attributes:

- Binds by default to the lifecycle phase: `deploy`.

### Required Parameters

Name | Type | Since | Description
--- | --- | --- | ---
repositoryId | `String` | `-` | Remote repository id, used to lookup authentication settings. Default value is: `remote-repository`.
url | `String` | `-` | Remote OBR repository URL, where the bundle details are to be uploaded.

### Optional Parameters

Name | Type | Since | Description
--- | --- | --- | ---
artifactId | `String` | `-` | ArtifactId of the bundle. Retrieved from POM file if specified.
bundleUrl | `String` | `-` | Optional public URL where the bundle has been deployed.
classifier | `String` | `-` | Classifier type of the bundle. Defaults to none.
file | `File` | `-` | Bundle file, defaults to the artifact in the local Maven repository.
groupId | `String` | `-` | GroupId of the bundle. Retrieved from POM file if specified.
ignoreLock | `boolean` | `-` | When true, ignore remote locking.
obrRepository | `String` | `-` | Local OBR Repository.
obrXml | `String` | `-` | Optional XML file describing additional requirements and capabilities.
packaging | `String` | `-` | Packaging type of the bundle. Retrieved from POM file if specified.
pomFile | `File` | `-` | Location of an existing POM file.
remoteOBR | `String` | `-` | Remote OBR Repository.
supportedProjectTypes | `List` | `-` | Project types which this plugin supports.
version | `String` | `-` | Version of the bundle. Retrieved from POM file if specified.

### Parameter Details

artifactId:

ArtifactId of the bundle. Retrieved from POM file if specified.

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

bundleUrl:

Optional public URL where the bundle has been deployed.

- Type: `java.lang.String`
- Required: `No`
- Expression: `${bundleUrl}`

classifier:

Classifier type of the bundle. Defaults to none.

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

file:

Bundle file, defaults to the artifact in the local Maven repository.

- Type: `java.io.File`
- Required: `No`
- Expression: `${file}`

groupId:

GroupId of the bundle. Retrieved from POM file if specified.

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

ignoreLock:

When true, ignore remote locking.

- Type: `boolean`
- Required: `No`
- Expression: `${ignoreLock}`

obrRepository:

Local OBR Repository.

- Type: `java.lang.String`
- Required: `No`
- Expression: `${obrRepository}`

obrXml:

Optional XML file describing additional requirements and capabilities.

- Type: `java.lang.String`
- Required: `No`
- Expression: `${obrXml}`

packaging:

Packaging type of the bundle. Retrieved from POM file if specified.

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

pomFile:

Location of an existing POM file.

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

remoteOBR:

Remote OBR Repository.

- Type: `java.lang.String`
- Required: `No`
- Expression: `${remoteOBR}`

repositoryId:

Remote repository id, used to lookup authentication settings.

- Type: `java.lang.String`
- Required: `Yes`
- Expression: `${repositoryId}`
- Default: `remote-repository`

supportedProjectTypes:

Project types which this plugin supports.

- Type: `java.util.List`
- Required: `No`

url:

Remote OBR repository URL, where the bundle details are to be uploaded.

- Type: `java.lang.String`
- Required: `Yes`
- Expression: `${url}`

version:

Version of the bundle. Retrieved from POM file if specified.

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