org.netbeans.api.autoupdate

Class PluginInstaller

java.lang.Object

org.netbeans.api.autoupdate.PluginInstaller

public final class PluginInstaller
extends Object

Allows to programmatically install plugins. It serves as a frontend API to UI/CLI whichever is installed - other modules need to provide the actual installation provider to handle the requests. No default implementation for the installation provider is present by default unless additional modules like autoupdate.ui is installed. If no providers are registered, the installation fails as if the user had rejected the operation using "Cancel" button.

Since:

1.76

Constructor Summary

Constructors

Constructor and Description
PluginInstaller()

Method Summary

Modifier and Type	Method and Description
static PluginInstaller	getDefault()
Object	install(Set<String> codenamebases, String displayName, Lookup context, Object... alternativeOptions) Attempts to install one or more plugins, specified by their codebases.
Object	install(String codenamebase) Installs a single module.
Object	install(String codenamebase, String displayName, Lookup context, Object... alternativeOptions) Installs a single module.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginInstaller

public PluginInstaller()

Method Detail

getDefault

public static PluginInstaller getDefault()

install

public Object install(@NonNull
                      String codenamebase,
                      @NonNull
                      String displayName,
                      Lookup context,
                      @NonNull
                      Object... alternativeOptions)

Installs a single module. When reporting progress or messages, uses the supplied `displayName`; use null to use a generic description possibly based on the module name/codename. The method converts the UserCancelException thrown by the actual implementation into NotifyDescriptor.CANCEL_OPTION for compatibility with older code. Otherwise, see PluginInstaller.install(java.lang.String, java.lang.String, org.openide.util.Lookup, java.lang.Object...).

Parameters:

codenamebase - codename base to install

displayName - title/heading for messages

context - additional context passed to the process

alternativeOptions - possible failure resolution choices

Returns:

null on success, NotifyDescriptor.CANCEL_OPTION if the operation is rejected (i.e. user cancel) or one of "alternativeOptions".

install

public Object install(@NonNull
                      String codenamebase)

Installs a single module. Uses some default title for possible progress indication during module search and installation. Does not support alternative options. The method converts the UserCancelException thrown by the actual implementation into NotifyDescriptor.CANCEL_OPTION for compatibility with older code. Otherwise, see PluginInstaller.install(java.lang.String, java.lang.String, org.openide.util.Lookup, java.lang.Object...).

Parameters:

codenamebase - codename base of the module to install

Returns:

null on success, NotifyDescriptor.CANCEL_OPTION if the operation is rejected (i.e. user cancel).

install

public Object install(@NonNull
                      Set<String> codenamebases,
                      String displayName,
                      Lookup context,
                      Object... alternativeOptions)
               throws OperationException,
                      UserCancelException

Attempts to install one or more plugins, specified by their codebases. During module + dependency search and download some interim progress messages can be displayed - the `displayName` will be used as a title, heading or otherwise provide informative context for those messages. If the display name is not provided, some generic title can be used (i.e. searching, installing).

If fetching the plugin catalog data fails on I/O, the user can get a choice to retry the process or cancel the operation. `alternativeOptions` are presented as other alternative solutions. If the user chooses to cancel, operation ends with NotifyDescriptor.CANCEL_OPTION. The user can choose to retry the operation. The user can also select one of the `alternativeOptions`, which will terminate the operation with the chosen option as a result. During the download, the operation can be cancelled resulting in NotifyDescriptor.CANCEL_OPTION.

If the operation completes successfully, the method returns null.

In the case that no installation provider is installed, the implementation throws UserCancelException as if the operation was rejected by the user.

Parameters:

codenamebases - codename bases of modules to install. The modules will be installed in no particular order.

displayName -

alternativeOptions -

Returns:

null on success. NotifyDescriptor.CANCEL_OPTION on cancel, or one of `alternativeOptions` on failure according to user's choice.

Throws:

OperationException - if the download or installation / enable operation fails.

UserCancelException - if the operation is rejected.