ro.fortsoft.pf4j.update

Class DefaultUpdateRepository

java.lang.Object

ro.fortsoft.pf4j.update.DefaultUpdateRepository

All Implemented Interfaces:

UpdateRepository

public class DefaultUpdateRepository
extends Object
implements UpdateRepository

Author:

Decebal Suiu

Constructor Summary

Constructors

Constructor and Description
DefaultUpdateRepository(String id, URL url)
DefaultUpdateRepository(String id, URL url, String pluginsJsonFileName)

Method Summary

Methods

Modifier and Type	Method and Description
FileDownloader	getFileDownloader() Each repository has the option of overriding the download process.
String	getId()
PluginInfo	getPlugin(String id) Get a particular plugin from this repo
Map<String,PluginInfo>	getPlugins() Get all plugin descriptors for this repo
String	getPluginsJsonFileName()
URL	getUrl()
void	refresh() Causes plugins.json to be read again to look for new updates from repos
void	setPluginsJsonFileName(String pluginsJsonFileName) Choose another file name than plugins.json

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUpdateRepository

public DefaultUpdateRepository(String id,
                       URL url)

DefaultUpdateRepository

public DefaultUpdateRepository(String id,
                       URL url,
                       String pluginsJsonFileName)

Method Detail

getId

public String getId()

Specified by:

getId in interface UpdateRepository

Returns:

the ID of this repo. This must be unique

getUrl

public URL getUrl()

Specified by:

getUrl in interface UpdateRepository

Returns:

the URL of this repo as a String

getPlugins

public Map<String,PluginInfo> getPlugins()

Description copied from interface: UpdateRepository

Get all plugin descriptors for this repo

Specified by:

getPlugins in interface UpdateRepository

Returns:

Map of PluginId and PluginInfo

getPlugin

public PluginInfo getPlugin(String id)

Description copied from interface: UpdateRepository

Get a particular plugin from this repo

Specified by:

getPlugin in interface UpdateRepository

Parameters:

id - the id of the plugin

Returns:

the PluginInfo

refresh

public void refresh()

Causes plugins.json to be read again to look for new updates from repos

Specified by:

refresh in interface UpdateRepository

getFileDownloader

public FileDownloader getFileDownloader()

Description copied from interface: UpdateRepository

Each repository has the option of overriding the download process. They can e.g. do checksumming, signature verifications etc. To use the default downloader, return null

Specified by:

getFileDownloader in interface UpdateRepository

Returns:

the FileDownloader to use for this repository or null if you do not wish to override

getPluginsJsonFileName

public String getPluginsJsonFileName()

setPluginsJsonFileName

public void setPluginsJsonFileName(String pluginsJsonFileName)

Choose another file name than plugins.json

Parameters:

pluginsJsonFileName - the name (relative) of plugins.json file