Interface InstallHookProcessor
-
- All Superinterfaces:
AutoCloseable
,Closeable
- All Known Implementing Classes:
InstallHookProcessorImpl
public interface InstallHookProcessor extends Closeable
The install hook processor is used for handle the install hooks, from registration to execution.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
close()
Cleans up any registered hooksboolean
execute(InstallContext context)
Executes the registered hooks with the currentInstallContext.Phase
.boolean
hasHooks()
Checks if this process has any hooks registered.void
registerHook(VaultInputSource input, ClassLoader classLoader)
Register the hook provided by the given input source.void
registerHooks(Archive archive, ClassLoader classLoader)
Register all hooks found in the given archive.
-
-
-
Method Detail
-
registerHooks
void registerHooks(Archive archive, ClassLoader classLoader) throws PackageException
Register all hooks found in the given archive.- Parameters:
archive
- the archive.classLoader
- the class loader- Throws:
PackageException
- if an error occurs.
-
registerHook
void registerHook(VaultInputSource input, ClassLoader classLoader) throws IOException, PackageException
Register the hook provided by the given input source.- Parameters:
input
- a vault input source containing the jar file of the install hookclassLoader
- the class loader- Throws:
IOException
- if an I/O error occursPackageException
- if an error occurs.
-
hasHooks
boolean hasHooks()
Checks if this process has any hooks registered.- Returns:
true
if there are hooks registered.
-
execute
boolean execute(InstallContext context)
Executes the registered hooks with the currentInstallContext.Phase
.- Parameters:
context
- the context- Returns:
true
if successful.
-
close
default void close() throws IOException
Cleans up any registered hooks- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
-