net.adamcin.oakpal.core

Class OakMachine

java.lang.Object

net.adamcin.oakpal.core.OakMachine

public final class OakMachine
extends Object

Entry point for OakPAL Acceptance Library. See ProgressCheck for the event listener interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OakMachine.Builder Use the builder to construct the OakMachine.
static interface	OakMachine.InspectBody<E extends Throwable> Functional interface for initAndInspect(InspectBody).
static interface	OakMachine.JcrCustomizer
static interface	OakMachine.RepoInitProcessor Functional interface for a repoinit processor that unifies the RepoInitParser and JcrRepoInitOpsProcessor signatures.
static interface	OakMachine.SubpackageSilencer Functional interface for Builder.withSubpackageSilencer(SubpackageSilencer).

Field Summary

Fields

Modifier and Type	Field and Description
static String	LN_UNDECLARED
static String	NS_PREFIX_OAKPAL
static String	NS_URI_OAKPAL
static String	NT_UNDECLARED

Method Summary

Modifier and Type	Method and Description
<E extends Throwable> void	adminInitAndInspect(OakMachine.InspectBody<E> inspectBody) Run arbitrary admin session logic against a post-InitStage OakPAL session.
ErrorListener	getErrorListener()
List<File>	getPreInstallFiles() Deprecated. 1.3.1 pre-install packages are now handled as URIs. use getPreInstallUrls().
List<URL>	getPreInstallUrls() Return the urls for preinstall packages.
List<net.adamcin.oakpal.api.ProgressCheck>	getProgressChecks()
<E extends Throwable> void	initAndInspect(OakMachine.InspectBody<E> inspectBody) Run arbitrary read-only session logic against a post-InitStage OakPAL session.
static org.apache.jackrabbit.vault.packaging.Packaging	newOakpalPackagingService()
static org.apache.jackrabbit.vault.packaging.Packaging	newOakpalPackagingService(@NotNull ClassLoader classLoader)
List<CheckReport>	scanPackage(File... file) Perform a scan of the provided package file or files.
List<CheckReport>	scanPackages(List<File> files) Execute a scan by installing each of the provided package files in sequence.

Methods inherited from class java.lang.Object

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

Field Detail

NS_URI_OAKPAL

public static final String NS_URI_OAKPAL

See Also:

Constant Field Values

NS_PREFIX_OAKPAL

public static final String NS_PREFIX_OAKPAL

See Also:

Constant Field Values

LN_UNDECLARED

public static final String LN_UNDECLARED

See Also:

Constant Field Values

NT_UNDECLARED

public static final String NT_UNDECLARED

See Also:

Constant Field Values

Method Detail

getProgressChecks

public List<net.adamcin.oakpal.api.ProgressCheck> getProgressChecks()

getErrorListener

public ErrorListener getErrorListener()

getPreInstallFiles

@Deprecated
public List<File> getPreInstallFiles()

Deprecated. 1.3.1 pre-install packages are now handled as URIs. use getPreInstallUrls().

Return the urls filtered and mapped back to files.

Returns:

the urls filtered and mapped back to files

getPreInstallUrls

public List<URL> getPreInstallUrls()

Return the urls for preinstall packages.

Returns:

the urls for preinstall packages

initAndInspect

public <E extends Throwable> void initAndInspect(OakMachine.InspectBody<E> inspectBody)
                                          throws AbortedScanException,
                                                 javax.jcr.RepositoryException,
                                                 E extends Throwable

Run arbitrary read-only session logic against a post-InitStage OakPAL session.

Type Parameters:

E - an error type thrown by the inspectBody

Parameters:

inspectBody - arbitrary logic to run against a Session

Throws:

AbortedScanException - for preinstall errors

javax.jcr.RepositoryException - for repository errors

E - for any number of other reasons

E extends Throwable

adminInitAndInspect

public <E extends Throwable> void adminInitAndInspect(OakMachine.InspectBody<E> inspectBody)
                                               throws AbortedScanException,
                                                      javax.jcr.RepositoryException,
                                                      E extends Throwable

Run arbitrary admin session logic against a post-InitStage OakPAL session.

Type Parameters:

E - an error type thrown by the inspectBody

Parameters:

inspectBody - arbitrary logic to run against a Session

Throws:

AbortedScanException - for preinstall errors

javax.jcr.RepositoryException - for repository errors

E - for any number of other reasons

E extends Throwable

scanPackage

public List<CheckReport> scanPackage(@NotNull
                                     File... file)
                              throws AbortedScanException

Perform a scan of the provided package file or files.

Parameters:

file - the file or files to scan

Returns:

a list of check reports

Throws:

AbortedScanException - if the scan was aborted because of an unrecoverable exception

See Also:

this is an alias for the plurally-named method

scanPackages

public List<CheckReport> scanPackages(List<File> files)
                               throws AbortedScanException

Execute a scan by installing each of the provided package files in sequence. The scan proceeds in the following order:

1. initRepository() creates an fresh Oak repository.
2. loginAdmin(Repository) opens an admin user JCR session.
3. InitStage.initSession(Session, ErrorListener, RepoInitProcessor) is called for each registered InitStage
4. processPackageFile(Session, JcrPackageManager, boolean, File) is performed for each of the preInstallUrls
5. Each registered ProgressCheck receives a ScanListener.startedScan() event.
6. processPackageFile(Session, JcrPackageManager, boolean, File) is performed for each of the elements of the files array.
7. Each registered ProgressCheck receives a ScanListener.finishedScan() event.
8. The admin session is closed.
9. The repository is shutdown.

Parameters:

files - a list of FileVault content package files to be installed in sequence.

Returns:

a list of any CheckReports reported during the scan.

Throws:

AbortedScanException - for any errors that terminate the scan.

newOakpalPackagingService

public static org.apache.jackrabbit.vault.packaging.Packaging newOakpalPackagingService()

newOakpalPackagingService

public static org.apache.jackrabbit.vault.packaging.Packaging newOakpalPackagingService(@NotNull
                                                                                        @NotNull ClassLoader classLoader)