ro.fortsoft.pf4j.update

Class UpdateManager

java.lang.Object

ro.fortsoft.pf4j.update.UpdateManager

public class UpdateManager
extends Object

Author:

Decebal Suiu

Field Summary

Fields

Modifier and Type	Field and Description
ro.fortsoft.pf4j.PluginManager	pluginManager
protected List<UpdateRepository>	repositories

Constructor Summary

Constructors

Constructor and Description
UpdateManager(ro.fortsoft.pf4j.PluginManager pluginManager)
UpdateManager(ro.fortsoft.pf4j.PluginManager pluginManager, List<UpdateRepository> repos)
UpdateManager(ro.fortsoft.pf4j.PluginManager pluginManager, java.nio.file.Path repositoriesJson)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRepository(String id, URL url) Add one DefaultUpdateRepository
void	addRepository(UpdateRepository newRepo) Add a repo that was created by client
protected java.nio.file.Path	downloadPlugin(String id, String version) Downloads a plugin with given coordinates and returns a path to the file
protected URL	findUrlForPlugin(String id, String version) Resolves url from id and version
List<PluginInfo>	getAvailablePlugins()
protected FileDownloader	getFileDownloader(String pluginId) Finds the FileDownloader to use for this repository
List<PluginInfo>	getPlugins() Get the list of plugins from all repos
Map<String,PluginInfo>	getPluginsMap() Get a map of all plugins from all repos where key is plugin id
List<UpdateRepository>	getRepositories()
List<PluginInfo>	getUpdates() Return a list of plugins that are newer versions of already installed plugins
boolean	hasAvailablePlugins()
boolean	hasUpdates() Checks if Update Repositories has newer versions of some of the installed plugins
protected void	initRepositoriesFromJson()
boolean	installPlugin(String id, String version) Installs a plugin by id and version
void	refresh() Refreshes all repositories, so they are forced to refresh list of plugins
void	removeRepository(String id) Remove a repository by id
void	setRepositories(List<UpdateRepository> repositories) Replace all repositories
boolean	uninstallPlugin(String id)
boolean	updatePlugin(String id, String version) Updates a plugin id to given version or to latest version if version == null

Methods inherited from class java.lang.Object

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

Field Detail

repositories

protected List<UpdateRepository> repositories

pluginManager

public ro.fortsoft.pf4j.PluginManager pluginManager

Constructor Detail

UpdateManager

public UpdateManager(ro.fortsoft.pf4j.PluginManager pluginManager)

UpdateManager

public UpdateManager(ro.fortsoft.pf4j.PluginManager pluginManager,
             java.nio.file.Path repositoriesJson)

UpdateManager

public UpdateManager(ro.fortsoft.pf4j.PluginManager pluginManager,
             List<UpdateRepository> repos)

Method Detail

getAvailablePlugins

public List<PluginInfo> getAvailablePlugins()

hasAvailablePlugins

public boolean hasAvailablePlugins()

getUpdates

public List<PluginInfo> getUpdates()

Return a list of plugins that are newer versions of already installed plugins

Returns:

list of plugins that have updates

hasUpdates

public boolean hasUpdates()

Checks if Update Repositories has newer versions of some of the installed plugins

Returns:

true if updates exist

getPlugins

public List<PluginInfo> getPlugins()

Get the list of plugins from all repos

Returns:

List of plugin info

getPluginsMap

public Map<String,PluginInfo> getPluginsMap()

Get a map of all plugins from all repos where key is plugin id

Returns:

List of plugin info

getRepositories

public List<UpdateRepository> getRepositories()

setRepositories

public void setRepositories(List<UpdateRepository> repositories)

Replace all repositories

Parameters:

repositories - list of new repositories

addRepository

public void addRepository(String id,
                 URL url)

Add one DefaultUpdateRepository

Parameters:

id - of repo

url - of repo

addRepository

public void addRepository(UpdateRepository newRepo)

Add a repo that was created by client

Parameters:

newRepo - the new UpdateRepository to add to the list

removeRepository

public void removeRepository(String id)

Remove a repository by id

Parameters:

id - of repository to remove

refresh

public void refresh()

Refreshes all repositories, so they are forced to refresh list of plugins

installPlugin

public boolean installPlugin(String id,
                    String version)
                      throws ro.fortsoft.pf4j.PluginException

Installs a plugin by id and version

Parameters:

id - the id of plugin to install

version - the version of plugin to install, on SemVer format, or null for latest

Returns:

true if installation successful and plugin started

Throws:

ro.fortsoft.pf4j.PluginException - if plugin does not exist in repos or problems during

downloadPlugin

protected java.nio.file.Path downloadPlugin(String id,
                                String version)
                                     throws ro.fortsoft.pf4j.PluginException

Downloads a plugin with given coordinates and returns a path to the file

Parameters:

id - of plugin

version - of plugin or null to download latest

Returns:

Path to file which will reside in a temporary folder in the system default temp area

Throws:

ro.fortsoft.pf4j.PluginException - if download failed

getFileDownloader

protected FileDownloader getFileDownloader(String pluginId)

Finds the FileDownloader to use for this repository

Parameters:

pluginId - the plugin we wish to download

Returns:

FileDownloader instance

findUrlForPlugin

protected URL findUrlForPlugin(String id,
                   String version)
                        throws ro.fortsoft.pf4j.PluginException

Resolves url from id and version

Parameters:

id - of plugin

version - of plugin or null to locate latest version

Returns:

URL for downloading

Throws:

ro.fortsoft.pf4j.PluginException - if id or version does not exist

updatePlugin

public boolean updatePlugin(String id,
                   String version)
                     throws ro.fortsoft.pf4j.PluginException

Updates a plugin id to given version or to latest version if version == null

Parameters:

id - the id of plugin to update

version - the version to update to, on SemVer format, or null for latest

Returns:

true if update successful

Throws:

ro.fortsoft.pf4j.PluginException - in case the given version is not available, plugin id not already installed etc

uninstallPlugin

public boolean uninstallPlugin(String id)

initRepositoriesFromJson

protected void initRepositoriesFromJson()