org.netbeans.modules.autoupdate.ui.api

Class PluginManager

java.lang.Object

org.netbeans.modules.autoupdate.ui.api.PluginManager

public final class PluginManager
extends Object

Access to UI features of PluginManager that can be useful in other modules as well.

Since:

1.21

Method Summary

Modifier and Type	Method and Description
static Object	install(Set<String> codenamebases, Object... alternativeOptions) Open standard dialog for installing modules including declared dependencies.
static Object	installSingle(String codenamebase, String displayName, Object... alternativeOptions) Open standard dialog for installing a module including declared dependencies.
static boolean	openInstallWizard(OperationContainer<InstallSupport> container) Open standard dialog for installing set of modules.
static void	openInstallWizard(OperationContainer<InstallSupport> container, boolean runInBackground) Open standard dialog for installing set of modules.

Methods inherited from class java.lang.Object

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

Method Detail

openInstallWizard

public static boolean openInstallWizard(OperationContainer<InstallSupport> container)

Open standard dialog for installing set of modules. Shows it to the user, asks for confirmation, license acceptance, etc. The whole operation requires AWT dispatch thread access (to show the dialog) and blocks (until the user clicks through), so either call from AWT dispatch thread directly, or be sure you hold no locks and block no progress of other threads to avoid deadlocks.

Single module installation can be handled easily by PluginManager.installSingle(java.lang.String, java.lang.String, java.lang.Object[]).

OperationContainer<InstallSupport> container = OperationContainer.createForInstall();
for (UpdateUnit u : UpdateManager.getDefault().getUpdateUnits(UpdateManager.TYPE.MODULE)) {
    if (u.getCodeName().matches("org.my.favorite.module")) {
        if (u.getAvailableUpdates().isEmpty()) {
            continue;
        }
        container.add(u.getAvailableUpdates().get(0));
    }
}
PluginManager.openInstallWizard(container);

Parameters:

container - the container with list of modules for install

Returns:

true if all the requested modules were successfully installed, false otherwise.

See Also:

PluginManager.installSingle(java.lang.String, java.lang.String, java.lang.Object[]), PluginManager.install(java.util.Set, java.lang.Object[])

openInstallWizard

public static void openInstallWizard(OperationContainer<InstallSupport> container,
                                     boolean runInBackground)

Open standard dialog for installing set of modules. Shows it to the user, asks for confirmation, license acceptance, etc. The whole operation requires AWT dispatch thread access (to show the dialog) and blocks (until the user clicks through), so either call from AWT dispatch thread directly, or be sure you hold no locks and block no progress of other threads to avoid deadlocks.

Parameters:

container - the container with list of modules for install

runInBackground - if true then installation run in the background after license acceptance

installSingle

@CheckForNull
public static Object installSingle(@NonNull
                                                 String codenamebase,
                                                 @NonNull
                                                 String displayName,
                                                 @NonNull
                                                 Object... alternativeOptions)

Open standard dialog for installing a module including declared dependencies. Shows it to the user, asks for confirmation, license acceptance, etc. The whole operation requires AWT dispatch thread access (to show the dialog) and blocks (until the user clicks through), so either call from AWT dispatch thread directly, or be sure you hold no locks and block no progress of other threads to avoid deadlocks.

Parameters:

codenamebase - the codenamebase of module to install

displayName - the display name of the module

alternativeOptions - alternative options possibly displayed in error dialog user may choose if it is not possible to install the plugin; if chosen the option is return value of this method

Returns:

null if the module has been successfully installed and/or activated, otherwise it returns the options user has selected in problem dialog, typically NotifyDescriptor.DEFAULT_OPTION (on esc), NotifyDescriptor.CANCEL_OPTION or any of alternativeOptions.

Since:

1.35

See Also:

PluginManager.install(java.util.Set, java.lang.Object[])

install

@CheckForNull
public static Object install(@NonNull
                                           Set<String> codenamebases,
                                           @NonNull
                                           Object... alternativeOptions)

Open standard dialog for installing modules including declared dependencies. Shows it to the user, asks for confirmation, license acceptance, etc. The whole operation requires AWT dispatch thread access (to show the dialog) and blocks (until the user clicks through), so either call from AWT dispatch thread directly, or be sure you hold no locks and block no progress of other threads to avoid deadlocks.

Although the method is not deprecated, modules that only uses PluginManager.install to install additional plugins should now depend on autoupdate.services directly, and use PluginInstaller.install(java.lang.String, java.lang.String, org.openide.util.Lookup, java.lang.Object...) to reduce UI dependencies.

Parameters:

codenamebases - the codenamebases of modules to install; must contain at least one codenamebase

alternativeOptions - alternative options possibly displayed in error dialog user may choose if it is not possible to install the plugin; if chosen the option is return value of this method

Returns:

null if all the requested modules have been successfully installed and/or activated, otherwise it returns the options user has selected in problem dialog, typically NotifyDescriptor.DEFAULT_OPTION (on esc), NotifyDescriptor.CANCEL_OPTION or any of alternativeOptions.

Throws:

IllegalArgumentException - if the codenamebases is empty

Since:

1.35