Package xsbti

Interface Launcher


  • public interface Launcher
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int InterfaceVersion  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      AppProvider app​(ApplicationID id, java.lang.String version)
      returns an `AppProvider` which is able to resolve an application and instantiate its `xsbti.Main` in a new classloader.
      Repository[] appRepositories()
      These are the repositories configured by this launcher which should be used by the application when resolving further artifacts.
      java.io.File bootDirectory()
      Value of the `sbt.boot.dir` property, or the default boot configuration defined in `boot.directory`.
      java.lang.String[] checksums()
      An array of the checksums that should be checked when retreiving artifacts.
      ScalaProvider getScala​(java.lang.String version)  
      ScalaProvider getScala​(java.lang.String version, java.lang.String reason)  
      ScalaProvider getScala​(java.lang.String version, java.lang.String reason, java.lang.String scalaOrg)  
      GlobalLock globalLock()
      Return the global lock for interacting with the file system.
      boolean isOverrideRepositories()
      The user has configured the launcher with the only repositories it wants to use for this applciation.
      java.io.File ivyHome()
      The value of `ivy.ivy-home` of the boot properties file.
      Repository[] ivyRepositories()
      Configured launcher repositories.
      java.lang.ClassLoader topLoader()
      This returns the "top" classloader for a launched application.
    • Method Detail

      • getScala

        ScalaProvider getScala​(java.lang.String version,
                               java.lang.String reason)
      • getScala

        ScalaProvider getScala​(java.lang.String version,
                               java.lang.String reason,
                               java.lang.String scalaOrg)
      • app

        AppProvider app​(ApplicationID id,
                        java.lang.String version)
        returns an `AppProvider` which is able to resolve an application and instantiate its `xsbti.Main` in a new classloader. See [AppProvider] for more details.
        Parameters:
        id - The artifact coordinates of the application.
        version - The version to resolve
      • topLoader

        java.lang.ClassLoader topLoader()
        This returns the "top" classloader for a launched application. This classlaoder lives somewhere *above* that used for the application. This classloader is used for doing any sort of JNA/native library loads so that downstream loaders can share native libraries rather than run into "load-once" restrictions.
      • globalLock

        GlobalLock globalLock()
        Return the global lock for interacting with the file system. A mechanism to do file-based locking correctly on the JVM. See the [[GlobalLock]] class for more details.
      • bootDirectory

        java.io.File bootDirectory()
        Value of the `sbt.boot.dir` property, or the default boot configuration defined in `boot.directory`.
      • ivyRepositories

        Repository[] ivyRepositories()
        Configured launcher repositories. These repositories are the same ones used to load the launcher.
      • appRepositories

        Repository[] appRepositories()
        These are the repositories configured by this launcher which should be used by the application when resolving further artifacts.
      • isOverrideRepositories

        boolean isOverrideRepositories()
        The user has configured the launcher with the only repositories it wants to use for this applciation.
      • ivyHome

        java.io.File ivyHome()
        The value of `ivy.ivy-home` of the boot properties file. This defaults to the `sbt.ivy.home` property, or `~/.ivy2`. Use this setting in an application when using Ivy to resolve more artifacts.
        Returns:
        a file, or null if not set.
      • checksums

        java.lang.String[] checksums()
        An array of the checksums that should be checked when retreiving artifacts. Configured via the the `ivy.checksums` section of the boot configuration. Defaults to sha1, md5 or the value of the `sbt.checksums` property.