org.netbeans.spi.autoupdate

Interface UpdateProvider

public interface UpdateProvider

UpdateProvider providers items for Autoupdate infrastructure. The items are available on e.g. Update Center. Items can represents NetBeans Module, its Localization, Feature as group of NetBeans Modules or special components which needs own native installer to make them accessible in NetBeans product. The infrastructure finds out UpdateProvider in Lookup.getDefault(), the provider can be registring declaratively in XML layer. Note: the former Autoupdate module allows declaration of former AutoupdateType on XML layer, these declaration are read as new one UpdateProvider by reason of backward compatability.

Method Summary

Modifier and Type	Method and Description
UpdateUnitProvider.CATEGORY	getCategory()
String	getDescription() Description of provider.
String	getDisplayName() Display name of provider.
String	getName() Name of provider, this name is used by Autoupdate infrastructure for manimulating of providers.
Map<String,UpdateItem>	getUpdateItems() Returns UpdateItems which is mapped to its unique ID.
boolean	refresh(boolean force) Make refresh of content of the provider.

Method Detail

getName

String getName()

Name of provider, this name is used by Autoupdate infrastructure for manimulating of providers.

Returns:

name of provider

getDisplayName

String getDisplayName()

Display name of provider. This display name can be visualized in UI.

Returns:

display name of provider

getDescription

String getDescription()

Description of provider. This description can be visualized in UI.

Returns:

description of provider or null

getCategory

UpdateUnitProvider.CATEGORY getCategory()

Returns:

UpdateUnitProvider.CATEGORY for a quality classification of updates comming from this instance

getUpdateItems

Map<String,UpdateItem> getUpdateItems()
                               throws IOException

Returns UpdateItems which is mapped to its unique ID. Unique ID depends on the type of UpdateItem.

Returns:

Map of code name of UpdateItem and instance of UpdateItem

Throws:

IOException - when any network problem appreared

See Also:

UpdateItem

refresh

boolean refresh(boolean force)
         throws IOException

Make refresh of content of the provider. The content can by read from a cache. The force parameter forces reading content from remote server.

Parameters:

force - if true then forces to reread the content from server

Returns:

true if refresh succeed

Throws:

IOException - when any network problem appreared