Skip navigation links
A B C D F G H I L M N O P R S T U V W 

A

addRepository(String, URL) - Method in class org.pf4j.update.UpdateManager
addRepository(UpdateRepository) - Method in class org.pf4j.update.UpdateManager
Add a repo that was created by client.
ALL_DEFAULT_FILE_VERIFIERS - Static variable in class org.pf4j.update.verifier.CompoundVerifier
Default list of verifiers

B

BasicVerifier - Class in org.pf4j.update.verifier
Verifies that the file exists is a regular file and has a non-null size.
BasicVerifier() - Constructor for class org.pf4j.update.verifier.BasicVerifier
 

C

compareTo(PluginInfo) - Method in class org.pf4j.update.PluginInfo
 
CompoundVerifier - Class in org.pf4j.update.verifier
 
CompoundVerifier() - Constructor for class org.pf4j.update.verifier.CompoundVerifier
Default constructor which will add the default verifiers to start with
CompoundVerifier(List<FileVerifier>) - Constructor for class org.pf4j.update.verifier.CompoundVerifier
Constructs a Compound verifier using the supplied list of verifiers instead of the default ones
Context(String, PluginInfo.PluginRelease) - Constructor for class org.pf4j.update.FileVerifier.Context
 
Context(String, Date, String, String, String, String) - Constructor for class org.pf4j.update.FileVerifier.Context
 
copyLocalFile(URL) - Method in class org.pf4j.update.SimpleFileDownloader
Efficient copy of file in case of local file system.

D

date - Variable in class org.pf4j.update.FileVerifier.Context
 
date - Variable in class org.pf4j.update.PluginInfo.PluginRelease
 
DefaultUpdateRepository - Class in org.pf4j.update
The default implementation of UpdateRepository.
DefaultUpdateRepository(String, URL) - Constructor for class org.pf4j.update.DefaultUpdateRepository
Instantiates a new default update repository.
DefaultUpdateRepository(String, URL, String) - Constructor for class org.pf4j.update.DefaultUpdateRepository
 
description - Variable in class org.pf4j.update.PluginInfo
 
downloadFile(URL) - Method in interface org.pf4j.update.FileDownloader
Downloads a file to destination.
downloadFile(URL) - Method in class org.pf4j.update.SimpleFileDownloader
Downloads a file.
downloadFileHttp(URL) - Method in class org.pf4j.update.SimpleFileDownloader
Downloads file from HTTP or FTP.
downloadPlugin(String, String) - Method in class org.pf4j.update.UpdateManager
Downloads a plugin with given coordinates, runs all FileVerifiers and returns a path to the downloaded file.

F

FACTORY - Static variable in class org.pf4j.update.util.LenientDateTypeAdapter
 
FileDownloader - Interface in org.pf4j.update
Interface to download a file.
FileVerifier - Interface in org.pf4j.update
Interface to verify a file.
FileVerifier.Context - Class in org.pf4j.update
Context to be passed to file verifiers
findReleaseForPlugin(String, String) - Method in class org.pf4j.update.UpdateManager
Resolves Release from id and version.

G

getAvailablePlugins() - Method in class org.pf4j.update.UpdateManager
 
getFileDownloader() - Method in class org.pf4j.update.DefaultUpdateRepository
 
getFileDownloader(String) - Method in class org.pf4j.update.UpdateManager
Finds the FileDownloader to use for this repository.
getFileDownloader() - Method in interface org.pf4j.update.UpdateRepository
Each repository has the option of overriding the download process.
getFileVerifier() - Method in class org.pf4j.update.DefaultUpdateRepository
Gets a file verifier to execute on the downloaded file for it to be claimed valid.
getFileVerifier(String) - Method in class org.pf4j.update.UpdateManager
Gets a file verifier to use for this plugin.
getFileVerifier() - Method in interface org.pf4j.update.UpdateRepository
Gets a file verifier to execute on the downloaded file for it to be claimed valid.
getId() - Method in class org.pf4j.update.DefaultUpdateRepository
 
getId() - Method in interface org.pf4j.update.UpdateRepository
 
getLastPluginRelease(String) - Method in class org.pf4j.update.UpdateManager
Returns the last release version of this plugin for given system version, regardless of release date.
getPlugin(String) - Method in class org.pf4j.update.DefaultUpdateRepository
 
getPlugin(String) - Method in interface org.pf4j.update.UpdateRepository
Get a particular plugin information from this repository.
getPlugins() - Method in class org.pf4j.update.DefaultUpdateRepository
 
getPlugins() - Method in class org.pf4j.update.UpdateManager
Get the list of plugins from all repos.
getPlugins() - Method in interface org.pf4j.update.UpdateRepository
Get all plugin information for this repository.
getPluginsJsonFileName() - Method in class org.pf4j.update.DefaultUpdateRepository
Gets the plugins json file name.
getPluginsMap() - Method in class org.pf4j.update.UpdateManager
Get a map of all plugins from all repos where key is plugin id.
getRepositories() - Method in class org.pf4j.update.UpdateManager
 
getRepositoryId() - Method in class org.pf4j.update.PluginInfo
 
getUpdates() - Method in class org.pf4j.update.UpdateManager
Return a list of plugins that are newer versions of already installed plugins.
getUrl() - Method in class org.pf4j.update.DefaultUpdateRepository
 
getUrl() - Method in interface org.pf4j.update.UpdateRepository
 
getVerifiers() - Method in class org.pf4j.update.verifier.CompoundVerifier
 

H

hasAvailablePlugins() - Method in class org.pf4j.update.UpdateManager
 
hasPluginUpdate(String) - Method in class org.pf4j.update.UpdateManager
Finds whether the newer version of the plugin.
hasUpdates() - Method in class org.pf4j.update.UpdateManager
Checks if Update Repositories has newer versions of some of the installed plugins.

I

id - Variable in class org.pf4j.update.FileVerifier.Context
 
id - Variable in class org.pf4j.update.PluginInfo
 
initRepositoriesFromJson() - Method in class org.pf4j.update.UpdateManager
 
installPlugin(String, String) - Method in class org.pf4j.update.UpdateManager
Installs a plugin by id and version.

L

LenientDateTypeAdapter - Class in org.pf4j.update.util
Fork of com.google.gson.internal.bind.DateTypeAdapter
LenientDateTypeAdapter() - Constructor for class org.pf4j.update.util.LenientDateTypeAdapter
 

M

meta - Variable in class org.pf4j.update.FileVerifier.Context
 

N

name - Variable in class org.pf4j.update.PluginInfo
 

O

org.pf4j.update - package org.pf4j.update
This is the pf4j-update sub project which implements a plugin update mechanism for Plugin Framework for Java.
org.pf4j.update.util - package org.pf4j.update.util
 
org.pf4j.update.verifier - package org.pf4j.update.verifier
Implementations of FileVerifier interface.

P

PluginInfo - Class in org.pf4j.update
PluginInfo describing a plugin from a repository.
PluginInfo() - Constructor for class org.pf4j.update.PluginInfo
 
PluginInfo.PluginRelease - Class in org.pf4j.update
A concrete release.
PluginRelease() - Constructor for class org.pf4j.update.PluginInfo.PluginRelease
 
projectUrl - Variable in class org.pf4j.update.PluginInfo
 
provider - Variable in class org.pf4j.update.PluginInfo
 

R

read(JsonReader) - Method in class org.pf4j.update.util.LenientDateTypeAdapter
 
refresh() - Method in class org.pf4j.update.DefaultUpdateRepository
Causes plugins.json to be read again to look for new updates from repositories.
refresh() - Method in class org.pf4j.update.UpdateManager
Refreshes all repositories, so they are forced to refresh list of plugins.
refresh() - Method in interface org.pf4j.update.UpdateRepository
Flushes cached info to force re-fetching repository state on next get.
releases - Variable in class org.pf4j.update.PluginInfo
 
removeRepository(String) - Method in class org.pf4j.update.UpdateManager
Remove a repository by id.
repositories - Variable in class org.pf4j.update.UpdateManager
 
requires - Variable in class org.pf4j.update.FileVerifier.Context
 
requires - Variable in class org.pf4j.update.PluginInfo.PluginRelease
 

S

setPluginsJsonFileName(String) - Method in class org.pf4j.update.DefaultUpdateRepository
Choose another file name than plugins.json.
setRepositories(List<UpdateRepository>) - Method in class org.pf4j.update.UpdateManager
Replace all repositories.
setRepositoryId(String) - Method in class org.pf4j.update.PluginInfo
 
setVerifiers(List<FileVerifier>) - Method in class org.pf4j.update.verifier.CompoundVerifier
 
sha512sum - Variable in class org.pf4j.update.FileVerifier.Context
 
sha512sum - Variable in class org.pf4j.update.PluginInfo.PluginRelease
Optional sha512 digest checksum.
Sha512SumVerifier - Class in org.pf4j.update.verifier
Verifies that the SHA512 checksum of a downloaded file equals the checksum given in the plugins.json descriptor.
Sha512SumVerifier() - Constructor for class org.pf4j.update.verifier.Sha512SumVerifier
 
SimpleFileDownloader - Class in org.pf4j.update
Downloads a file from a URL.
SimpleFileDownloader() - Constructor for class org.pf4j.update.SimpleFileDownloader
 

T

toString() - Method in class org.pf4j.update.PluginInfo.PluginRelease
 
toString() - Method in class org.pf4j.update.PluginInfo
 

U

uninstallPlugin(String) - Method in class org.pf4j.update.UpdateManager
 
UpdateManager - Class in org.pf4j.update
 
UpdateManager(PluginManager) - Constructor for class org.pf4j.update.UpdateManager
 
UpdateManager(PluginManager, Path) - Constructor for class org.pf4j.update.UpdateManager
 
UpdateManager(PluginManager, List<UpdateRepository>) - Constructor for class org.pf4j.update.UpdateManager
 
updatePlugin(String, String) - Method in class org.pf4j.update.UpdateManager
Updates a plugin id to given version or to latest version if version == null.
UpdateRepository - Interface in org.pf4j.update
Contract for update repositories.
url - Variable in class org.pf4j.update.FileVerifier.Context
 
url - Variable in class org.pf4j.update.PluginInfo.PluginRelease
 

V

verify(FileVerifier.Context, Path) - Method in interface org.pf4j.update.FileVerifier
Verifies a plugin release according to certain rules
verify(FileVerifier.Context, Path) - Method in class org.pf4j.update.verifier.BasicVerifier
Verifies a plugin release according to certain rules.
verify(FileVerifier.Context, Path) - Method in class org.pf4j.update.verifier.CompoundVerifier
Verifies a plugin release using all configured FileVerifiers
verify(FileVerifier.Context, Path) - Method in class org.pf4j.update.verifier.Sha512SumVerifier
Verifies a plugin release according to certain rules
VerifyException - Exception in org.pf4j.update
Marker exception for plugin verification failure
VerifyException(String) - Constructor for exception org.pf4j.update.VerifyException
 
VerifyException(Throwable, String, Object...) - Constructor for exception org.pf4j.update.VerifyException
 
VerifyException(String, Object...) - Constructor for exception org.pf4j.update.VerifyException
 
version - Variable in class org.pf4j.update.FileVerifier.Context
 
version - Variable in class org.pf4j.update.PluginInfo.PluginRelease
 

W

write(JsonWriter, Date) - Method in class org.pf4j.update.util.LenientDateTypeAdapter
 
A B C D F G H I L M N O P R S T U V W 
Skip navigation links

Copyright © 2020. All rights reserved.