org.pf4j.update

Interface UpdateRepository

All Known Implementing Classes:

DefaultUpdateRepository

public interface UpdateRepository

Contract for update repositories.

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.
URL	getUrl()
void	refresh() Flushes cached info to force re-fetching repository state on next get.

Method Detail

getId

String getId()

Returns:

the ID of this repository. This must be unique

getUrl

URL getUrl()

Returns:

the URL of this repository as a String

getPlugins

Map<String,PluginInfo> getPlugins()

Get all plugin information for this repository.

Returns:

Map of PluginId and PluginInfo

getPlugin

PluginInfo getPlugin(String id)

Get a particular plugin information from this repository.

Parameters:

id - the id of the plugin

Returns:

the PluginInfo

refresh

void refresh()

Flushes cached info to force re-fetching repository state on next get.

getFileDownloader

FileDownloader getFileDownloader()

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.

Returns:

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

getFileVerifier

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.

Returns:

FileVerifier