Package aQute.bnd.build

Class ProjectLauncher

  • All Implemented Interfaces:
    Constants, Registry, Report, Reporter, java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<java.lang.String>
    Direct Known Subclasses:
    JUnitLauncher
    public abstract class ProjectLauncher
extends Processor
    A Project Launcher is a base class to be extended by launchers. Launchers are JARs that launch a framework and install a number of bundles and then run the framework. A launcher jar must specify a Launcher-Class manifest header. This class is instantiated and cast to a LauncherPlugin. This plug in is then asked to provide a ProjectLauncher. This project launcher is then used by the project to run the code. Launchers must extend this class.

    • Field Detail

      • EMBEDDED_ACTIVATOR

        public static final java.lang.String EMBEDDED_ACTIVATOR
        See Also:
        Constant Field Values

      • logger

        static final org.slf4j.Logger logger

      • project

        private final Project project

      • onUpdate

        private final java.util.List<java.lang.Runnable> onUpdate

      • timeout

        private long timeout

      • classpath

        private final java.util.List<java.lang.String> classpath

      • runbundles

        private java.util.List<java.lang.String> runbundles

      • runvm

        private final java.util.List<java.lang.String> runvm

      • runprogramargs

        private final java.util.List<java.lang.String> runprogramargs

      • runframeworkrestart

        private boolean runframeworkrestart

      • runproperties

        private java.util.Map<java.lang.String,​java.lang.String> runproperties

      • runsystempackages

        private Parameters runsystempackages

      • runsystemcapabilities

        private Parameters runsystemcapabilities

      • activators

        private final java.util.List<java.lang.String> activators

      • storageDir

        private java.io.File storageDir

      • trace

        private boolean trace

      • keep

        private boolean keep

      • framework

        private int framework

      • cwd

        private java.io.File cwd

      • agents

        private java.util.Collection<java.lang.String> agents

      • out

        protected java.lang.Appendable out

      • err

        protected java.lang.Appendable err

      • in

        protected java.io.InputStream in

      • IGNORE

        static final java.util.regex.Pattern IGNORE
        launch a framework internally. I.e. do not start a separate process.

    • Constructor Detail

      • ProjectLauncher

        public ProjectLauncher​(Project project)
                throws java.lang.Exception
        Throws:
        java.lang.Exception

    • Method Detail

      • validate

        protected void validate()
        Validate some settings

      • updateFromProject

        protected void updateFromProject()
                          throws java.lang.Exception
        Collect all the aspect from the project and set the local fields from them. Should be called after constructor has been called.
        Throws:
        java.lang.Exception

      • getRunframework

        private int getRunframework​(java.lang.String property)

      • addClasspath

        public void addClasspath​(Container container)
                  throws java.lang.Exception
        Throws:
        java.lang.Exception

      • addClasspath

        protected void addClasspath​(Container container,
                            java.util.List<java.lang.String> pathlist)
                     throws java.lang.Exception
        Throws:
        java.lang.Exception

      • addClasspath

        protected void addClasspath​(java.util.Collection<Container> path)
                     throws java.lang.Exception
        Throws:
        java.lang.Exception

      • addRunBundle

        public void addRunBundle​(java.lang.String path)

      • getRunBundles

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

      • addRunVM

        public void addRunVM​(java.lang.String arg)

      • addRunProgramArgs

        public void addRunProgramArgs​(java.lang.String arg)

      • getRunpath

        public java.util.List<java.lang.String> getRunpath()

      • getClasspath

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

      • getRunVM

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

      • getArguments

        @Deprecated
public java.util.Collection<java.lang.String> getArguments()
        Deprecated.

      • getRunProgramArgs

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

      • getRunProperties

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

      • getStorageDir

        public java.io.File getStorageDir()

      • getMainTypeName

        public abstract java.lang.String getMainTypeName()

      • update

        public void update()
            throws java.lang.Exception
        Throws:
        java.lang.Exception

      • onUpdate

        public void onUpdate​(java.lang.Runnable update)

      • getJavaExecutable

        public java.lang.String getJavaExecutable​(java.lang.String java)
        Overrides:
        getJavaExecutable in class Processor

      • launch

        public int launch()
           throws java.lang.Exception
        Throws:
        java.lang.Exception

      • start

        public int start​(java.lang.ClassLoader parent)
          throws java.lang.Exception
        Throws:
        java.lang.Exception

      • invoke

        protected int invoke​(java.lang.Class<?> main,
                     java.lang.String[] args)
              throws java.lang.Exception
        Throws:
        java.lang.Exception

      • cleanup

        public void cleanup()
        Is called after the process exists. Can you be used to cleanup the properties file.

      • reportResult

        protected void reportResult​(int result)

      • setTimeout

        public void setTimeout​(long timeout,
                       java.util.concurrent.TimeUnit unit)

      • getTimeout

        public long getTimeout()

      • cancel

        public void cancel()
            throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getSystemPackages

        public java.util.Map<java.lang.String,​? extends java.util.Map<java.lang.String,​java.lang.String>> getSystemPackages()

      • getSystemCapabilities

        public java.lang.String getSystemCapabilities()

      • getSystemCapabilitiesParameters

        public Parameters getSystemCapabilitiesParameters()

      • setKeep

        public void setKeep​(boolean keep)

      • isKeep

        public boolean isKeep()

      • setTrace

        public void setTrace​(boolean level)
        Overrides:
        setTrace in class Processor

      • getTrace

        public boolean getTrace()

      • prepare

        public void prepare()
             throws java.lang.Exception
        Should be called when all the changes to the launchers are set. Will calculate whatever is necessary for the launcher.
        Throws:
        java.lang.Exception

      • getProject

        public Project getProject()

      • addActivator

        public boolean addActivator​(java.lang.String e)

      • getActivators

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

      • getRunFramework

        public int getRunFramework()
        Either NONE or SERVICES to indicate how the remote end launches. NONE means it should not use the classpath to run a framework. This likely requires some dummy framework support. SERVICES means it should load the framework from the claspath.

      • setRunFramework

        public void setRunFramework​(int n)

      • addDefault

        public void addDefault​(java.lang.String defaultSpec)
                throws java.lang.Exception
        Add the specification for a set of bundles the runpath if it does not already is included. This can be used by subclasses to ensure the proper jars are on the classpath.
        Parameters:
        defaultSpec - The default spec for default jars
        Throws:
        java.lang.Exception

      • executable

        public Jar executable()
               throws java.lang.Exception
        Create a self executable.
        Throws:
        java.lang.Exception

      • getCwd

        public java.io.File getCwd()

      • setCwd

        public void setCwd​(java.io.File cwd)

      • getRunJdb

        public java.lang.String getRunJdb()

      • getRunEnv

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

      • setStreams

        public void setStreams​(java.lang.Appendable out,
                       java.lang.Appendable err)
        Set the stderr and stdout streams for the output process. The debugged process must append its output (i.e. write operation in the process under debug) to the given appendables.
        Parameters:
        out - std out
        err - std err

      • write

        public void write​(java.lang.String text)
           throws java.lang.Exception
        Write text to the debugged process as if it came from stdin.
        Parameters:
        text - the text to write
        Throws:
        java.lang.Exception

      • getRunSessions

        public java.util.List<? extends RunSession> getRunSessions()
                                                    throws java.lang.Exception
        Get the run sessions. If this return null, then launch on this object should be used, otherwise each returned object provides a remote session.
        Throws:
        java.lang.Exception

      • calculatedProperties

        public void calculatedProperties​(java.util.Map<java.lang.String,​java.lang.String> properties)
                          throws java.lang.Exception
        Utility to calculate the final framework properties from settings
        Throws:
        java.lang.Exception

      • setupStartlevels

        private void setupStartlevels​(java.util.Map<java.lang.String,​java.lang.String> properties)
                       throws java.lang.Exception,
                              java.io.IOException
        Calculate the start level properties. This code is matched to the aQute.lib class StartLevelRuntimeHandler that handles the runtime details.

        The -runbundles instruction can carry a `startlevel` attribute. If any bundle has this start level attribute we control the startlevel process. If no bundle has this attribute, then the start level handling is not doing anything. The remaining section assumes that there is at least 1 bundle with a set startlevel attribute.

        The StartLevelRuntimeHandler.LAUNCH_STARTLEVEL_DEFAULT is then set to the maximum startlevel + 1. This signals that the StartLevelRuntimeHandler class handles the runtime aspects.

        The Constants.RUNSTARTLEVEL_BEGIN controls the beginning start level of the framework after the framework itself is started. The user can set this or else it is set to the maxmum startlevel+2.

        During runtime, the handler must be created with StartLevelRuntimeHandler.create(aQute.lib.startlevel.Trace, Map) before the framework is created since it may change the properties. I.e. the properties given to the FrameworkFactory must be the same object as given to the create method. One thing is that it will set the Constants.RUNSTARTLEVEL_BEGIN to ensure that all bundles are installed at level 1.

        After the framework is created, the runtime handler StartLevelRuntimeHandler.beforeStart(org.osgi.framework.launch.Framework) must be called. This will prepare that bundles will get their proper start level when installed.

        After the set of bundles is installed, the StartLevelRuntimeHandler.afterStart() is called to raise the start level to the desired level. Either the set Constants.RUNSTARTLEVEL_BEGIN or the maximum level + 2.

        Throws:
        java.lang.Exception
        java.io.IOException

      • liveCoding

        public ProjectLauncher.LiveCoding liveCoding​(java.util.concurrent.Executor executor,
                                             java.util.concurrent.ScheduledExecutorService scheduledExecutor)
                                      throws java.lang.Exception
        Throws:
        java.lang.Exception

      • isRunFrameworkRestart

        public boolean isRunFrameworkRestart()