org.pf4j.update

Class DefaultUpdateRepository

java.lang.Object

org.pf4j.update.DefaultUpdateRepository

All Implemented Interfaces:

UpdateRepository

public class DefaultUpdateRepository
extends Object
implements UpdateRepository

The default implementation of UpdateRepository.

Author:

Decebal Suiu

Constructor Summary

Constructors

Constructor and Description
DefaultUpdateRepository(String id, URL url) Instantiates a new default update repository.
DefaultUpdateRepository(String id, URL url, String pluginsJsonFileName)

Method Summary

Modifier and Type	Method and Description
FileDownloader	getFileDownloader() Each repository has the option of overriding the download process.
FileVerifier	getFileVerifier() Gets a file verifier to execute on the downloaded file for it to be claimed valid.
String	getId()
PluginInfo	getPlugin(String id) Get a particular plugin information from this repository.
Map<String,PluginInfo>	getPlugins() Get all plugin information for this repository.
String	getPluginsJsonFileName() Gets the plugins json file name.
URL	getUrl()
void	refresh() Causes plugins.json to be read again to look for new updates from repositories.
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)

Instantiates a new default update repository. The default plugins JSON file name plugins.json will be used. Please use DefaultUpdateRepository(String, URL, String) if you want to choose another file name than plugins.json}.

Parameters:

id - the repository id

url - the repository 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 repository. This must be unique

getUrl

public URL getUrl()

Specified by:

getUrl in interface UpdateRepository

Returns:

the URL of this repository as a String

getPlugins

public Map<String,PluginInfo> getPlugins()

Description copied from interface: UpdateRepository

Get all plugin information for this repository.

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 information from this repository.

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 repositories.

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 checksum, 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

getFileVerifier

public FileVerifier getFileVerifier()

Gets a file verifier to execute on the downloaded file for it to be claimed valid. May be a CompoundVerifier in order to chain several verifiers.

Specified by:

getFileVerifier in interface UpdateRepository

Returns:

list of FileVerifiers

getPluginsJsonFileName

public String getPluginsJsonFileName()

Gets the plugins json file name. Returns plugins.json if null.

Returns:

the plugins json file name

setPluginsJsonFileName

public void setPluginsJsonFileName(String pluginsJsonFileName)

Choose another file name than plugins.json.

Parameters:

pluginsJsonFileName - the name (relative) of plugins.json file. If null, will default to plugins.json