aQute.bnd.build
Class Project

java.lang.Object
  aQute.lib.osgi.Processor
      aQute.bnd.build.Project

All Implemented Interfaces:

Constants, Reporter, java.io.Closeable

public class Project
extends Processor

This class is NOT threadsafe

Field Summary

static java.lang.String	BNDCNF
static java.lang.String	BNDFILE

Fields inherited from class aQute.lib.osgi.Processor

DEFAULT_PLUGINS, LIST_SPLITTER

Fields inherited from interface aQute.lib.osgi.Constants

BLUEPRINT_TIMEOUT_ATTRIBUTE, BLUEPRINT_WAIT_FOR_DEPENDENCIES_ATTRIBUTE, BND_ADDXMLTOTEST, BND_LASTMODIFIED, BUILDFILES, BUILDPATH, BUMPPOLICY, BUNDLE_ACTIVATIONPOLICY, BUNDLE_ACTIVATOR, BUNDLE_BLUEPRINT, BUNDLE_CATEGORY, BUNDLE_CLASSPATH, BUNDLE_CONTACTADDRESS, BUNDLE_COPYRIGHT, BUNDLE_DESCRIPTION, BUNDLE_DOCURL, BUNDLE_ICON, BUNDLE_LICENSE, BUNDLE_LOCALIZATION, BUNDLE_MANIFESTVERSION, BUNDLE_NAME, BUNDLE_NATIVECODE, BUNDLE_REQUIREDEXECUTIONENVIRONMENT, BUNDLE_SPECIFIC_HEADERS, BUNDLE_SYMBOLIC_NAME_ATTRIBUTE, BUNDLE_SYMBOLICNAME, BUNDLE_UPDATELOCATION, BUNDLE_VENDOR, BUNDLE_VERSION, BUNDLE_VERSION_ATTRIBUTE, CLASSPATH, COMMAND_DIRECTIVE, COMPILER_SOURCE, COMPILER_TARGET, CONDITIONAL_PACKAGE, CONDUIT, CONSUMER_POLICY, CREATED_BY, CURRENT_PACKAGE, CURRENT_USES, CURRENT_VERSION, DEBUG, DEFAULT_BAR_EXTENSION, DEFAULT_BND_EXTENSION, DEFAULT_BNDRUN_EXTENSION, DEFAULT_CHARSET, DEFAULT_DO_NOT_COPY, DEFAULT_JAR_EXTENSION, DEFAULT_LAUNCHER_BSN, DEFAULT_TESTER_BSN, DEPENDSON, DEPLOY, DEPLOYREPO, DESCRIPTION_ATTRIBUTE, directives, DONOTCOPY, DUPLICATE_MARKER, DYNAMICIMPORT_PACKAGE, EMBEDDED_REPO, EMPTY_HEADER, EXCLUDE_DIRECTIVE, EXPORT_CONTENTS, EXPORT_PACKAGE, EXPORT_SERVICE, EXTENSION_DIRECTIVE, FAIL_OK, FRAGMENT_ATTACHMENT_DIRECTIVE, FRAGMENT_HOST, FROM_DIRECTIVE, headers, IGNORE_PACKAGE, IMPORT_DIRECTIVE, IMPORT_PACKAGE, IMPORT_PRIVATE, IMPORT_REFERENCE, IMPORT_SERVICE, importDirectives, INCLUDE, INCLUDE_DIRECTIVE, INCLUDE_RESOURCE, INCLUDERESOURCE, KEYSTORE_LOCATION_DIRECTIVE, KEYSTORE_PASSWORD_DIRECTIVE, KEYSTORE_PROVIDER_DIRECTIVE, LANGUAGE_ATTRIBUTE, LAUNCHER_PLUGIN, LIB_DIRECTIVE, LINK_ATTRIBUTE, MAKE, MANDATORY_DIRECTIVE, MANIFEST, METAPACKAGES, METATYPE, NAME_ATTRIBUTE, NO_IMPORT_DIRECTIVE, NOANNOTATIONS, NOBUNDLES, NODEFAULTVERSION, NOEXTRAHEADERS, NOMANIFEST, NONE, NOPE, NOUSES, options, OSNAME_ATTRIBUTE, OSVERSION_ATTRIBUTE, PATH_DIRECTIVE, PEDANTIC, PLUGIN, POM, PRESENCE_DIRECTIVE, PRIVATE_DIRECTIVE, PRIVATE_PACKAGE, PROCESSOR_ATTRIBUTE, PROVIDE_DIRECTIVE, PROVIDER_POLICY, RELEASEREPO, REMOVE_ATTRIBUTE_DIRECTIVE, REMOVEHEADERS, REPORTNEWER, REQUIRE_BND, REQUIRE_BUNDLE, RESOLUTION_DIRECTIVE, RESOURCEONLY, RUNBUNDLES, RUNFRAMEWORK, RUNFRAMEWORK_NONE, RUNFRAMEWORK_SERVICES, RUNPATH, RUNPATH_LAUNCHER_DIRECTIVE, RUNPATH_MAIN_DIRECTIVE, RUNPROPERTIES, RUNSYSTEMPACKAGES, RUNTIMEOUT, RUNTRACE, RUNVM, SAVEMANIFEST, SELECTION_FILTER_ATTRIBUTE, SERVICE_COMPONENT, SIGN, SIGN_PASSWORD_DIRECTIVE, SIGNATURE_TEST, SINGLETON_DIRECTIVE, SIZE_ATTRIBUTE, SOURCEPATH, SOURCES, SPECIFICATION_VERSION, SPLIT_PACKAGE_DIRECTIVE, STRATEGY_EXACT, STRATEGY_HIGHEST, STRATEGY_LOWEST, SUB, TESTCASES, TESTER_PLUGIN, TESTPACKAGES, TESTPATH, TESTREPORT, TOOL, UNDERTEST, USES_DIRECTIVE, USES_USES, VALID_PROPERTY_TYPES, VERBOSE, VERSION_ATTRIBUTE, VERSIONPOLICY, VERSIONPOLICY_IMPL, VERSIONPOLICY_USES, VISIBILITY_DIRECTIVE, WAB, WABLIB

Constructor Summary

Project(Workspace workspace, java.io.File buildDir)

Project(Workspace workspace, java.io.File projectDir, java.io.File buildFile)

Method Summary

java.lang.String	_findfile(java.lang.String[] args)
java.lang.String	_help(java.lang.String[] args)
java.lang.String	_p_allsourcepath(java.lang.String[] args)
java.lang.String	_p_bootclasspath(java.lang.String[] args)
java.lang.String	_p_buildpath(java.lang.String[] args)
java.lang.String	_p_dependson(java.lang.String[] args)
java.lang.String	_p_output(java.lang.String[] args)
java.lang.String	_p_sourcepath(java.lang.String[] args)
java.lang.String	_p_testpath(java.lang.String[] args)
java.lang.String	_project(java.lang.String[] args)
java.lang.String	_repo(java.lang.String[] args) Macro access to the repository ${repo;[;[;]]}
java.lang.String	_repos(java.lang.String[] args)
void	action(java.lang.String command)
java.io.File[]	build()
java.io.File[]	build(boolean underTest) This is the external method that will pre-build any dependencies if it is out of date.
java.io.File[]	buildLocal(boolean underTest) Build without doing any dependency checking.
void	bump()
void	bump(java.lang.String mask)
void	clean()
void	deploy() Deploy the current project to a repository
void	deploy(java.io.File file) Deploy the file (which must be a bundle) into the repository.
void	deploy(java.lang.String name, java.io.File file) Deploy the file (which must be a bundle) into the repository.
void	fillActions(java.util.Map<java.lang.String,Action> all)
java.util.Map<java.lang.String,Action>	getActions()
java.util.Collection<java.io.File>	getAllsourcepath()
java.util.Collection<Container>	getBootclasspath()
ProjectBuilder	getBuilder(ProjectBuilder parent) Return a new builder that is nicely setup for this project.
java.io.File[]	getBuildFiles() This method must only be called when it is sure that the project has been build before in the same session.
java.io.File[]	getBuildFiles(boolean buildIfAbsent)
java.util.Collection<Container>	getBuildpath()
long	getBuildTime()
Container	getBundle(java.lang.String bsn, java.lang.String range, int strategyx, java.util.Map<java.lang.String,java.lang.String> attrs) Get a bundle from one of the plugin repositories.
java.util.List<Container>	getBundles(int strategyx, java.lang.String spec) Analyze the header and return a list of files that should be on the build, test or some other path.
int	getChanged()
Container	getDeliverable(java.lang.String bsn, java.util.Map<java.lang.String,java.lang.String> attrs) Answer the container associated with a given bsn.
java.util.Collection<Container>	getDeliverables() Returns containers for the deliverables of this project.
java.util.Collection<Project>	getDependson()
protected java.lang.Object[]	getMacroDomains() This should be overridden by subclasses to add extra macro command domains on the search list.
java.lang.String	getName()
java.io.File	getOutput()
ProjectLauncher	getProjectLauncher() Get a launcher.
ProjectTester	getProjectTester()
java.util.Collection<Container>	getRunbundles()
java.util.Collection<Container>	getRunpath()
java.util.Map<java.lang.String,java.lang.String>	getRunProperties()
java.util.Collection<java.lang.String>	getRunVM()
java.util.Collection<java.io.File>	getSourcePath()
java.io.File	getSrc()
Builder	getSubBuilder(java.io.File bndFile) Return the builder associated with the give bnd file or null.
java.util.Collection<? extends Builder>	getSubBuilders() Get a list of the sub builders.
java.io.File	getTarget()
java.util.Collection<Container>	getTestpath()
static Project	getUnparented(java.io.File propertiesFile)
Jar	getValidJar(java.io.File f) This methods attempts to turn any jar into a valid jar.
Jar	getValidJar(Jar jar, java.lang.String id)
Jar	getValidJar(java.net.URL url)
Workspace	getWorkspace()
boolean	isCnf()
boolean	isValid()
boolean	lock(java.lang.String reason)
void	prepare() Set up all the paths
void	propertiesChanged()
boolean	refresh() Refresh if we are based on stale data.
void	refreshAll()
void	release()
void	release(boolean test)
java.io.File	release(Jar jar)
void	release(java.lang.String name) Release.
void	release(java.lang.String name, boolean test) Release
java.io.File	release(java.lang.String name, Jar jar) Release
void	run()
java.io.File	saveBuild(Jar jar)
void	script(java.lang.String type, java.lang.String script)
void	setChanged()
void	setDelayRunDependencies(boolean x) Make this project delay the calculation of the run dependencies.
void	test()
java.lang.String	toString()
void	unlock()

Methods inherited from class aQute.lib.osgi.Processor

_basedir, addBasicPlugin, addClose, addIncluded, addProperties, append, appendPath, begin, clear, close, delete, doAttrbutes, doIncludeFile, error, error, exists, getBase, getClass, getDuration, getErrors, getExecutor, getFile, getFile, getFlattenedProperties, getInfo, getInfo, getManifestAsProperties, getParent, getPlugins, getPlugins, getProperties, getPropertiesFile, getProperty, getProperty, getReplacer, getTop, getWarnings, isDuplicate, isExceptions, isFailOk, isMissingPlugin, isOk, isPedantic, isPerfect, isTrace, isTrue, join, join, join, join, join, lastModified, loadProperties, merge, merge, mergeProperties, mergeProperties, newHashMap, newList, newList, newMap, newMap, newSet, newSet, normalize, normalize, parseHeader, parseHeader, printClause, printClauses, printClauses, progress, read, removeBasicPlugin, removeDuplicateMarker, replaceAll, setBase, setExceptions, setFileMustExist, setForceLocal, setParent, setPedantic, setProperties, setProperties, setProperties, setProperty, setTrace, split, split, split, trace, unsetProperty, updateModified, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BNDFILE

public static final java.lang.String BNDFILE

See Also:

Constant Field Values

BNDCNF

public static final java.lang.String BNDCNF

See Also:

Constant Field Values

Constructor Detail

Project

public Project(Workspace workspace,
               java.io.File projectDir,
               java.io.File buildFile)
        throws java.lang.Exception

Throws:

java.lang.Exception

Project

public Project(Workspace workspace,
               java.io.File buildDir)
        throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getUnparented

public static Project getUnparented(java.io.File propertiesFile)
                             throws java.lang.Exception

Throws:

java.lang.Exception

isValid

public boolean isValid()

getBuilder

public ProjectBuilder getBuilder(ProjectBuilder parent)
                          throws java.lang.Exception

Return a new builder that is nicely setup for this project. Please close this builder after use.

Parameters:

parent - The project builder to use as parent, use this project if null

Returns:

Throws:

java.lang.Exception

getChanged

public int getChanged()

setChanged

public void setChanged()

getWorkspace

public Workspace getWorkspace()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

prepare

public void prepare()
             throws java.lang.Exception

Set up all the paths

Throws:

java.lang.Exception

getSrc

public java.io.File getSrc()

getBundles

public java.util.List<Container> getBundles(int strategyx,
                                            java.lang.String spec)
                                     throws java.lang.Exception

Analyze the header and return a list of files that should be on the build, test or some other path. The list is assumed to be a list of bsns with a version specification. The special case of version=project indicates there is a project in the same workspace. The path to the output directory is calculated. The default directory ${bin} can be overridden with the output attribute.

Parameters:

strategy - STRATEGY_LOWEST or STRATEGY_HIGHEST

spec - The header

Returns:

Throws:

java.lang.Exception

getDependson

public java.util.Collection<Project> getDependson()
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getBuildpath

public java.util.Collection<Container> getBuildpath()
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getTestpath

public java.util.Collection<Container> getTestpath()
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getRunpath

public java.util.Collection<Container> getRunpath()
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getRunbundles

public java.util.Collection<Container> getRunbundles()
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getSourcePath

public java.util.Collection<java.io.File> getSourcePath()
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getAllsourcepath

public java.util.Collection<java.io.File> getAllsourcepath()
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getBootclasspath

public java.util.Collection<Container> getBootclasspath()
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getOutput

public java.io.File getOutput()
                       throws java.lang.Exception

Throws:

java.lang.Exception

_p_dependson

public java.lang.String _p_dependson(java.lang.String[] args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

_p_buildpath

public java.lang.String _p_buildpath(java.lang.String[] args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

_p_testpath

public java.lang.String _p_testpath(java.lang.String[] args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

_p_sourcepath

public java.lang.String _p_sourcepath(java.lang.String[] args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

_p_allsourcepath

public java.lang.String _p_allsourcepath(java.lang.String[] args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

_p_bootclasspath

public java.lang.String _p_bootclasspath(java.lang.String[] args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

_p_output

public java.lang.String _p_output(java.lang.String[] args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getMacroDomains

protected java.lang.Object[] getMacroDomains()

Description copied from class: Processor

This should be overridden by subclasses to add extra macro command domains on the search list.

Overrides:

getMacroDomains in class Processor

Returns:

release

public java.io.File release(Jar jar)
                     throws java.lang.Exception

Throws:

java.lang.Exception

release

public java.io.File release(java.lang.String name,
                            Jar jar)
                     throws java.lang.Exception

Release

Parameters:

name - The repository name

jar -

Returns:

Throws:

java.lang.Exception

release

public void release(boolean test)
             throws java.lang.Exception

Throws:

java.lang.Exception

release

public void release(java.lang.String name,
                    boolean test)
             throws java.lang.Exception

Release

Parameters:

name - The respository name

test - Run testcases

Throws:

java.lang.Exception

getBundle

public Container getBundle(java.lang.String bsn,
                           java.lang.String range,
                           int strategyx,
                           java.util.Map<java.lang.String,java.lang.String> attrs)
                    throws java.lang.Exception

Get a bundle from one of the plugin repositories.

Parameters:

bsn - The bundle symbolic name

range - The version range

lowest - set to LOWEST or HIGHEST

Returns:

the file object that points to the bundle or null if not found

Throws:

java.lang.Exception - when something goes wrong

deploy

public void deploy(java.lang.String name,
                   java.io.File file)
            throws java.lang.Exception

Deploy the file (which must be a bundle) into the repository.

Parameters:

name - The repository name

file - bundle

Throws:

java.lang.Exception

deploy

public void deploy(java.io.File file)
            throws java.lang.Exception

Deploy the file (which must be a bundle) into the repository.

Parameters:

file - bundle

Throws:

java.lang.Exception

deploy

public void deploy()
            throws java.lang.Exception

Deploy the current project to a repository

Throws:

java.lang.Exception

_repo

public java.lang.String _repo(java.lang.String[] args)
                       throws java.lang.Exception

Macro access to the repository ${repo;[;[;]]}

Throws:

java.lang.Exception

getTarget

public java.io.File getTarget()
                       throws java.lang.Exception

Throws:

java.lang.Exception

build

public java.io.File[] build(boolean underTest)
                     throws java.lang.Exception

This is the external method that will pre-build any dependencies if it is out of date.

Parameters:

underTest -

Returns:

Throws:

java.lang.Exception

getBuildFiles

public java.io.File[] getBuildFiles()
                             throws java.lang.Exception

This method must only be called when it is sure that the project has been build before in the same session. It is a bit yucky, but ant creates different class spaces which makes it hard to detect we already build it.

Returns:

Throws:

java.lang.Exception

getBuildFiles

public java.io.File[] getBuildFiles(boolean buildIfAbsent)
                             throws java.lang.Exception

Throws:

java.lang.Exception

buildLocal

public java.io.File[] buildLocal(boolean underTest)
                          throws java.lang.Exception

Build without doing any dependency checking. Make sure any dependent projects are built first.

Parameters:

underTest -

Returns:

Throws:

java.lang.Exception

saveBuild

public java.io.File saveBuild(Jar jar)
                       throws java.lang.Exception

Throws:

java.lang.Exception

refresh

public boolean refresh()

Refresh if we are based on stale data. This also implies our workspace.

Overrides:

refresh in class Processor

isCnf

public boolean isCnf()

propertiesChanged

public void propertiesChanged()

Overrides:

propertiesChanged in class Processor

getName

public java.lang.String getName()

getActions

public java.util.Map<java.lang.String,Action> getActions()

fillActions

public void fillActions(java.util.Map<java.lang.String,Action> all)

release

public void release()
             throws java.lang.Exception

Throws:

java.lang.Exception

release

public void release(java.lang.String name)
             throws java.lang.Exception

Release.

Parameters:

name - The repository name

Throws:

java.lang.Exception

clean

public void clean()
           throws java.lang.Exception

Throws:

java.lang.Exception

build

public java.io.File[] build()
                     throws java.lang.Exception

Throws:

java.lang.Exception

run

public void run()
         throws java.lang.Exception

Throws:

java.lang.Exception

test

public void test()
          throws java.lang.Exception

Throws:

java.lang.Exception

getValidJar

public Jar getValidJar(java.io.File f)
                throws java.lang.Exception

This methods attempts to turn any jar into a valid jar. If this is a bundle with manifest, a manifest is added based on defaults. If it is a bundle, but not r4, we try to add the r4 headers.

Parameters:

descriptor -

in -

Returns:

Throws:

java.lang.Exception

getValidJar

public Jar getValidJar(java.net.URL url)
                throws java.lang.Exception

Throws:

java.lang.Exception

getValidJar

public Jar getValidJar(Jar jar,
                       java.lang.String id)
                throws java.lang.Exception

Throws:

java.lang.Exception

_project

public java.lang.String _project(java.lang.String[] args)

bump

public void bump(java.lang.String mask)
          throws java.io.IOException

Throws:

java.io.IOException

bump

public void bump()
          throws java.io.IOException

Throws:

java.io.IOException

action

public void action(java.lang.String command)
            throws java.lang.Throwable

Throws:

java.lang.Throwable

_findfile

public java.lang.String _findfile(java.lang.String[] args)

refreshAll

public void refreshAll()

script

public void script(java.lang.String type,
                   java.lang.String script)
            throws java.lang.Exception

Throws:

java.lang.Exception

_repos

public java.lang.String _repos(java.lang.String[] args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

_help

public java.lang.String _help(java.lang.String[] args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getDeliverables

public java.util.Collection<Container> getDeliverables()
                                                throws java.lang.Exception

Returns containers for the deliverables of this project. The deliverables is the project builder for this project if no -sub is specified. Otherwise it contains all the sub bnd files.

Returns:

A collection of containers

Throws:

java.lang.Exception

getSubBuilder

public Builder getSubBuilder(java.io.File bndFile)
                      throws java.lang.Exception

Return the builder associated with the give bnd file or null. The bnd.bnd file can contain -sub option. This option allows specifying files in the same directory that should drive the generation of multiple deliverables. This method figures out if the bndFile is actually one of the bnd files of a deliverable.

Parameters:

bndFile - A file pointing to a bnd file.

Returns:

null or the builder for a sub file.

Throws:

java.lang.Exception

getDeliverable

public Container getDeliverable(java.lang.String bsn,
                                java.util.Map<java.lang.String,java.lang.String> attrs)
                         throws java.lang.Exception

Answer the container associated with a given bsn.

Parameters:

bndFile - A file pointing to a bnd file.

Returns:

null or the builder for a sub file.

Throws:

java.lang.Exception

getSubBuilders

public java.util.Collection<? extends Builder> getSubBuilders()
                                                       throws java.lang.Exception

Get a list of the sub builders. A bnd.bnd file can contain the -sub option. This will generate multiple deliverables. This method returns the builders for each sub file. If no -sub option is present, the list will contain a builder for the bnd.bnd file.

Returns:

A list of builders.

Throws:

java.lang.Exception

getRunVM

public java.util.Collection<java.lang.String> getRunVM()

getRunProperties

public java.util.Map<java.lang.String,java.lang.String> getRunProperties()

getProjectLauncher

public ProjectLauncher getProjectLauncher()
                                   throws java.lang.Exception

Get a launcher.

Returns:

Throws:

java.lang.Exception

getProjectTester

public ProjectTester getProjectTester()
                               throws java.lang.Exception

Throws:

java.lang.Exception

lock

public boolean lock(java.lang.String reason)
             throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

unlock

public void unlock()

getBuildTime

public long getBuildTime()
                  throws java.lang.Exception

Throws:

java.lang.Exception

setDelayRunDependencies

public void setDelayRunDependencies(boolean x)

Make this project delay the calculation of the run dependencies. The run dependencies calculation can be done in prepare or until the dependencies are actually needed.