Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- add(Plugin) - Method in class org.myjtools.jexten.plugin.internal.PluginMap
- addListener(PluginListener) - Method in class org.myjtools.jexten.plugin.PluginManager
-
Adds a listener to receive plugin lifecycle events.
- addValidator(PluginValidator) - Method in class org.myjtools.jexten.plugin.PluginManager
-
Adds a custom validator to be executed before plugin installation.
- and(PluginValidator) - Method in interface org.myjtools.jexten.plugin.PluginValidator
-
Creates a composite validator that runs this validator followed by another.
- append(String, Object...) - Method in class org.myjtools.jexten.plugin.internal.ModuleLayerTreeToStringVisitor
- application() - Method in class org.myjtools.jexten.plugin.PluginManager
-
Get the application name for which this plugin manager is configured.
- application() - Method in class org.myjtools.jexten.plugin.PluginManifest
- application() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- application(String) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- artifacts() - Method in class org.myjtools.jexten.plugin.PluginManifest
- artifacts() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- artifacts(Map<String, List<String>>) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- artifactStore() - Method in class org.myjtools.jexten.plugin.PluginManager
-
Get the artifact store for this plugin manager.
- ArtifactStore - Interface in org.myjtools.jexten.plugin
- assemble(PluginManifest, Path, List<Path>) - Static method in class org.myjtools.jexten.plugin.internal.PluginBundleFile
-
Creates a new plugin bundle at the specified path with the given plugin manifest and dependencies.
B
- build() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- builder() - Static method in class org.myjtools.jexten.plugin.PluginManifest
- buildModuleLayer(ModuleLayer, ClassLoader) - Method in class org.myjtools.jexten.plugin.internal.Plugin
-
Build the Java
ModuleLayerthat will be used to load the classes of the plugin. - Built-in Validators - Search tag in interface org.myjtools.jexten.plugin.PluginValidator
- Section
C
- calculateSha256(Path) - Static method in interface org.myjtools.jexten.plugin.PluginValidator
- checksums() - Method in class org.myjtools.jexten.plugin.PluginManifest
- checksums() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- checksums(Map<String, String>) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- clear() - Method in class org.myjtools.jexten.plugin.internal.PluginMap
- containsKey(PluginID) - Method in class org.myjtools.jexten.plugin.internal.PluginMap
D
- deleteFile(Path) - Static method in class org.myjtools.jexten.plugin.internal.FileUtil
- depth() - Method in class org.myjtools.jexten.plugin.ModuleLayerTree
- description() - Method in class org.myjtools.jexten.plugin.ModuleLayerTree
- description() - Method in class org.myjtools.jexten.plugin.PluginManifest
- description() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- description(String) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- displayName() - Method in class org.myjtools.jexten.plugin.PluginManifest
- displayName() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- displayName(String) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
E
- enterLayer(ModuleLayer, PluginManifest, int) - Method in class org.myjtools.jexten.plugin.internal.ModuleLayerTreeToStringVisitor
- enterLayer(ModuleLayer, PluginManifest, int) - Method in interface org.myjtools.jexten.plugin.ModuleLayerTreeVisitor
- equals(Object) - Method in record class org.myjtools.jexten.plugin.PluginEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.myjtools.jexten.plugin.PluginID
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class org.myjtools.jexten.plugin.PluginManifest
- errors() - Method in class org.myjtools.jexten.plugin.ValidationResult
-
Returns the list of error messages.
- exitLayer(ModuleLayer, PluginManifest, int) - Method in class org.myjtools.jexten.plugin.internal.ModuleLayerTreeToStringVisitor
- exitLayer(ModuleLayer, PluginManifest, int) - Method in interface org.myjtools.jexten.plugin.ModuleLayerTreeVisitor
- extensionPoints() - Method in class org.myjtools.jexten.plugin.PluginManifest
- extensionPoints() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- extensionPoints(List<String>) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- extensions() - Method in class org.myjtools.jexten.plugin.PluginManifest
- extensions() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- extensions(Map<String, List<String>>) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- extract(Path) - Method in class org.myjtools.jexten.plugin.internal.PluginBundleFile
-
Unzips the plugin bundle into the specified target folder.
F
- FileUtil - Class in org.myjtools.jexten.plugin.internal
- findArtifactName(Path) - Static method in class org.myjtools.jexten.plugin.internal.FileUtil
- findArtifactVersion(Path) - Static method in class org.myjtools.jexten.plugin.internal.FileUtil
- forEach(Consumer<ModuleLayerTree>) - Method in class org.myjtools.jexten.plugin.ModuleLayerTree
- forEach(ModuleLayerTreeVisitor) - Method in class org.myjtools.jexten.plugin.ModuleLayerTree
- forTypes(PluginListener, PluginEvent.Type...) - Static method in interface org.myjtools.jexten.plugin.PluginListener
-
Creates a listener that only responds to specific event types.
G
- get(PluginID) - Method in class org.myjtools.jexten.plugin.internal.PluginMap
- getPluginManifest(PluginID) - Method in class org.myjtools.jexten.plugin.PluginManager
-
Get the plugin manifest with the given ID.
- getVersion(PluginID) - Method in class org.myjtools.jexten.plugin.internal.PluginMap
- group() - Method in record class org.myjtools.jexten.plugin.PluginID
-
Returns the value of the
grouprecord component. - group() - Method in class org.myjtools.jexten.plugin.PluginManifest
- group() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- group(String) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
H
- hashCode() - Method in record class org.myjtools.jexten.plugin.PluginEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.myjtools.jexten.plugin.PluginID
-
Returns a hash code value for this object.
- hashCode() - Method in class org.myjtools.jexten.plugin.PluginManifest
- hostModule() - Method in class org.myjtools.jexten.plugin.PluginManifest
- hostModule() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- hostModule(String) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
I
- id() - Method in class org.myjtools.jexten.plugin.PluginManifest
- ids() - Method in class org.myjtools.jexten.plugin.internal.PluginMap
- installed(PluginManifest) - Static method in record class org.myjtools.jexten.plugin.PluginEvent
-
Creates an INSTALLED event.
- INSTALLED - Enum constant in enum class org.myjtools.jexten.plugin.PluginEvent.Type
-
A plugin was successfully installed and loaded.
- installPluginFromBundle(Path) - Method in class org.myjtools.jexten.plugin.PluginManager
-
Install a plugin bundle from a file.
- installPluginFromJar(Path) - Method in class org.myjtools.jexten.plugin.PluginManager
-
Install a plugin from a JAR file.
- invalid(String) - Static method in class org.myjtools.jexten.plugin.ValidationResult
-
Creates an invalid result with a single error message.
- invalid(List<String>) - Static method in class org.myjtools.jexten.plugin.ValidationResult
-
Creates an invalid result with multiple error messages.
- InvalidManifestException - Exception Class in org.myjtools.jexten.plugin
-
Exception thrown when a plugin manifest fails validation.
- InvalidManifestException(List<String>) - Constructor for exception class org.myjtools.jexten.plugin.InvalidManifestException
-
Creates a new exception with the specified validation errors.
- isHostedBy(ModuleLayer) - Method in class org.myjtools.jexten.plugin.internal.Plugin
- isValid() - Method in class org.myjtools.jexten.plugin.ValidationResult
-
Returns whether this result represents a valid state (no errors).
L
- layers() - Method in class org.myjtools.jexten.plugin.internal.PluginMap
- licenseName() - Method in class org.myjtools.jexten.plugin.PluginManifest
- licenseName() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- licenseName(String) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- licenseText() - Method in class org.myjtools.jexten.plugin.PluginManifest
- licenseText() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- licenseText(String) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- locatePluginManifest(Path) - Static method in class org.myjtools.jexten.plugin.PluginFile
- log - Static variable in class org.myjtools.jexten.plugin.internal.Plugin
M
- manifest() - Method in class org.myjtools.jexten.plugin.internal.Plugin
-
Get the plugin manifest that describes the plugin.
- manifest() - Method in record class org.myjtools.jexten.plugin.PluginEvent
-
Returns the value of the
manifestrecord component. - merge(ValidationResult) - Method in class org.myjtools.jexten.plugin.ValidationResult
-
Merges this result with another, combining all errors.
- moduleLayer() - Method in class org.myjtools.jexten.plugin.ModuleLayerTree
- moduleLayers() - Method in class org.myjtools.jexten.plugin.PluginManager
- ModuleLayerTree - Class in org.myjtools.jexten.plugin
-
A plugin module layer tree is a structure that describes the module layer composition regarding a set of plugins.
- ModuleLayerTree(Map<PluginManifest, ModuleLayer>) - Constructor for class org.myjtools.jexten.plugin.ModuleLayerTree
- ModuleLayerTreeToStringVisitor - Class in org.myjtools.jexten.plugin.internal
- ModuleLayerTreeToStringVisitor() - Constructor for class org.myjtools.jexten.plugin.internal.ModuleLayerTreeToStringVisitor
- ModuleLayerTreeVisitor - Interface in org.myjtools.jexten.plugin
- moduleNames(ModuleLayer) - Method in class org.myjtools.jexten.plugin.internal.Plugin
-
Compute a list with every Java module used by the plugin, excluding the modules that are already used by the parent layer.
- moduleReferences() - Method in class org.myjtools.jexten.plugin.internal.Plugin
- modules() - Method in class org.myjtools.jexten.plugin.ModuleLayerTree
N
- name() - Method in record class org.myjtools.jexten.plugin.PluginID
-
Returns the value of the
namerecord component. - name() - Method in class org.myjtools.jexten.plugin.PluginManifest
- name() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- name(String) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
O
- onInstall(PluginListener) - Static method in interface org.myjtools.jexten.plugin.PluginListener
-
Creates a listener that responds only to INSTALLED events.
- onPluginEvent(PluginEvent) - Method in interface org.myjtools.jexten.plugin.PluginListener
-
Called when a plugin lifecycle event occurs.
- onReload(PluginListener) - Static method in interface org.myjtools.jexten.plugin.PluginListener
-
Creates a listener that responds only to RELOADED events.
- onRemove(PluginListener) - Static method in interface org.myjtools.jexten.plugin.PluginListener
-
Creates a listener that responds only to REMOVED events.
- org.myjtools.jexten.plugin - module org.myjtools.jexten.plugin
-
Plugin management module for the JExten extension framework.
- org.myjtools.jexten.plugin - package org.myjtools.jexten.plugin
- org.myjtools.jexten.plugin.internal - package org.myjtools.jexten.plugin.internal
P
- parent() - Method in class org.myjtools.jexten.plugin.ModuleLayerTree
- path - Variable in class org.myjtools.jexten.plugin.PluginFile
- path() - Method in class org.myjtools.jexten.plugin.PluginFile
- plugin - Variable in class org.myjtools.jexten.plugin.PluginFile
- plugin() - Method in class org.myjtools.jexten.plugin.ModuleLayerTree
- plugin() - Method in class org.myjtools.jexten.plugin.PluginFile
- Plugin - Class in org.myjtools.jexten.plugin.internal
- Plugin(PluginManifest, List<Path>) - Constructor for class org.myjtools.jexten.plugin.internal.Plugin
- PLUGIN_MANIFEST_FILE - Static variable in class org.myjtools.jexten.plugin.PluginFile
- PluginBundleFile - Class in org.myjtools.jexten.plugin.internal
- PluginEvent - Record Class in org.myjtools.jexten.plugin
-
Represents an event that occurred during the plugin lifecycle.
- PluginEvent(PluginEvent.Type, PluginID, PluginManifest) - Constructor for record class org.myjtools.jexten.plugin.PluginEvent
-
Creates an instance of a
PluginEventrecord class. - PluginEvent.Type - Enum Class in org.myjtools.jexten.plugin
-
The type of plugin event.
- PluginException - Exception Class in org.myjtools.jexten.plugin
- PluginException(Exception, String, Object...) - Constructor for exception class org.myjtools.jexten.plugin.PluginException
- PluginException(String, Object...) - Constructor for exception class org.myjtools.jexten.plugin.PluginException
- PluginFile - Class in org.myjtools.jexten.plugin
-
Represents a plugin file, which can be a JAR or ZIP file containing a plugin manifest.
- PluginFile(Path) - Constructor for class org.myjtools.jexten.plugin.PluginFile
- pluginId() - Method in record class org.myjtools.jexten.plugin.PluginEvent
-
Returns the value of the
pluginIdrecord component. - pluginId() - Method in exception class org.myjtools.jexten.plugin.PluginValidationException
-
Returns the ID of the plugin that failed validation.
- pluginID() - Method in class org.myjtools.jexten.plugin.PluginFile
- PluginID - Record Class in org.myjtools.jexten.plugin
- PluginID(String, String) - Constructor for record class org.myjtools.jexten.plugin.PluginID
-
Creates an instance of a
PluginIDrecord class. - PluginJarFile - Class in org.myjtools.jexten.plugin.internal
-
Represents a plugin file in the form of a JAR file.
- PluginListener - Interface in org.myjtools.jexten.plugin
-
Listener interface for receiving plugin lifecycle events.
- PluginManager - Class in org.myjtools.jexten.plugin
- PluginManager(String, ClassLoader, Path) - Constructor for class org.myjtools.jexten.plugin.PluginManager
- PluginManifest - Class in org.myjtools.jexten.plugin
- PluginManifestBuilder - Class in org.myjtools.jexten.plugin
- PluginManifestBuilder() - Constructor for class org.myjtools.jexten.plugin.PluginManifestBuilder
- PluginMap - Class in org.myjtools.jexten.plugin.internal
- PluginMap(ClassLoader) - Constructor for class org.myjtools.jexten.plugin.internal.PluginMap
- plugins() - Method in class org.myjtools.jexten.plugin.PluginManager
-
Get the installed plugins.
- PluginValidationException - Exception Class in org.myjtools.jexten.plugin
-
Exception thrown when a plugin fails validation before installation.
- PluginValidationException(PluginID, List<String>) - Constructor for exception class org.myjtools.jexten.plugin.PluginValidationException
-
Creates a new validation exception.
- PluginValidator - Interface in org.myjtools.jexten.plugin
-
Interface for custom plugin validators.
R
- read() - Method in class org.myjtools.jexten.plugin.PluginFile
- read(Reader) - Static method in class org.myjtools.jexten.plugin.PluginManifest
-
Reads and validates a plugin manifest from a YAML source.
- read(Path) - Static method in class org.myjtools.jexten.plugin.internal.PluginBundleFile
-
Reads a plugin bundle from the specified path.
- read(Path) - Static method in class org.myjtools.jexten.plugin.internal.PluginJarFile
- refresh() - Method in class org.myjtools.jexten.plugin.PluginManager
-
Refresh the plugin manager contents, reloading all installed plugins.
- reloadAllPlugins() - Method in class org.myjtools.jexten.plugin.PluginManager
-
Reloads all installed plugins.
- reloaded(PluginManifest) - Static method in record class org.myjtools.jexten.plugin.PluginEvent
-
Creates a RELOADED event.
- RELOADED - Enum constant in enum class org.myjtools.jexten.plugin.PluginEvent.Type
-
A plugin was reloaded (unloaded and loaded again).
- reloadPlugin(PluginID) - Method in class org.myjtools.jexten.plugin.PluginManager
-
Reloads a plugin by re-reading its manifest and rebuilding its module layer.
- remove(PluginID) - Method in class org.myjtools.jexten.plugin.internal.PluginMap
- removed(PluginManifest) - Static method in record class org.myjtools.jexten.plugin.PluginEvent
-
Creates a REMOVED event.
- REMOVED - Enum constant in enum class org.myjtools.jexten.plugin.PluginEvent.Type
-
A plugin was removed from the system.
- removeListener(PluginListener) - Method in class org.myjtools.jexten.plugin.PluginManager
-
Removes a previously added listener.
- removePlugin(PluginID) - Method in class org.myjtools.jexten.plugin.PluginManager
-
Remove a plugin from the manager.
- requireDescription() - Static method in interface org.myjtools.jexten.plugin.PluginValidator
-
Creates a validator that requires plugins to have a description.
- requireDisplayName() - Static method in interface org.myjtools.jexten.plugin.PluginValidator
-
Creates a validator that requires plugins to have a display name.
- requireLicense() - Static method in interface org.myjtools.jexten.plugin.PluginValidator
-
Creates a validator that requires plugins to have a license specified.
- requireMinimumVersion(String) - Static method in interface org.myjtools.jexten.plugin.PluginValidator
-
Creates a validator that checks if the plugin version is at least the specified minimum.
- requireUrl() - Static method in interface org.myjtools.jexten.plugin.PluginValidator
-
Creates a validator that requires plugins to have a URL specified.
- retrieveArtifacts(Map<String, List<String>>) - Method in interface org.myjtools.jexten.plugin.ArtifactStore
-
Retrieves artifacts based on the provided artifact identifiers.
S
- setArtifactStore(ArtifactStore) - Method in class org.myjtools.jexten.plugin.PluginManager
-
Set the artifact store for this plugin manager.
- stream() - Method in class org.myjtools.jexten.plugin.ModuleLayerTree
T
- toString() - Method in class org.myjtools.jexten.plugin.internal.Plugin
- toString() - Method in record class org.myjtools.jexten.plugin.PluginEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.myjtools.jexten.plugin.PluginID
-
Returns a string representation of this record class.
- toString() - Method in class org.myjtools.jexten.plugin.ValidationResult
- toString(ModuleLayerTree) - Static method in class org.myjtools.jexten.plugin.internal.ModuleLayerTreeToStringVisitor
- type() - Method in record class org.myjtools.jexten.plugin.PluginEvent
-
Returns the value of the
typerecord component.
U
- unloaded(PluginManifest) - Static method in record class org.myjtools.jexten.plugin.PluginEvent
-
Creates an UNLOADED event.
- UNLOADED - Enum constant in enum class org.myjtools.jexten.plugin.PluginEvent.Type
-
A plugin was unloaded (removed or being reloaded).
- unzipFile(ZipFile, ZipEntry, Path) - Static method in class org.myjtools.jexten.plugin.internal.FileUtil
- url() - Method in class org.myjtools.jexten.plugin.PluginManifest
- url() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- url(String) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- Usage Example - Search tag in interface org.myjtools.jexten.plugin.PluginListener
- Section
- Usage Example - Search tag in interface org.myjtools.jexten.plugin.PluginValidator
- Section
- Usage Examples - Search tag in class org.myjtools.jexten.plugin.ValidationResult
- Section
V
- valid() - Static method in class org.myjtools.jexten.plugin.ValidationResult
-
Creates a valid result with no errors.
- validate() - Method in class org.myjtools.jexten.plugin.PluginManifest
-
Validates this manifest, checking for required fields and correct formats.
- validate(PluginManifest) - Method in interface org.myjtools.jexten.plugin.PluginValidator
-
Validates a plugin manifest.
- validationErrors() - Method in exception class org.myjtools.jexten.plugin.InvalidManifestException
-
Returns the list of validation errors found in the manifest.
- validationErrors() - Method in exception class org.myjtools.jexten.plugin.PluginValidationException
-
Returns the list of validation errors.
- ValidationResult - Class in org.myjtools.jexten.plugin
-
Represents the result of validating a plugin manifest.
- validators() - Method in class org.myjtools.jexten.plugin.PluginManager
-
Returns an unmodifiable view of the registered validators.
- valueOf(String) - Static method in enum class org.myjtools.jexten.plugin.PluginEvent.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.myjtools.jexten.plugin.PluginEvent.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verifyChecksum(PluginManifest, Path, String) - Static method in interface org.myjtools.jexten.plugin.PluginValidator
- version() - Method in class org.myjtools.jexten.plugin.PluginManifest
- version() - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- version(String) - Method in class org.myjtools.jexten.plugin.PluginManifestBuilder
- visitModule(ModuleLayer, PluginManifest, int, Module) - Method in class org.myjtools.jexten.plugin.internal.ModuleLayerTreeToStringVisitor
- visitModule(ModuleLayer, PluginManifest, int, Module) - Method in interface org.myjtools.jexten.plugin.ModuleLayerTreeVisitor
W
- wrapper(Exception) - Static method in exception class org.myjtools.jexten.plugin.PluginException
- write(Writer) - Method in class org.myjtools.jexten.plugin.PluginManifest
Y
- yamlWriter() - Static method in class org.myjtools.jexten.plugin.internal.FileUtil
Z
- zipSlipProtect(ZipEntry, Path) - Static method in class org.myjtools.jexten.plugin.internal.FileUtil
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form