Interface InstallParameters

All Known Implementing Classes:
InstallParametersImpl
public interface InstallParameters
Collects a set of parameters.

  • Field Details

    • ALL_FRAGMENTS

      static final Set<String> ALL_FRAGMENTS

    • NULL_PARAMS

      static final InstallParameters NULL_PARAMS
      Install parameters returning null in implemented methods.

  • Method Details

    • getConnection

      @Nullable @Nullable Connection getConnection()
      The connection to apply the installation to. If null, the connection from the default data source is used.

    • getModules

      @Nullable @Nullable Set<String> getModules()
      A set of module names to install. If null, the whole application (all modules) are installed.

    • getCallbackHandler

      @Nullable @Nullable CallbackHandler getCallbackHandler()
      The callback handler handling possible callbacks from the installation routine. Some installation steps might not require this, but some do. Look at the documentation of Step for more information.

    • getVersion

      @Nullable @Nullable Nice2Version getVersion()
      If a version V is specified, only those changelogs with a version <= V are executed.

    • getActiveFragmentIds

      Set<String> getActiveFragmentIds()
      A set of fragment ids that are to install. Fragments that are not in this set are skipped. Use ALL_FRAGMENTS to have all fragments included (the default).