net.thevpc.nuts.runtime.core

Interface NutsWorkspaceExt

All Known Implementing Classes:

DefaultNutsWorkspace, NutsWorkspaceSessionAwareImpl

public interface NutsWorkspaceExt

Author:

thevpc

Method Summary

Modifier and Type	Method and Description
NutsExecutionContextBuilder	createExecutionContext()
NutsSession	defaultSession()
void	deployBoot(NutsSession session, NutsId def, boolean withDependencies) Deprecated.
String	getHelpText(NutsSession session)
NutsInstalledRepository	getInstalledRepository()
NutsInstallerComponent	getInstaller(NutsDefinition nutToInstall, NutsSession session)
NutsInstallStatus	getInstallStatus(NutsId id, boolean checkDependencies, NutsSession session)
String	getLicenseText(NutsSession session)
String	getWelcomeText(NutsSession session)
void	installImpl(NutsDefinition def, String[] args, NutsInstallerComponent installerComponent, NutsSession session, boolean updateDefaultVersion)
static NutsWorkspaceExt	of(NutsWorkspace ws)
void	requireImpl(NutsDefinition def, NutsSession session, boolean withDependencies, NutsId[] forId)
boolean	requiresRuntimeExtension(NutsSession session) true when runtime extension is required for running this workspace.
String	resolveDefaultHelp(Class clazz, NutsSession session)
NutsDescriptor	resolveEffectiveDescriptor(NutsDescriptor descriptor, NutsSession session)
NutsId	resolveEffectiveId(NutsDescriptor descriptor, NutsSession options)
NutsIdType	resolveNutsIdType(NutsId id, NutsSession session)
void	updateImpl(NutsDefinition def, String[] args, NutsInstallerComponent installerComponent, NutsSession session, boolean updateDefaultVersion)

Method Detail

of

static NutsWorkspaceExt of(NutsWorkspace ws)

getWelcomeText

String getWelcomeText(NutsSession session)

getHelpText

String getHelpText(NutsSession session)

getLicenseText

String getLicenseText(NutsSession session)

resolveDefaultHelp

String resolveDefaultHelp(Class clazz,
                          NutsSession session)

resolveEffectiveId

NutsId resolveEffectiveId(NutsDescriptor descriptor,
                          NutsSession options)

resolveNutsIdType

NutsIdType resolveNutsIdType(NutsId id,
                             NutsSession session)

getInstaller

NutsInstallerComponent getInstaller(NutsDefinition nutToInstall,
                                    NutsSession session)

requireImpl

void requireImpl(NutsDefinition def,
                 NutsSession session,
                 boolean withDependencies,
                 NutsId[] forId)

installImpl

void installImpl(NutsDefinition def,
                 String[] args,
                 NutsInstallerComponent installerComponent,
                 NutsSession session,
                 boolean updateDefaultVersion)

updateImpl

void updateImpl(NutsDefinition def,
                String[] args,
                NutsInstallerComponent installerComponent,
                NutsSession session,
                boolean updateDefaultVersion)

requiresRuntimeExtension

boolean requiresRuntimeExtension(NutsSession session)

true when runtime extension is required for running this workspace. A default implementation should be as follow, but developers may implements this with other logic : runtime extension is required when there are no extensions or when the NutsConstants.ENV_KEY_EXCLUDE_RUNTIME_EXTENSION is forced to false

Parameters:

session - session

Returns:

true when runtime extension is required for running this workspace

resolveEffectiveDescriptor

NutsDescriptor resolveEffectiveDescriptor(NutsDescriptor descriptor,
                                          NutsSession session)

getInstalledRepository

NutsInstalledRepository getInstalledRepository()

getInstallStatus

NutsInstallStatus getInstallStatus(NutsId id,
                                   boolean checkDependencies,
                                   NutsSession session)

createExecutionContext

NutsExecutionContextBuilder createExecutionContext()

deployBoot

@Deprecated
void deployBoot(NutsSession session,
                            NutsId def,
                            boolean withDependencies)

Deprecated.

defaultSession

NutsSession defaultSession()