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.5.0: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`. User property is: `repositoryId`.
url | `String` | `-` | Remote OBR repository URL, where the bundle details are to be uploaded. User property is: `url`.

### Optional Parameters

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

### Parameter Details

artifactId:

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

- Type: `java.lang.String`
- Required: `No`
- User Property: `artifactId`

bundleUrl:

Optional public URL where the bundle has been deployed.

- Type: `java.lang.String`
- Required: `No`
- User Property: `bundleUrl`

classifier:

Classifier type of the bundle. Defaults to none.

- Type: `java.lang.String`
- Required: `No`
- User Property: `classifier`

file:

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

- Type: `java.io.File`
- Required: `No`
- User Property: `file`

groupId:

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

- Type: `java.lang.String`
- Required: `No`
- User Property: `groupId`

ignoreLock:

When true, ignore remote locking.

- Type: `boolean`
- Required: `No`
- User Property: `ignoreLock`

obrRepository:

Local OBR Repository.

- Type: `java.lang.String`
- Required: `No`
- User Property: `obrRepository`

obrXml:

Optional XML file describing additional requirements and capabilities.

- Type: `java.lang.String`
- Required: `No`
- User Property: `obrXml`

packaging:

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

- Type: `java.lang.String`
- Required: `No`
- User Property: `packaging`

pomFile:

Location of an existing POM file.

- Type: `java.io.File`
- Required: `No`
- User Property: `pomFile`

remoteOBR:

Remote OBR Repository.

- Type: `java.lang.String`
- Required: `No`
- User Property: `remoteOBR`

repositoryId:

Remote repository id, used to lookup authentication settings.

- Type: `java.lang.String`
- Required: `Yes`
- User Property: `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`
- User Property: `url`

version:

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

- Type: `java.lang.String`
- Required: `No`
- User Property: `version`