Index
All Classes|All Packages|Constant Field Values|Deprecated API|Serialized Form
A
- addExports - Variable in class FileMapper
- addOpens - Variable in class FileMapper
- AddPackage - Class in org.update4j
-
This class is a simple POJO that represents "Add Exports" and "Add Opens" in the configuration file.
- AddPackage(String, String) - Constructor for class AddPackage
-
Constructs a new
AddPackage
with the given source package name to be added to the given target module. - addReads - Variable in class FileMapper
- archive(Path) - Static method in class UpdateOptions
- Archive - Class in org.update4j
- ARGUMENT_PROPERTY_KEY_PREFIX - Static variable in class DefaultLauncher
B
- basePath - Variable in class ConfigMapper
- basePath(String) - Method in class Configuration.Builder
-
Set the base path that files with a relative
path
should resolve against. - basePath(Path) - Method in class Configuration.Builder
-
Set the base path that files with a relative
path
should resolve against. - baseUri - Variable in class ConfigMapper
- baseUri(String) - Method in class Configuration.Builder
-
Set the base URI that files with a relative
uri
should resolve against. - baseUri(URI) - Method in class Configuration.Builder
-
Set the base URI that files with a relative
uri
should resolve against. - Bootstrap - Class in org.update4j
-
This class consists of convenience methods and the module's main method to locate and start the bootstrap application in Delegate Mode.
- build() - Method in class Configuration.Builder
-
Collects all information passed to the builder, replaces matches with placeholder according to the
Configuration.Builder.getMatchType()
policy and validates all values. - builder() - Static method in class Configuration
-
The entry point to the Builder API.
C
- checksum - Variable in class FileMapper
- classpath - Variable in class FileMapper
- classpath() - Method in class FileMetadata.Reference
- classpath(boolean) - Method in class FileMetadata.Reference
- comment - Variable in class FileMapper
- comment(String) - Method in class FileMetadata.Reference
- ConfigMapper - Class in org.update4j.mapper
- ConfigMapper() - Constructor for class ConfigMapper
- ConfigMapper(ConfigMapper) - Constructor for class ConfigMapper
- ConfigMapper(Node) - Constructor for class ConfigMapper
- Configuration - Class in org.update4j
-
This class is the heart of the framework.
- Configuration.Builder - Class in org.update4j
-
This class is used to generate new configurations when a new draft is released.
- consoleWidth() - Method in class DefaultUpdateHandler
- containsUpdate(Path) - Static method in class Update
-
Deprecated.Returns whether the given directory has an update ready for finalization.
- CURRENT - Static variable in enum class OS
D
- DefaultBootstrap - Class in org.update4j.service
- DefaultBootstrap() - Constructor for class DefaultBootstrap
- DefaultLauncher - Class in org.update4j.service
- DefaultLauncher() - Constructor for class DefaultLauncher
- DefaultLauncher(List<String>) - Constructor for class DefaultLauncher
- DefaultUpdateHandler - Class in org.update4j.service
- DefaultUpdateHandler() - Constructor for class DefaultUpdateHandler
- Delegate - Interface in org.update4j.service
-
An implementation of this interface can be used as a delegate for a bootstrap application to be located by
Bootstrap
. - deleteOldFiles(Configuration) - Method in class Configuration
-
Convenience method to delete files only present in
oldConfig
and clean up app directory. - deleteOldFiles(Configuration, boolean, int) - Method in class Configuration
-
Convenience method to delete files only present in
oldConfig
and clean up app directory. - DOMAIN_PREFIX - Static variable in class DefaultLauncher
- doneCheckUpdateFile(FileMetadata, boolean) - Method in interface UpdateHandler
-
Checking if this file requires an update is complete, and
UpdateContext.getRequiresUpdate()
was updated to include this file. - doneCheckUpdates() - Method in interface UpdateHandler
-
All files were passed for an update check (or not, if
shouldCheckForUpdate(FileMetadata)
returnedfalse
) and theUpdateContext.getRequiresUpdate()
is up-to-date. - doneDownloadFile(FileMetadata, Path) - Method in class DefaultUpdateHandler
- doneDownloadFile(FileMetadata, Path) - Method in interface UpdateHandler
-
The file was successfully downloaded to
path
andUpdateContext.getUpdated()
was already updated to reflect this. - doneDownloads() - Method in interface UpdateHandler
-
If the update was a regular — non-temp — update: All downloads completed and all temporary files were moved to its final location.
- DynamicClassLoader - Class in org.update4j
- DynamicClassLoader() - Constructor for class DynamicClassLoader
- DynamicClassLoader(ClassLoader) - Constructor for class DynamicClassLoader
- DynamicClassLoader(String, ClassLoader) - Constructor for class DynamicClassLoader
- dynamicProperties(Map<String, String>) - Method in class Configuration.Builder
-
Register a map of dynamic properties to the builder.
- dynamicProperty(String, String) - Method in class Configuration.Builder
-
Register a dynamic property to the builder.
E
- equals(Object) - Method in class Configuration
-
Returns whether the given configuration is equals to this.
- equals(Object) - Method in class Property
- escape(String) - Static method in class XmlMapper
- EVERY_OCCURRENCE - Enum constant in enum class PlaceholderMatchType
-
Will break words with placeholders if it finds a match.
- execute() - Static method in class SingleInstanceManager
-
A call to this method will ensure that everything after that call will not be run by more than one instance of this application.
- execute(Path) - Static method in class SingleInstanceManager
-
A call to this method will ensure that everything after that call will not be run by more than one instance of this application.
- execute(List<String>, Consumer<? super List<String>>) - Static method in class SingleInstanceManager
-
A call to this method will ensure that everything after that call will not be run by more than one instance of this application.
- execute(List<String>, Consumer<? super List<String>>, Path) - Static method in class SingleInstanceManager
-
A call to this method will ensure that everything after that call will not be run by more than one instance of this application.
- exports(String, String) - Method in class FileMetadata.Reference
- exports(Collection<AddPackage>) - Method in class FileMetadata.Reference
F
- failed(Throwable) - Method in class DefaultUpdateHandler
- failed(Throwable) - Method in interface UpdateHandler
-
Called when the update process failed.
- file(FileMetadata.Reference) - Method in class Configuration.Builder
-
List a single file in the configuration.
- FileMapper - Class in org.update4j.mapper
- FileMapper() - Constructor for class FileMapper
- FileMapper(FileMapper) - Constructor for class FileMapper
- FileMapper(Node) - Constructor for class FileMapper
- FileMetadata - Class in org.update4j
-
This class represents a managed file (—in sense of updating and dynamically loading onto a JVM instance upon launch) in this framework.
- FileMetadata.Reference - Class in org.update4j
-
A reference to a file can be used by the Builder API to read its metadata.
- files - Variable in class ConfigMapper
- files(Collection<FileMetadata.Reference>) - Method in class Configuration.Builder
-
List a collection of files in the configuration.
- files(Stream<FileMetadata.Reference>) - Method in class Configuration.Builder
-
List a stream of
FileMetadata
instances in the configuration. - finalizeUpdate(Path) - Static method in class Update
-
Deprecated.Finalizes an update that resides in the provided directory.
- findAncestor(ClassLoader) - Static method in class DynamicClassLoader
- fromShortName(String) - Static method in enum class OS
- FULL_MATCH - Enum constant in enum class PlaceholderMatchType
-
Will only replace if the complete string matches with one placeholder.
G
- generateXmlMapper() - Method in class Configuration
-
Generates a new XML mapper for direct XML manipulation with values populated identical to this configuration.
- getAddExports() - Method in class FileMetadata
-
Returns an unmodifiable list of packages that should be exported to a module despite not being defined so in the
module-info.class
file. - getAddExports() - Method in class FileMetadata.Reference
- getAddOpens() - Method in class FileMetadata
-
Returns an unmodifiable list of packages that should be opened to a module despite not being defined so in the
module-info.class
file. - getAddOpens() - Method in class FileMetadata.Reference
- getAddReads() - Method in class FileMetadata
-
Returns an unmodifiable list modules this module should read despite not being defined so in the
module-info.class
file. - getAddReads() - Method in class FileMetadata.Reference
- getArchiveLocation() - Method in class UpdateContext
-
Returns the
Path
passed intoUpdateOptions.archive(Path)
. - getArchiveLocation() - Method in class UpdateOptions.ArchiveUpdateOptions
- getArchivePath() - Method in class DefaultBootstrap
- getAttributeValue(Node, String) - Static method in class XmlMapper
- getBasePath() - Method in class Configuration.Builder
-
Returns the value passed in
Configuration.Builder.basePath(String)
. - getBasePath() - Method in class Configuration
-
Returns the base path against whom all relative paths in individual files are resolved.
- getBaseUri() - Method in class Configuration.Builder
-
Returns the value passed in
Configuration.Builder.baseUri(String)
. - getBaseUri() - Method in class Configuration
-
Returns the base URI against whom all relative URIs in individual files are resolved.
- getBusinessArgs() - Method in class DefaultBootstrap
- getCert() - Method in class DefaultBootstrap
- getChecksum() - Method in class FileMetadata
-
Returns the Adler32 checksum of this file.
- getChecksum() - Method in class FileMetadata.Reference
- getChecksum(Path) - Static method in class FileMapper
- getChecksumHex(Path) - Static method in class FileMapper
- getClassLoader() - Method in class LaunchContext
-
Returns the class loader that classes in the dynamic classpath or modulepath are loaded with.
- getComment() - Method in class FileMetadata
-
Returns a string from the
comment
attribute, ornull
if missing. - getComment() - Method in class FileMetadata.Reference
- getConfiguration() - Method in class Archive
- getConfiguration() - Method in class LaunchContext
-
Returns the configuration used for this launch.
- getConfiguration() - Method in class UpdateContext
-
Returns the configuration used for this update.
- getDynamicProperties() - Method in class Configuration.Builder
-
Returns the map that collects the dynamic properties.
- getDynamicProperties() - Method in class Configuration
-
Returns the dynamic properties passed in
Configuration.read(Reader, Map)
. - getException() - Method in class UpdateResult
- getFiles() - Method in class Archive
- getFiles() - Method in class Configuration.Builder
-
Returns all files listed via
file()
orfiles()
. - getFiles() - Method in class Configuration
-
Returns the list of files listed in the configuration file.
- getInjectable() - Method in class UpdateOptions
- getKey() - Method in class Property
-
Returns the property key, never
null
. - getLauncher() - Method in class Configuration.Builder
-
Returns the class name passed in
Configuration.Builder.updateHandler(String)
. - getLauncher() - Method in class Configuration
-
Returns the
Launcher
class name that should be used instead of of the default highest version currently present in the classpath or modulepath. - getLocal() - Method in class DefaultBootstrap
- getLocalConfig(boolean) - Method in class DefaultBootstrap
- getLocation() - Method in class Archive
- getMatchType() - Method in class Configuration.Builder
-
Returns the policy passed in
Configuration.Builder.matchAndReplace(PlaceholderMatchType)
. - getMatchType() - Method in class FileMetadata.Reference
- getModuleLayer() - Method in class LaunchContext
-
Returns the
ModuleLayer
where modules in the config that were marked withmodulepath
are dynamically loaded. - getOldFiles(Configuration, boolean) - Method in class Configuration
-
Returns a list of files of old files present in
oldConfig
but not in the current. - getOs() - Method in class FileMetadata
-
Returns the operating system expressed in the
os
attribute, ornull
if non. - getOs() - Method in class FileMetadata.Reference
-
Returns the os passed in
FileMetadata.Reference.os(OS)
ornull
if non. - getOs() - Method in class Property
-
Returns the property operating system.
- getPackageName() - Method in class AddPackage
-
Returns the package name that is being added.
- getPath() - Method in class FileMetadata
-
Returns the local path for this file.
- getProperties() - Method in class Configuration.Builder
-
Returns all properties listed via
property()
orproperties()
. - getProperties() - Method in class Configuration
-
Returns an unmodifiable list of properties listed in the configuration file.
- getProperties(String) - Method in class Configuration
-
Returns a list of properties listed in the configuration file that have the provided key.
- getPublicKey() - Method in class DefaultBootstrap
- getPublicKey() - Method in class UpdateContext
-
Returns the public key used to validate the update if
Configuration.update(PublicKey)
or any other overload was used, ornull
otherwise. - getPublicKey() - Method in class UpdateOptions
- getRemote() - Method in class DefaultBootstrap
- getRemoteConfig() - Method in class DefaultBootstrap
- getRequiresUpdate() - Method in class UpdateContext
-
Returns an unmodifiable list of files that requires an update.
- getResolvedProperties() - Method in class Configuration
-
Returns an unmodifiable map of keys and values after resolving the placeholders.
- getResolvedProperty(String) - Method in class Configuration
-
Returns the real value of the property with the given key, after resolving the placeholders.
- getResult() - Method in class DefaultUpdateHandler
- getResult() - Method in interface UpdateHandler
-
Called by
UpdateResult.result()
. - getShortName() - Method in enum class OS
- getSignature() - Method in class Configuration
-
Returns the signature for this configuration.
- getSignature() - Method in class FileMetadata
-
Returns the Base64 encoded file signature.
- getSignature(Path, PrivateKey) - Static method in class FileMapper
- getSignature(PrivateKey) - Method in class FileMetadata.Reference
- getSignatureEncoded(Path, PrivateKey) - Static method in class FileMapper
- getSigner() - Method in class Configuration.Builder
-
Returns the value passed in
Configuration.Builder.signer(PrivateKey)
. - getSize() - Method in class FileMetadata
-
Returns the file size.
- getSize() - Method in class FileMetadata.Reference
- getSource() - Method in class FileMetadata.Reference
-
Returns the real file location that this instance refers to.
- getSystemPropertiesToResolve() - Method in class Configuration.Builder
-
Returns the listed system property keys to hint the builder to look for a string that could be matched with the system property's value.
- getTargetField() - Method in exception UnsatisfiedInjectionException
- getTargetModule() - Method in class AddPackage
-
Returns the target module name that the package is added to.
- getTempDirectory() - Method in class UpdateContext
-
Deprecated.Use archive-based updates instead
- getTimestamp() - Method in class Configuration
-
Returns the timestamp this configuration was last updated using the
Configuration.Builder
API orsync()
. - getUpdated() - Method in class UpdateContext
-
Returns an unmodifiable list of files that were successfully downloaded.
- getUpdateHandler() - Method in class Configuration.Builder
-
Returns the class name passed in
Configuration.Builder.updateHandler(String)
. - getUpdateHandler() - Method in class Configuration
-
Returns the
UpdateHandler
class name that should be used instead of of the default highest version currently present in the classpath or modulepath. - getUpdateHandler() - Method in class UpdateOptions
- getUri() - Method in class FileMetadata
-
Returns the download URI for this file.
- getUri() - Method in class FileMetadata.Reference
-
Returns the URI passed in
FileMetadata.Reference.uri(String)
ornull
if non. - getValue() - Method in class Property
-
Returns the property value, never
null
.
H
- hashCode() - Method in class Property
I
- ignoreBootConflict - Variable in class FileMapper
- ignoreBootConflict() - Method in class FileMetadata.Reference
- ignoreBootConflict(boolean) - Method in class FileMetadata.Reference
- implyPlaceholders(String) - Method in class Configuration
-
Returns a string with real values replaced with placeholders.
- implyPlaceholders(String, boolean) - Method in class Configuration
-
Returns a string with real values replaced with placeholders.
- implyPlaceholders(String, PlaceholderMatchType) - Method in class Configuration
-
Returns a string with real values replaced with placeholders.
- implyPlaceholders(String, PlaceholderMatchType, boolean) - Method in class Configuration
-
Returns a string with real values replaced with placeholders.
- init(UpdateContext) - Method in class DefaultUpdateHandler
- init(UpdateContext) - Method in interface UpdateHandler
-
Called after injection (see
Configuration.update(Injectable)
) but before anything update related has started. - initProgress() - Method in class DefaultUpdateHandler
- injectable(Injectable) - Method in class UpdateOptions
- Injectable - Interface in org.update4j.inject
-
A class implementing this type can be scanned to send and receive fields to and from another injectable.
- injectBidirectional(Injectable, Injectable) - Static method in interface Injectable
- InjectSource - Annotation Interface in org.update4j.inject
-
A field marked with this annotation will be used as an injection source for an injectable's fields that contain the
InjectTarget
annotation. - InjectTarget - Annotation Interface in org.update4j.inject
-
A field in an
Injectable
with this annotation will receive instances of fields annotated withInjectSource
whenInjectable.injectUnidirectional(Injectable, Injectable)
orInjectable.injectBidirectional(Injectable, Injectable)
were invoked, if it successfully matches. - injectUnidirectional(Injectable, Injectable) - Static method in interface Injectable
- install() - Method in class Archive
- install(boolean) - Method in class Archive
- isClasspath() - Method in class FileMetadata
-
Returns if this file is marked to be loaded on the dynamic classpath.
- isClasspath() - Method in class FileMetadata.Reference
- isIgnoreBootConflict() - Method in class FileMetadata
-
Returns whether this file was marked to ignore a boot conflict check.
- isIgnoreBootConflict() - Method in class FileMetadata.Reference
- isLaunchFirst() - Method in class DefaultBootstrap
- isModulepath() - Method in class FileMetadata
-
Returns if this file is marked to be loaded on the dynamic modulepath.
- isModulepath() - Method in class FileMetadata.Reference
- isSingleInstance() - Method in class DefaultBootstrap
- isStopOnUpdateError() - Method in class DefaultBootstrap
- isSyncLocal() - Method in class DefaultBootstrap
L
- launch() - Method in class Configuration
-
Launches the business application by loading all files marked with the
classpath
ormodulepath
attributes, on their respective paths, dynamically. - launch(Injectable) - Method in class Configuration
-
Launches the business application by loading all files marked with the
classpath
ormodulepath
attributes, on their respective paths, dynamically. - launch(Launcher) - Method in class Configuration
-
Launches the business application by loading all files marked with the
classpath
ormodulepath
attributes, on their respective paths, dynamically. - LaunchContext - Class in org.update4j
-
A class that contain details of the launch.
- launcher - Variable in class ConfigMapper
- launcher(Class<? extends Launcher>) - Method in class Configuration.Builder
-
List the given class as the launcher when
Configuration.launch()
is called over this config. - launcher(String) - Method in class Configuration.Builder
-
List the given class as the launcher when
Configuration.launch()
is called over this config. - Launcher - Interface in org.update4j.service
-
An implementation of this interface can be used as an entry point to the business application.
- launchFirst() - Method in class DefaultBootstrap
- LINUX - Enum constant in enum class OS
- loadService(Class<T>) - Static method in interface Service
- loadService(Class<T>, String) - Static method in interface Service
- loadService(ClassLoader, Class<T>) - Static method in interface Service
- loadService(ClassLoader, Class<T>, String) - Static method in interface Service
- loadService(ModuleLayer, Class<T>) - Static method in interface Service
- loadService(ModuleLayer, Class<T>, String) - Static method in interface Service
- loadService(ModuleLayer, ClassLoader, Class<T>) - Static method in interface Service
- loadService(ModuleLayer, ClassLoader, Class<T>, String) - Static method in interface Service
M
- MAC - Enum constant in enum class OS
- main(String[]) - Static method in class Bootstrap
-
The main method to start the bootstrap application in Delegate Mode from command-line.
- main(List<String>) - Method in class DefaultBootstrap
- main(List<String>) - Method in interface Delegate
-
The bootstrap's main method, if you start it via the
Bootstrap
class or run update4j as a jar file. - MAIN_CLASS_PROPERTY_KEY - Static variable in class DefaultLauncher
- MapMapper - Class in org.update4j.mapper
- matchAndReplace(PlaceholderMatchType) - Method in class Configuration.Builder
-
Attempt to replace strings with listed or system property placeholders according to the given policy.
- matchAndReplace(PlaceholderMatchType) - Method in class FileMetadata.Reference
- modulepath - Variable in class FileMapper
- modulepath() - Method in class FileMetadata.Reference
- modulepath(boolean) - Method in class FileMetadata.Reference
N
- NONE - Enum constant in enum class PlaceholderMatchType
-
Won't change the string.
O
- openConnection() - Method in class Archive
- openConnection(URL) - Method in class DefaultBootstrap
- openDownloadStream(FileMetadata) - Method in interface UpdateHandler
-
Do any logic to obtain an
InputStream
for this file. - opens(String, String) - Method in class FileMetadata.Reference
- opens(Collection<AddPackage>) - Method in class FileMetadata.Reference
- org.update4j - module org.update4j
- org.update4j - package org.update4j
- org.update4j.inject - package org.update4j.inject
- org.update4j.mapper - package org.update4j.mapper
- org.update4j.service - package org.update4j.service
- os - Variable in class FileMapper
- os(OS) - Method in class FileMetadata.Reference
-
Sets the os of this file to exclude it from other operating systems when updating and launching.
- OS - Enum Class in org.update4j
- osFromFilename() - Method in class FileMetadata.Reference
-
Sets the os by parsing the filename.
- OTHER - Enum constant in enum class OS
- out() - Method in class DefaultUpdateHandler
P
- parse(ConfigMapper) - Static method in class Configuration
-
Parses a configuration from the given XML mapper.
- parse(ConfigMapper, Map<String, String>) - Static method in class Configuration
-
Parses a configuration from the given XML mapper, and add the provided properties.
- parse(Node) - Method in class ConfigMapper
- parse(Node) - Method in class FileMapper
- parse(Node) - Method in class MapMapper
- parse(Node) - Method in class XmlMapper
- parseArgs(List<String>) - Method in class DefaultBootstrap
- path - Variable in class FileMapper
- path(String) - Method in class FileMetadata.Reference
-
Sets the local path for this file.
- path(Path) - Method in class FileMetadata.Reference
-
Sets the local path for this file.
- PlaceholderMatchType - Enum Class in org.update4j
-
The policy that should be used when
Configuration.implyPlaceholders(String, PlaceholderMatchType)
is called. - PostInject - Annotation Interface in org.update4j.inject
-
A method with this annotation will be called once injection completes.
- properties - Variable in class ConfigMapper
- properties(Collection<Property>) - Method in class Configuration.Builder
-
List a collection of properties in the configuration.
- property(String, String) - Method in class Configuration.Builder
-
List a single property with the given key and value.
- property(String, String, OS) - Method in class Configuration.Builder
-
List a single property with the given key and value that should only resolve for the given operating system.
- property(Property) - Method in class Configuration.Builder
-
Lists a single
Property
in the configuration. - Property - Class in org.update4j
-
This class is a simple POJO that represents a property in the configuration file.
- Property(String, String) - Constructor for class Property
-
Constructs a new property with the provided key and value.
- Property(String, String, OS) - Constructor for class Property
-
Constructs a new property with the provided key, value, and operating system values.
- publicKey(PublicKey) - Method in class UpdateOptions
R
- read(Reader) - Static method in class Configuration
-
Reads and parses a configuration XML.
- read(Reader) - Static method in class ConfigMapper
- read(Reader) - Static method in class MapMapper
- read(Reader, String) - Static method in class MapMapper
- read(Reader, PublicKey) - Static method in class Configuration
-
Reads and parses a configuration XML, then verifies the configuration signature against the public key.
- read(Reader, PublicKey, Map<String, String>) - Static method in class Configuration
-
Reads and parses a configuration XML and add more properties, then verifies the configuration signature against the public key.
- read(Reader, Map<String, String>) - Static method in class Configuration
-
Reads and parses a configuration XML, and add the provided properties.
- read(String) - Static method in class Archive
- read(Path) - Static method in class Archive
- readFrom(String) - Static method in class FileMetadata
-
Construct a
FileMetadata.Reference
of the file at the provided location and can be used in the Builder API. - readFrom(Path) - Static method in class FileMetadata
-
Construct a
FileMetadata.Reference
of the file at the provided location and can be used in the Builder API. - reads(String) - Method in class FileMetadata.Reference
- reads(Collection<String>) - Method in class FileMetadata.Reference
- renderFilename(FileMetadata) - Method in class DefaultUpdateHandler
- renderProgress() - Method in class DefaultUpdateHandler
- required() - Element in annotation interface InjectTarget
-
Set whether it should fail if the field has no match.
- requiresUpdate() - Method in class Configuration
-
Checks the metadata of every file and returns
true
if at-least one file requires an update, andfalse
if no file requires an update. - requiresUpdate() - Method in class FileMetadata
-
Checks if this file is out of date and requires an update.
- resetProgress(long) - Method in class DefaultUpdateHandler
- resolvePlaceholders(String) - Method in class Configuration
-
Returns a string where all placeholders are replaced with the real values.
- resolveSystemProperties(Collection<String>) - Method in class Configuration.Builder
-
Hint the builder to replace the value of the given system properties if a proper match is found.
- resolveSystemProperty(String) - Method in class Configuration.Builder
-
Hint the builder to replace the value of the given system property if a proper match is found.
- result() - Method in class UpdateResult
- run(LaunchContext) - Method in class DefaultLauncher
- run(LaunchContext) - Method in interface Launcher
-
Called when the business application should be launched, after injection was performed (see
Configuration.launch(Injectable)
) .
S
- Service - Interface in org.update4j.service
- shouldCheckForUpdate(FileMetadata) - Method in interface UpdateHandler
-
Do your own logic here to decide whether a particular file should be updated.
- sign(PrivateKey) - Method in class ConfigMapper
- signature - Variable in class ConfigMapper
- signature - Variable in class FileMapper
- signer(char[], String, char[]) - Method in class Configuration.Builder
-
Convenience method to load the private key from the Java Keystore at the default keystore location (
${user.home}/.keystore
) with the given keypair alias, using the keystore and alias passwords. - signer(String, char[], String, char[]) - Method in class Configuration.Builder
-
Convenience method to load the private key from a Java Keystore at the given path string with the given keypair alias, using the keystore and alias passwords.
- signer(Path, char[], String, char[]) - Method in class Configuration.Builder
-
Convenience method to load the private key from a Java Keystore at the given path with the given keypair alias, using the keystore and alias passwords.
- signer(PrivateKey) - Method in class Configuration.Builder
-
Set the private key to use for configuration and file signing.
- SingleInstanceException - Exception in org.update4j
-
This exception is thrown when calling
SingleInstanceManager.tryExecute()
or its overloads when there's already a running instance on the system sharing the same lock file directory. - SingleInstanceException() - Constructor for exception SingleInstanceException
- SingleInstanceManager - Class in org.update4j
-
A convenience class to force only a single instance of the code proceeding
SingleInstanceManager.execute()
until JVM shutdown. - size - Variable in class FileMapper
- start() - Static method in class Bootstrap
-
Starts the bootstrap by locating the highest versioned provider of
Delegate
(specified byService.version()
) currently present in the classpath or modulepath. - start(String) - Static method in class Bootstrap
-
Starts the bootstrap by locating the given class.
- start(String, List<String>) - Static method in class Bootstrap
-
Starts the bootstrap by locating the given class, with the given list as command-line arguments.
- start(String, List<String>, Injectable) - Static method in class Bootstrap
-
Starts the bootstrap by locating the given class, with the given list as command-line arguments, with the provided injectable to exchange fields.
- start(String, Injectable) - Static method in class Bootstrap
-
Starts the bootstrap by locating the given class, with the provided injectable to exchange fields.
- start(List<String>) - Static method in class Bootstrap
-
Starts the bootstrap by locating the highest versioned provider of
Delegate
(specified byService.version()
) currently present in the classpath or modulepath, with the given list as command-line arguments. - start(List<String>, Injectable) - Static method in class Bootstrap
-
Starts the bootstrap by locating the highest versioned provider of
Delegate
(specified byService.version()
) currently present in the classpath or modulepath, with the given list as command-line arguments, with the provided injectable to exchange fields. - start(Injectable) - Static method in class Bootstrap
-
Starts the bootstrap by locating the highest versioned provider of
Delegate
(specified byService.version()
) currently present in the classpath or modulepath, with the provided injectable to exchange fields. - start(Delegate) - Static method in class Bootstrap
-
Starts the bootstrap running the given
Delegate
. - start(Delegate, List<String>) - Static method in class Bootstrap
-
Starts the bootstrap running the given
Delegate
, with the given list as command-line arguments. - startCheckUpdateFile(FileMetadata) - Method in interface UpdateHandler
-
Called before this individual file is checked if it is outdated.
- startCheckUpdates() - Method in interface UpdateHandler
-
Called after
init(UpdateContext)
, just before starting to check for updates. - startDownloadFile(FileMetadata) - Method in class DefaultUpdateHandler
- startDownloadFile(FileMetadata) - Method in interface UpdateHandler
-
Called once for every file that requires an update, just before the connection is established.
- startDownloads() - Method in class DefaultUpdateHandler
- startDownloads() - Method in interface UpdateHandler
-
If there are any files that need an update, this method will get called once.
- stop() - Method in class DefaultUpdateHandler
- stop() - Method in interface UpdateHandler
-
Called just before the
Configuration.update()
method returns, regardless of the error state (unless an exception was thrown infailed(Throwable)
orsucceeded()
). - streamDirectory(String) - Static method in class FileMetadata
-
Construct a stream of file
FileMetadata.Reference
s from the provided directory. - streamDirectory(Path) - Static method in class FileMetadata
-
Construct a stream of file
FileMetadata.Reference
s from the provided directory. - succeeded() - Method in interface UpdateHandler
-
Called when the update process is complete, even if no files actually required an update.
- sync() - Method in class Configuration
-
Returns a new
Configuration
where all file sizes and checksums are synced with the real locations as listed in the current config. - sync(Path) - Method in class Configuration
-
Returns a new
Configuration
where all file sizes and checksums are synced with the real locations as listed in the current config with the base path overriden to the givenPath
. - sync(Path, PrivateKey) - Method in class Configuration
-
Returns a new
Configuration
where all file sizes, checksums and signatures are synced with the real locations as listed in the current config with the base path overriden to the givenPath
. - sync(PrivateKey) - Method in class Configuration
-
Returns a new
Configuration
where all file sizes, checksums and signatures are synced with the real locations as listed in the current config. - syncLocal(Configuration) - Method in class DefaultBootstrap
- SYSTEM_PROPERTY_KEY_PREFIX - Static variable in class DefaultLauncher
T
- target() - Element in annotation interface InjectSource
-
The target field name.
- timestamp - Variable in class ConfigMapper
- toString() - Method in class Configuration
-
Returns an XML string exactly as
Configuration.write(Writer)
would output. - toXml() - Method in class ConfigMapper
- toXml() - Method in class FileMapper
- toXml() - Method in class MapMapper
- toXml() - Method in class XmlMapper
- tryExecute() - Static method in class SingleInstanceManager
-
A call to this method will try to create a single instance barrier.
- tryExecute(Path) - Static method in class SingleInstanceManager
-
A call to this method will try to create a single instance barrier.
- tryExecute(List<String>, Consumer<? super List<String>>) - Static method in class SingleInstanceManager
-
A call to this method will try to create a single instance barrier.
- tryExecute(List<String>, Consumer<? super List<String>>, Path) - Static method in class SingleInstanceManager
-
A call to this method will try to create a single instance barrier.
U
- UnsatisfiedInjectionException - Exception in org.update4j.inject
-
A checked exception that is thrown if an inject target is required (by not setting
@InjectTarget(required = false)
) and a corresponding inject source was not found. - UnsatisfiedInjectionException(Field) - Constructor for exception UnsatisfiedInjectionException
- update() - Method in class Configuration
-
Deprecated.Superseded with the new archive-based update mechanism.
- update(PublicKey) - Method in class Configuration
-
Deprecated.Superseded with the new archive-based update mechanism.
- update(PublicKey, Injectable) - Method in class Configuration
-
Deprecated.Superseded with the new archive-based update mechanism.
- update(PublicKey, UpdateHandler) - Method in class Configuration
-
Deprecated.Superseded with the new archive-based update mechanism.
- update(Injectable) - Method in class Configuration
-
Deprecated.Superseded with the new archive-based update mechanism.
- update(UpdateHandler) - Method in class Configuration
-
Deprecated.Superseded with the new archive-based update mechanism.
- update(UpdateOptions.ArchiveUpdateOptions) - Method in class Configuration
-
Archive-based update: All files are saved in a zipped file passed to
UpdateOptions.archive(Path)
. - Update - Class in org.update4j
-
Deprecated.Superseded with the new archive-based update mechanism.
- Update() - Constructor for class Update
-
Deprecated.
- UPDATE_DATA - Static variable in class Update
-
Deprecated.
- updateCheckUpdatesProgress(float) - Method in interface UpdateHandler
-
Updates the 'check update' task progress.
- UpdateContext - Class in org.update4j
-
A class that contain details of the update.
- updateDownloadFileProgress(FileMetadata, float) - Method in class DefaultUpdateHandler
- updateDownloadFileProgress(FileMetadata, float) - Method in interface UpdateHandler
-
Called repeatedly, updating the
frac
value to reflect the state of the download of this individual file. - updateDownloadProgress(float) - Method in interface UpdateHandler
-
Called repeatedly, updating the
frac
value to reflect the overall state of the download of all files. - updateFirst() - Method in class DefaultBootstrap
- updateHandler - Variable in class ConfigMapper
- updateHandler(Class<? extends UpdateHandler>) - Method in class Configuration.Builder
-
List the given class as the update handler when
Configuration.update()
is called over this config. - updateHandler(String) - Method in class Configuration.Builder
-
List the given class as the update handler when
Configuration.update()
is called over this config. - updateHandler(UpdateHandler) - Method in class UpdateOptions
- UpdateHandler - Interface in org.update4j.service
-
An implementation of this interface can be used to get callbacks on all stages of the update process.
- UpdateOptions<T extends UpdateOptions<T>> - Class in org.update4j
- UpdateOptions.ArchiveUpdateOptions - Class in org.update4j
- UpdateResult - Class in org.update4j
- updateTemp(Path) - Method in class Configuration
-
Deprecated.Superseded with the new archive-based update mechanism.
- updateTemp(Path, PublicKey) - Method in class Configuration
-
Deprecated.Superseded with the new archive-based update mechanism.
- updateTemp(Path, PublicKey, Injectable) - Method in class Configuration
-
Deprecated.Superseded with the new archive-based update mechanism.
- updateTemp(Path, PublicKey, UpdateHandler) - Method in class Configuration
-
Deprecated.Superseded with the new archive-based update mechanism.
- updateTemp(Path, Injectable) - Method in class Configuration
-
Deprecated.Superseded with the new archive-based update mechanism.
- updateTemp(Path, UpdateHandler) - Method in class Configuration
-
Deprecated.Superseded with the new archive-based update mechanism.
- uri - Variable in class FileMapper
- uri(String) - Method in class FileMetadata.Reference
-
Set the download URI for this file.
- uri(URI) - Method in class FileMetadata.Reference
-
Set the download URI for this file.
V
- validatingFile(FileMetadata, Path) - Method in interface UpdateHandler
-
The file was successfully downloaded and is now about to be passed through a series of validations.
- valueOf(String) - Static method in enum class OS
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class PlaceholderMatchType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class OS
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class PlaceholderMatchType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verifyConfiguration(PublicKey) - Method in class Configuration
-
Verifies this config against this public key and throws a
SecurityException
if the config doesn't have a signature or if verification failed. - verifySignature(PublicKey) - Method in class ConfigMapper
- version() - Method in class DefaultBootstrap
- version() - Method in class DefaultLauncher
- version() - Method in class DefaultUpdateHandler
- version() - Method in interface Service
- VERSION - Static variable in class Bootstrap
-
The version of the current build of the framework.
W
- WHOLE_WORD - Enum constant in enum class PlaceholderMatchType
-
Will only replace with placeholders if the it doesn't break a word (using regex
\b
word boundary) - WINDOWS - Enum constant in enum class OS
- write(Writer) - Method in class Configuration
- write(Writer) - Method in class ConfigMapper
- write(Writer, boolean) - Method in class ConfigMapper
- write(Writer, Map<String, String>) - Static method in class MapMapper
- write(Writer, Map<String, String>, String) - Static method in class MapMapper
X
- XmlMapper - Class in org.update4j.mapper
- XmlMapper() - Constructor for class XmlMapper
All Classes|All Packages|Constant Field Values|Deprecated API|Serialized Form