net.adamcin.oakpal.core

Class OakMachine.Builder

java.lang.Object

net.adamcin.oakpal.core.OakMachine.Builder

Enclosing class:

OakMachine

public static class OakMachine.Builder
extends Object

Use the builder to construct the OakMachine.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
OakMachine	build() Construct a OakMachine from the OakMachine.Builder state.
OakMachine.Builder	withEnablePreInstallHooks(boolean enablePreInstallHooks) Set to true to enable pre-install package install hooks for the scan.
OakMachine.Builder	withErrorListener(ErrorListener errorListener) Set the single ErrorListener for the scan.
OakMachine.Builder	withInitStage(InitStage... initStage) Add a single instance of InitStage (or more) to the scan.
OakMachine.Builder	withInitStages(List<InitStage> initStages) Add a list of InitStages to the scan.
OakMachine.Builder	withInstallHookClassLoader(ClassLoader classLoader) Provide a classloader to ImportOptions.setHookClassLoader(ClassLoader).
OakMachine.Builder	withInstallHookPolicy(InstallHookPolicy installHookPolicy) Specify an InstallHookPolicy for the scan.
OakMachine.Builder	withInstallHookProcessorFactory(org.apache.jackrabbit.vault.packaging.InstallHookProcessorFactory installHookProcessorFactory) Provide an InstallHookProcessorFactory.
OakMachine.Builder	withJcrCustomizer(OakMachine.JcrCustomizer jcrCustomizer) Provide a function to customize the Jcr builder prior to the scan.
OakMachine.Builder	withNodeStoreSupplier(Supplier<org.apache.jackrabbit.oak.spi.state.NodeStore> nodeStoreSupplier) Specify a supplier that will produce a NodeStore for the scan.
OakMachine.Builder	withPackagingService(org.apache.jackrabbit.vault.packaging.Packaging packagingService) Provide a Packaging service for use in retrieving a JcrPackageManager for an admin session.
OakMachine.Builder	withPreInstallPackage(File... preInstallPackage) Deprecated. 1.3.1 pre-install packages are now handled as URIs
OakMachine.Builder	withPreInstallPackages(List<File> preInstallPackages) Deprecated. 1.3.1 pre-install packages are now handled as URIs
OakMachine.Builder	withPreInstallUrl(URL... preInstallPackage) Provide a list of package files to install before each scan.
OakMachine.Builder	withPreInstallUrls(@NotNull List<URL> preInstallPackages) Provide a list of package files to install before each scan.
OakMachine.Builder	withProgressCheck(net.adamcin.oakpal.api.ProgressCheck... progressCheck) Set a single instance of ProgressCheck for the scan.
OakMachine.Builder	withProgressChecks(List<? extends net.adamcin.oakpal.api.ProgressCheck> progressChecks) Set the list of ProgressChecks for the scan.
OakMachine.Builder	withProgressChecks(net.adamcin.oakpal.api.ProgressCheck... progressCheck) Deprecated. 1.4.0 use withProgressCheck(ProgressCheck...) instead.
OakMachine.Builder	withRepoInitProcesser(OakMachine.RepoInitProcessor repoInitProcesser) Provide a RepoInitProcessor.
OakMachine.Builder	withRunModes(Set<String> runModes) Provide a set of simulated sling run modes.
OakMachine.Builder	withSlingSimulator(SlingSimulatorBackend slingSimulator) Provide a sling simulator
OakMachine.Builder	withSubpackageSilencer(OakMachine.SubpackageSilencer subpackageSilencer) Provide a predicate taking the subpackage PackageId as the first argument and the parent PackageId as the second argument, returning true if events for the subpackage and any of ITS subpackages should be silenced during the scan.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withPackagingService

public OakMachine.Builder withPackagingService(org.apache.jackrabbit.vault.packaging.Packaging packagingService)

Provide a Packaging service for use in retrieving a JcrPackageManager for an admin session.

Currently only supported when using this in an OSGi context.

Parameters:

packagingService - a specific service to use, configured with alternative package registries.

Returns:

my builder self

withInitStage

public OakMachine.Builder withInitStage(InitStage... initStage)

Add a single instance of InitStage (or more) to the scan.

Parameters:

initStage - the init stage

Returns:

my builder self

withInitStages

public OakMachine.Builder withInitStages(List<InitStage> initStages)

Add a list of InitStages to the scan.

Parameters:

initStages - the list of init stages

Returns:

my builder self

withProgressCheck

public OakMachine.Builder withProgressCheck(@NotNull
                                            net.adamcin.oakpal.api.ProgressCheck... progressCheck)

Set a single instance of ProgressCheck for the scan.

Parameters:

progressCheck - the progress checks

Returns:

my builder self

withProgressChecks

@Deprecated
public OakMachine.Builder withProgressChecks(net.adamcin.oakpal.api.ProgressCheck... progressCheck)

Deprecated. 1.4.0 use withProgressCheck(ProgressCheck...) instead.

Set a single instance of ProgressCheck for the scan.

Parameters:

progressCheck - the progress checks

Returns:

my builder self

withProgressChecks

public OakMachine.Builder withProgressChecks(List<? extends net.adamcin.oakpal.api.ProgressCheck> progressChecks)

Set the list of ProgressChecks for the scan.

Parameters:

progressChecks - the list of packageListeners

Returns:

my builder self

withErrorListener

public OakMachine.Builder withErrorListener(ErrorListener errorListener)

Set the single ErrorListener for the scan.

Parameters:

errorListener - the error handler

Returns:

my builder self

withPreInstallPackage

@Deprecated
public OakMachine.Builder withPreInstallPackage(File... preInstallPackage)

Deprecated. 1.3.1 pre-install packages are now handled as URIs

Provide a list of package files to install before each scan. Install events raised during pre-install are not passed to each ProgressCheck, but errors raised are passed to the ErrorListener.

Parameters:

preInstallPackage - the list of pre-install package files

Returns:

my builder self

withPreInstallPackages

@Deprecated
public OakMachine.Builder withPreInstallPackages(List<File> preInstallPackages)

Deprecated. 1.3.1 pre-install packages are now handled as URIs

Provide a list of package files to install before each scan. Install events raised during pre-install are not passed to each ProgressCheck, but errors raised are passed to the ErrorListener.

Parameters:

preInstallPackages - the list of pre-install package files

Returns:

my builder self

withPreInstallUrl

public OakMachine.Builder withPreInstallUrl(@NotNull
                                            URL... preInstallPackage)

Provide a list of package files to install before each scan. Install events raised during pre-install are not passed to each ProgressCheck, but errors raised are passed to the ErrorListener.

Parameters:

preInstallPackage - the list of pre-install package files

Returns:

my builder self

withPreInstallUrls

public OakMachine.Builder withPreInstallUrls(@NotNull
                                             @NotNull List<URL> preInstallPackages)

Provide a list of package files to install before each scan. Install events raised during pre-install are not passed to each ProgressCheck, but errors raised are passed to the ErrorListener.

Parameters:

preInstallPackages - the list of pre-install package files

Returns:

my builder self

withJcrCustomizer

public OakMachine.Builder withJcrCustomizer(OakMachine.JcrCustomizer jcrCustomizer)

Provide a function to customize the Jcr builder prior to the scan.

Parameters:

jcrCustomizer - the Jcr builder customization function

Returns:

my builder self

withInstallHookProcessorFactory

public OakMachine.Builder withInstallHookProcessorFactory(org.apache.jackrabbit.vault.packaging.InstallHookProcessorFactory installHookProcessorFactory)

Provide an InstallHookProcessorFactory.

Parameters:

installHookProcessorFactory - the factory

Returns:

my builder self

withInstallHookClassLoader

public OakMachine.Builder withInstallHookClassLoader(ClassLoader classLoader)

Provide a classloader to ImportOptions.setHookClassLoader(ClassLoader).

Parameters:

classLoader - the classloader to use for loading hooks

Returns:

my builder self

withEnablePreInstallHooks

public OakMachine.Builder withEnablePreInstallHooks(boolean enablePreInstallHooks)

Set to true to enable pre-install package install hooks for the scan.

Parameters:

enablePreInstallHooks - true to enable pre-install package install hooks

Returns:

my builder self

withInstallHookPolicy

public OakMachine.Builder withInstallHookPolicy(InstallHookPolicy installHookPolicy)

Specify an InstallHookPolicy for the scan.

Parameters:

installHookPolicy - the InstallHookPolicy to enforce

Returns:

my builder self

withNodeStoreSupplier

public OakMachine.Builder withNodeStoreSupplier(Supplier<org.apache.jackrabbit.oak.spi.state.NodeStore> nodeStoreSupplier)

Specify a supplier that will produce a NodeStore for the scan. By default, MemoryNodeStore.MemoryNodeStore() will be used (e.g. MemoryNodeStore::new).

Note: OakMachine will call Supplier.get() for every execution of OakMachine.scanPackage(File...). Beyond the call to this supplier function, it is the client's responsibility to manage the external NodeStore's state between scans when using the same OakMachine instance.

Parameters:

nodeStoreSupplier - the NodeStore

Returns:

my builder self

withSubpackageSilencer

public OakMachine.Builder withSubpackageSilencer(OakMachine.SubpackageSilencer subpackageSilencer)

Provide a predicate taking the subpackage PackageId as the first argument and the parent PackageId as the second argument, returning true if events for the subpackage and any of ITS subpackages should be silenced during the scan. Embedded Packages discovered by the Sling Simulator are also silenced in the same way.

Parameters:

subpackageSilencer - a predicate taking the subpackage PackageId as the first argument and the parent PackageId as the second argument, returning true if events for the subpackage and any of ITS subpackages should be silenced during the scan.

Returns:

my builder self

withRepoInitProcesser

public OakMachine.Builder withRepoInitProcesser(OakMachine.RepoInitProcessor repoInitProcesser)

Provide a RepoInitProcessor.

Parameters:

repoInitProcesser - the repoinit processor

Returns:

my builder self

Since:

2.2.0

withSlingSimulator

public OakMachine.Builder withSlingSimulator(SlingSimulatorBackend slingSimulator)

Provide a sling simulator

Parameters:

slingSimulator - the sling simulator backend

Returns:

my builder self

Since:

2.2.0

withRunModes

public OakMachine.Builder withRunModes(Set<String> runModes)

Provide a set of simulated sling run modes.

Parameters:

runModes - the set of sling run modes

Returns:

my builder self

Since:

2.2.0

build

public OakMachine build()

Construct a OakMachine from the OakMachine.Builder state.

Returns:

a OakMachine