Skip to main content
Link
Menu
Expand
(external link)
Document
Search
Copy
Copied
bnd
Home
Getting Started
Introduction
How to install bnd
Guided Tour Workspace & Projects
bnd / bndlib Features and JAR Wrapping Techniques
FAQ - Frequently Asked Questions
Concepts and Practices
Concepts
Background
Best practices
Build and Development
Build
Project Setup
Generating JARs
Versioning
Baselining
Service Components
Metatype
Contracts
Bundle Annotations
Accessor Properties
SPI Annotations
Dependency and Launching
Resolving Dependencies
Launching
Startlevels
Testing
Testing Framework
Testing with Launchpad
Packaging and Distribution
Packaging Applications
JPMS Libraries
Wrapping Libraries to OSGi Bundles
Documentation and Tools
Generating Documentation
bnd CLI Commands
For Developers
Templates for Workspaces
Tips for Windows users
Tools bound to bnd
Reference Material
Reference
External Plugins
Configuration and Troubleshooting
Settings
Errors
Warnings
HEADERS
Headers
.bnd
Automatic-Module-Name
bin
Bnd-AddXmlToTest RESOURCE ( ',' RESOURCE )
Bnd-LastModified LONG
Bundle-ActivationPolicy ::= policy ( ';' directive )*
Bundle-Activator CLASS
Bundle-Blueprint RESOURE (',' RESOURCE )
Bundle-Category STRING (',' STRING )
Bundle-ClassPath ::= entry ( ',' entry )*
Bundle-ContactAddress
Bundle-Contributors ...
Bundle-Copyright STRING
Bundle-Description STRING
Bundle-Developers ...
Bundle-DocURL STRING
Bundle-Icon
Bundle-License ::= '<<[EXTERNAL]>>' | ( license ( ',' license ) * )
Bundle-Localization
Bundle-ManifestVersion ::= 2
Bundle-Name STRING
Bundle-NativeCode ::= nativecode ( ',' nativecode )* ( ',' optional ) ?
Bundle-RequiredExecutionEnvironment ::= ee-name ( ',' ee-name )*
Bundle-SCM
Bundle-SymbolicName ::= symbolic-name ( ';' parameter ) *
Bundle-UpdateLocation
Bundle-Vendor
Bundle-Version ::= version
Conditional-Package PACKAGE-SPEC ( ',' PACKAGE-SPEC ) *
Created-By STRING
DynamicImport-Package ::= dynamic-description ( ',' dynamic-description )*
Export-Package ::= export ( ',' export)*
Export-Service
Fragment-Host ::= bundle-description
Ignore-Package
Import-Package ::= import ( ',' import )*
javac
javac.encoding
javac.profile
javac.source
javac.target
Meta-Persistence ::= ( RESOURCE ( ',' RESOURCE )* )?
Private-Package PACKAGE-SPEC ( ',' PACKAGE-SPEC )*
Provide-Capability ::= capability (',' capability )*
Require-Bundle ::= bundle-description ( ',' bundle-description )*
Require-Capability ::= requirement ( ',' requirement )*
Service-Component ::= RESOURCE ( ',' RESOURCE )
src
target-dir
Test-Cases CLASS ( ',' CLASS ) *
testbin
Tester-Plugin
testsrc
Tool STRING
INSTRUCTIONS
Instruction Reference
-augment PARAMETER ( ',' PARAMETER ) *
-baseline selector
-baselinerepo qname
-bnd-driver
-builderignore PATH-SPEC ( ',' PATH-SPEC ) *
-buildpath PATH
-buildrepo repo ( ',' repo ) *
-buildtool toolspec (EXPERIMENTAL!)
-bumppolicy
-bundleannotations SELECTORS
-cdiannotations SELECTORS
-check 'ALL' | ( 'IMPORTS' | 'EXPORTS' ) *
-classpath FILE (',' FILE) *
-compression DEFLATE | STORE
-conditionalpackage PACKAGE-SPEC ( ',' PACKAGE-SPEC ) *
-conduit
-connection-settings
-consumer-policy VERSION-MASK
-contract
-define-contract
-dependson SELECTORS
-deploy
-deployrepo
-diffignore SELECTORS
-diffpackages SELECTORS
-digests DIGEST ( ',' DIGEST ) *
-distro REPO (',' REPO)
-donotcopy
-dsannotations SELECTORS
-dsannotations-options SELECTORS
-eeprofile 'auto' | PROFILE +
-executable ( rejar= STORE | DEFLATE ) ( ',' strip= matcher ( ',' matcher )* ) ( ',' location= FORMAT )
-export PATH ( ';' PARAMETER )* ( ',' PATH ( ';' PARAMETER )* )*
-export-apiguardian PACKAGE-SPEC, ( ',' PACKAGE-SPEC )*
-exportcontents PACKAGE-SPEC, ( ',' PACKAGE-SPEC )*
-exportreport report-def ( ',' report-def )*
-exporttype
-extension
-failok ('true' | 'false')?
-fixupmessages SELECTOR ( ';' ( is | replace | restrict ) )* ...
-generate srcs ';output=' DIR ( ';' ( system | generate | classpath))* ...
-gestalt
-groupid groupId
-include PATH-SPEC ( ',' PATH-SPEC ) *
-includepackage PACKAGE-SPEC, ( ',' PACKAGE-SPEC )*
-includeresource iclause
-init ${MACRO} ( ',' ${MACRO}) *
-invalidfilenames
-javaagent BOOLEAN
-jpms-module-info modulename [; version=
] [; access=OPEN|SYNTHETIC|MANDATED]
-jpms-module-info-options module-infos+
-jpms-multi-release BOOLEAN
-launcher
-library library ( ',' library )*
-make
-manifest FILE
-manifest-name RESOURCE
-maven-dependencies* entry ( ',' entry )*
-maven-release ('local'|'remote') ( ',' option )*
-maven-scope dependency-scope
-metainf-services
-metatypeannotations SELECTORS
-metatypeannotations-options SELECTORS
-namesection RESOURCE-SPEC ( ',' RESOURCE-SPEC ) *
-nobuildincache BOOLEAN
-nobundles BOOLEAN
-noclassforname BOOLEAN
-nodefaultversion BOOLEAN
-noee BOOLEAN
-noextraheaders BOOLEAN
-noimportjava BOOLEAN
-nojunit BOOLEAN
-nojunitosgi BOOLEAN
-nomanifest BOOLEAN
-noparallel CATEGORY;task=TASKS
-noproxyinterfaces BOOLEAN
-nosubstitution
-nouses BOOLEAN
-output FILE
-outputmask TEMPLATE ?
-packageinfotype
-pedantic BOOLEAN
-plugin.* plugin-def ( ',' plugin-def )*
-pluginpath* PARAMETERS
-pom BOOLEAN | PROPERTIES
-prepare makespec ( ',' makespec )*
-preprocessmatchers SELECTOR
-privatepackage PACKAGE-SPEC
-profile KEY
-provider-policy VERSION-MASK
-releaserepo* NAME ( ',' NAME ) *
-remoteworkspace (true|false)
-removeheaders KEY-SELECTOR ( '.' KEY-SELECTOR ) *
-reportconfig plugin-def ( ',' plugin-def )*
-reportnewer BOOLEAN
-reproducible BOOLEAN | TIMESTAMP
-require-bnd (FILTER ( ',' FILTER )* )?
-resolve (manual|auto|beforelaunch|batch|cache)
-resolve.effective qname (',' qname )
-resolve.excludesystem true|false
-resolve.preferences qname ( ',' qname )
-resolve.reject ( '@'? namespace ( ';filter:=' FILTER )? ),
-resolvedebug INTEGER
-resourceonly BOOLEAN
-runblacklist requirement (',' requirement)
-runbuilds BOOLEAN
-runbundles* REPO-ENTRY ( ',' REPO-ENTRY )*
-runee EE
-runenv PROPERTIES
-runframework ( 'none' | 'services' | ANY )?
-runframeworkrestart BOOLEAN
-runfw REPO-ENTRY
-runjdb ADDRESS
-runkeep true | false
-runnoreferences BOOLEAN
-runoptions
-runpath REPO-ENTRY ( ',' REPO-ENTRY )
-runprogramargs
-runproperties PROPERTIES
-runprovidedcapabilities
-runremote
-runrepos REPO-NAME ( ',' REPO-NAME )*
-runrequires REQUIREMENT ( ',' REQUIREMENT )*
-runstartlevel ( order | begin | step )*
-runstorage FILE
-runsystemcapabilities* CAPABILITY (',' CAPABILITY )
-runsystempackages* PARAMETERS
-runtimeout DURATION
-runtrace BOOLEAN
-runvm KEYS
-savemanifest FILE
-sign PARAMETERS
-snapshot STRING
-sourcepath
-sources BOOLEAN
-stalecheck srcs ';newer=' depends ( ';' ( warning | error | command ))* ...
-standalone repo-spec (, repo-spec )
-strict BOOLEAN
-sub FILE-SPEC ( ',' FILE-SPEC )*
-systemproperties PROPERTIES
-testcontinuous BOOLEAN
-tester REPO-SPEC
-testpackages PACKAGE-SPEC ( ',' PACKAGE-SPEC )
-testpath REPO-SPEC ( ',' REPO-SPEC )
-testsources REGEX ( ',' REGEX )*
-testunresolved BOOLEAN
-undertest true
-upto VERSION
-wab FILE ( ',' FILE )*
-wablib FILE ( ',' FILE )*
-workingset PARAMETER ( ',' PARAMETER ) *
-workspace-templates
-x-overwritestrategy
MACROS
Macro Reference
apply ';' MACRO (';' LIST)*
average (';' LIST )*
base64 ';' FILE [';' LONG ]
basedir
basename ( ';' FILEPATH ) +
basenameext ';' PATH ( ';' EXTENSION )
bndversion
bsn
bytes ( ';' LONG )*
cat ';' FILEPATH
classes ( ; QUERY ( ; PATTERN )? )*
compare STRING STRING
currenttime
decorated ';' NAME [ ';' BOOLEAN ]
def ';' KEY (';' STRING)?
digest ';' ALGORITHM ';' FILE
dir ( ';' FILE )*
driver ( ';' NAME )?
ee
endswith ';' STRING ';' SUFFIX
env ';' KEY (';' STRING)?
error ( ';' STRING )*
exporters ';' PACKAGE
exports
extension ';' PATH
fileuri ';' PATH
filter ';' LIST ';' REGEX
filterout ';' LIST ';' REGEX
find ';' VALUE ';' SEARCHED
findfile ';' PATH ( ';' FILTER )
findlast ';' VALUE ';' SEARCHED
findname ';' REGEX ( ';' REPLACEMENT )?
findpath ';' REGEX ( ';' REPLACE )?
findproviders ';' namespace ( ';' FILTER ( ';' STRATEGY)? )?
first (';' LIST )*
fmodified ( ';' RESOURCE )+
foreach ';' MACRO (';' LIST)*
format ';' STRING (';' ANY )*
frange ';' VERSION ( ';' BOOLEAN )?
gestalt ';' NAME ( ';' NAME (';' ANY )? )?
get ';' INDEX (';' LIST )*
githead
glob ';' GLOBEXP
global ';' KEY ( ';' DEFAULT )?
ide ';' ( 'javac.target' | 'javac.source' )
if ';' STRING ';' STRING ( ';' STRING )?
imports
indexof ';' STRING (';' LIST )*
is ( ';' ANY )*
isdir ( ';' FILE )+
isempty ( ';' STRING )*
isfile (';' FILE )+
isnumber ( ';' STRING )*
join ( ';' LIST )+
js (';' JAVASCRIPT )*
last (';' LIST )*
lastindexof ';' STRING (';' LIST )*
length STRING
list (';' KEY)*
literal ';' STRING
long2date
lsa ';' DIR (';' SELECTORS )
lsr ';' DIR (';' SELECTORS )
map ';' MACRO (';' LIST)*
matches STRING REGEX
maven_version ';' MAVEN-VERSION
max (';' LIST )*
md5 ';' RESOURCE
min (';' LIST )*
native_capability ( ';' ( 'os.name' | 'os.version' | 'os.processor' ) '=' STRING )*
ncompare NUMBER NUMBER
nmax (';' LIST )*
nmin (';' LIST )*
now ( 'long' | DATEFORMAT )
nsort (';' LIST )+
osfile ';' DIR ';' NAME
p_allsourcepath
p_bootclasspath
p_buildpath
p_dependson
p_output
p_sourcepath
p_testpath
packageattribute ';' PACKAGE (';' ATTRIBUTE)?
packages
path ( ';' FILES )+
pathseparator
permissions (';' ( 'packages' | 'admin' | 'permissions' ) )+
propertiesdir
propertiesname
rand (';' MIN ' (;' MAX )?)?
random
range ';' RANGE_MASK ( ';' VERSION )
reject ';' LIST ';' REGEX
removeall ';' LIST ';' LIST
replace ';' LIST ';' REGEX (';' STRING (';' STRING)? )?
replacelist ';' LIST ';' REGEX (';' STRING (';' STRING)? )?
replacestring ';' STRING ';' REGEX (';' STRING )?
repo ';' BSN ( ';' VERSION ( ';' STRATEGY )? )?
repodigests ( ';' NAME )*
repos
retainall ';' LIST ';' LIST
reverse (';' LIST )*
select ';' LIST ';' REGEX
separator
sha1 ';' RESOURCE
size ( ';' LIST )*
sjoin ';' SEPARATOR ( ';' LIST )+
sort (';' LIST )+
split ';' REGEX (';' STRING )*
startswith ';' STRING ';' PREFIX
stem ';' STRING
sublist ';' START ';' END (';' LIST )*
subst ';' STRING ';' REGEX (';' STRING (';' NUMBER )? )?
substring ';' STRING ';' START ( ';' END )?
sum (';' LIST )*
system ';' STRING ( ';' STRING )?
system_allow_fail ';' STRING ( ';' STRING )?
template ';' NAME [ ';' template ]+
thisfile
toclassname ';' FILES
toclasspath ';' LIST ( ';' BOOLEAN )?
tolower STRING
toupper STRING
trim ';' STRING
tstamp ( ';' DATEFORMAT ( ';' TIMEZONE ( ';' LONG )? )? )?
unescape ( ';' STRING )*
uniq (';' LIST )*
uri ';' URI (';' URI)?
user ';' KEY ( ';' DEFAULT )?
vcompare VERSION VERSION
version MASK VERSION?
version_cleanup ';' VERSION
versionmask MASK VERSION?
vmax (';' LIST )*
vmin (';' LIST )*
warning ( ';' STRING )*
workspace
CLI COMMANDS
bnd CLI Commands
action
add
baseline
bash
bnd
bootstrap
bsn2url
build
buildtool
buildx
bump
changes
classpath
classtoresource
clean
collect
com
compile
convert
copy
create
debug
defaults
deliverables
dependencies
dev
diff
digest
do
eclipse
ees
export
exportreport
extract
find
flatten
generate
generatemanual
gmd
graph
grep
index
info
junit
macro
maven ( 'settings' | 'bundle'
mbr
nexus
package
packagetoresource
plugins
print
profile
project
properties
release
remote
remove
repo
resolve
run
runtests
schema
select
settings
shell [options]
source
sync
syntax
test
type
verify
version
view
wrap
xmlrepodiff
xref
PLUGINS
Plugins
Ant
AspectJ Plugin
Blueprint
Bnd Pom Repository
Eclipse
FileRepo Plugin
Git
Gradle Workspace Plugin
Jpa
Local Index Repo
Maven Bnd Repository Plugin
OBR Index Exporter Plugin
OSGi Repository
P2 Exporter
P2 Repository
Signer
Spring
Url.basic.authentication
Url.bnd.authentication
Url.https.verification
Search bnd
GitHub
bndtools.org
master
Foundational concepts and best practices for working with bnd and OSGi.
Table of contents
Concepts
Background
Best practices