net.adamcin.oakpal.api

Interface ProgressCheck

All Superinterfaces:

ScanListener, ViolationReporter

All Known Implementing Classes:

SimpleProgressCheck, SimpleProgressCheckFactoryCheck

@ConsumerType
public interface ProgressCheck
extends ScanListener, ViolationReporter

Primary point of customization for the OakPAL framework. Receives events, ultimately, from a ProgressTrackerListener.

Some constraints for behavior:

1. Once constructed, instances of this class should be immutable from the perspective of any other public API.
2. The OakMachine will call these methods synchronously and in a single-threaded fashion.
3. Mutation of the repository state exposed by Session is not allowed.
4. Implementations of this which are referenced directly by a checklist must expose a zero-argument default constructor.
5. If an implementation accepts parameters at construction, it must be constructed from a checklist-referenced ProgressCheckFactory in order to be loaded successfully.

Method Summary

Modifier and Type	Method and Description
default void	afterExtract(org.apache.jackrabbit.vault.packaging.PackageId packageId, javax.jcr.Session inspectSession) Provides an opportunity to inspect repository state between packages.
default void	beforeExtract(org.apache.jackrabbit.vault.packaging.PackageId packageId, javax.jcr.Session inspectSession, org.apache.jackrabbit.vault.packaging.PackageProperties packageProperties, org.apache.jackrabbit.vault.fs.config.MetaInf metaInf, List<org.apache.jackrabbit.vault.packaging.PackageId> subpackages) Called for each package before it is extracted.
default void	deletedPath(org.apache.jackrabbit.vault.packaging.PackageId packageId, String path, javax.jcr.Session inspectSession) Notified when package importer deletes an existing node.
default String	getCheckName() Return an optional label for displaying reports made by this reporter.
default void	identifyPackage(org.apache.jackrabbit.vault.packaging.PackageId packageId, File file) Called after the package is uploaded to the package manager at the beginning of the scan.
default void	identifySubpackage(org.apache.jackrabbit.vault.packaging.PackageId packageId, org.apache.jackrabbit.vault.packaging.PackageId parentId) Called after each subpackage is opened.
default void	importedPath(org.apache.jackrabbit.vault.packaging.PackageId packageId, String path, javax.jcr.Node node) Deprecated. 2.0.0 implement importedPath(PackageId, String, Node, PathAction) instead
default void	importedPath(org.apache.jackrabbit.vault.packaging.PackageId packageId, String path, javax.jcr.Node node, PathAction action) Notified when package importer adds, modifies, or leaves a node untouched.
default void	readManifest(org.apache.jackrabbit.vault.packaging.PackageId packageId, Manifest manifest) If the package provides a Manifest, it will be provided to the check using this method, prior to calling beforeExtract(PackageId, Session, PackageProperties, MetaInf, List).

Methods inherited from interface net.adamcin.oakpal.api.ScanListener

finishedScan, startedScan

Methods inherited from interface net.adamcin.oakpal.api.ViolationReporter

getReportedViolations, getResourceBundleBaseName, setResourceBundle

Method Detail

getCheckName

default String getCheckName()

Return an optional label for displaying reports made by this reporter.

Returns:

an optional display label for this reporter.

identifyPackage

default void identifyPackage(org.apache.jackrabbit.vault.packaging.PackageId packageId,
                             File file)

Called after the package is uploaded to the package manager at the beginning of the scan. Track subsequent events using the package ID provided to this method. This method will only be called once for each package provided to OakMachine.scanPackage(File...).

Parameters:

packageId - the package ID of the newly opened package

file - the package file that will be opened

identifySubpackage

default void identifySubpackage(org.apache.jackrabbit.vault.packaging.PackageId packageId,
                                org.apache.jackrabbit.vault.packaging.PackageId parentId)

Called after each subpackage is opened. Track subsequent events using the package ID provided to this method.

Parameters:

packageId - the package ID of the newly opened subpackage

parentId - the package ID of the parent package.

readManifest

default void readManifest(org.apache.jackrabbit.vault.packaging.PackageId packageId,
                          Manifest manifest)

If the package provides a Manifest, it will be provided to the check using this method, prior to calling beforeExtract(PackageId, Session, PackageProperties, MetaInf, List).

Parameters:

packageId - the package ID of the newly opened package

manifest - the parsed manifest

Since:

1.3.0

beforeExtract

default void beforeExtract(org.apache.jackrabbit.vault.packaging.PackageId packageId,
                           javax.jcr.Session inspectSession,
                           org.apache.jackrabbit.vault.packaging.PackageProperties packageProperties,
                           org.apache.jackrabbit.vault.fs.config.MetaInf metaInf,
                           List<org.apache.jackrabbit.vault.packaging.PackageId> subpackages)
                    throws javax.jcr.RepositoryException

Called for each package before it is extracted.

Parameters:

packageId - the package ID of the newly opened package

inspectSession - session providing access to repository state

packageProperties - the package properties

metaInf - the package meta information

subpackages - extracted subpackages

Throws:

javax.jcr.RepositoryException - because of access to a Session

importedPath

@Deprecated
default void importedPath(org.apache.jackrabbit.vault.packaging.PackageId packageId,
                                      String path,
                                      javax.jcr.Node node)
                               throws javax.jcr.RepositoryException

Deprecated. 2.0.0 implement importedPath(PackageId, String, Node, PathAction) instead

Notified when package importer adds, modifies, or leaves a node untouched. This method is not called if importedPath(PackageId, String, Node, PathAction) is overridden.

Parameters:

packageId - the current package

path - the imported path

node - the imported node

Throws:

javax.jcr.RepositoryException - because of access to a Node

importedPath

default void importedPath(org.apache.jackrabbit.vault.packaging.PackageId packageId,
                          String path,
                          javax.jcr.Node node,
                          PathAction action)
                   throws javax.jcr.RepositoryException

Notified when package importer adds, modifies, or leaves a node untouched.

Parameters:

packageId - the current package

path - the imported path

node - the imported node

action - the reported path action type

Throws:

javax.jcr.RepositoryException - because of access to a Node

deletedPath

default void deletedPath(org.apache.jackrabbit.vault.packaging.PackageId packageId,
                         String path,
                         javax.jcr.Session inspectSession)
                  throws javax.jcr.RepositoryException

Notified when package importer deletes an existing node.

Parameters:

packageId - the current package

path - deleted path

inspectSession - session providing access to repository state

Throws:

javax.jcr.RepositoryException - because of access to a Session

afterExtract

default void afterExtract(org.apache.jackrabbit.vault.packaging.PackageId packageId,
                          javax.jcr.Session inspectSession)
                   throws javax.jcr.RepositoryException

Provides an opportunity to inspect repository state between packages.

Parameters:

packageId - the current package

inspectSession - session providing access to repository state

Throws:

javax.jcr.RepositoryException - because of access to a Session