A B C D E F G H I J K L M N O P Q R S T U V W Z

A

AbortedScanException - Exception in net.adamcin.oakpal.core

Represents an error that causes a package scan to abort without notifying the ErrorListener.

AbortedScanException(Throwable, File) - Constructor for exception net.adamcin.oakpal.core.AbortedScanException

AbortedScanException(Throwable, URL) - Constructor for exception net.adamcin.oakpal.core.AbortedScanException

AbortedScanException(Throwable, Node) - Constructor for exception net.adamcin.oakpal.core.AbortedScanException

AbortedScanException(Throwable) - Constructor for exception net.adamcin.oakpal.core.AbortedScanException

accept(Result<V>) - Method in class net.adamcin.oakpal.api.Result.Builder

ACE_PARAM_PATH - Static variable in class net.adamcin.oakpal.core.checks.ExpectAces

Deprecated.

ACE_PARAM_PRIVILEGES - Static variable in class net.adamcin.oakpal.core.checks.ExpectAces

Deprecated.

ACE_PARAM_TYPE - Static variable in class net.adamcin.oakpal.core.checks.ExpectAces

Deprecated.

AcHandling - Class in net.adamcin.oakpal.core.checks

Limit package acHandling mode to prevent unforeseen changes to ACLs upon installation.

AcHandling() - Constructor for class net.adamcin.oakpal.core.checks.AcHandling

AcHandling.ACHandlingLevelSet - Enum in net.adamcin.oakpal.core.checks

Encapsulation of incrementally wider sets of forbidden acHandling modes as discrete levels.

AcHandling.JsonKeys - Interface in net.adamcin.oakpal.core.checks

adaptName(NamespaceMapping, QName.Type, Name) - Static method in class net.adamcin.oakpal.webster.QName

adaptToQ(Session) - Static method in class net.adamcin.oakpal.core.JsonCnd

Function to adapt a Session-linked NodeTypeDefinition as a qualified node type definition for writing to JSON.

add(IO<T>) - Method in interface net.adamcin.oakpal.cli.IO

addInstallableNode(PackageId, Node) - Method in interface net.adamcin.oakpal.api.SlingSimulator

Submit resource path for installation as an embedded FileVault package or other Sling installable, generally located under /apps/.

addInstallableNode(PackageId, Node) - Method in class net.adamcin.oakpal.core.sling.DefaultSlingSimulator

addInstallableNode(PackageId, Node) - Method in class net.adamcin.oakpal.core.sling.NoopSlingSimulator

AdhocOpear - Class in net.adamcin.oakpal.core.opear

Simpler opear implementation for CLI and other runtime-generated contexts.

AdhocOpear(URL, URL) - Constructor for class net.adamcin.oakpal.core.opear.AdhocOpear

adminInitAndInspect(OakMachine.InspectBody<E>) - Method in class net.adamcin.oakpal.core.OakMachine

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

afterExtract(PackageId, Session) - Method in interface net.adamcin.oakpal.api.ProgressCheck

Provides an opportunity to inspect repository state between packages.

afterExtract(PackageId, Session) - Method in class net.adamcin.oakpal.core.checks.Echo

afterExtract(PackageId, Session) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

afterPackageIdRules() - Method in interface net.adamcin.oakpal.core.checks.ExpectAces.JsonKeys

afterPackageIdRules() - Method in interface net.adamcin.oakpal.core.checks.ExpectPaths.JsonKeys

afterScanPackage(PackageId, Session) - Method in interface net.adamcin.oakpal.api.ProgressCheck

Provides an opportunity to inspect repository state after complete installation (including its content, subpackages, and Sling installable paths) of a package explicitly listed for scanning.

afterScanPackage(PackageId, Session) - Method in class net.adamcin.oakpal.core.checks.Echo

afterScanPackage(PackageId, Session) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

aggregateNodeTypes(NamespaceMapping, List<NodeTypeSet>) - Static method in class net.adamcin.oakpal.core.JsonCnd

Aggregate a list of NodeTypeSets into a single NodeTypeSet.

allowedModes() - Method in interface net.adamcin.oakpal.core.checks.AcHandling.JsonKeys

allowEmptyFilter() - Method in interface net.adamcin.oakpal.core.checks.FilterSets.JsonKeys

allowRootFilter() - Method in interface net.adamcin.oakpal.core.checks.FilterSets.JsonKeys

and(Object...) - Method in class net.adamcin.oakpal.api.JavaxJson.Arr

and(JavaxJson.Key...) - Method in class net.adamcin.oakpal.api.JavaxJson.Obj

Append more JavaxJson.Key instances.

and(Map<?, ?>) - Method in class net.adamcin.oakpal.api.JavaxJson.Obj

Append the entries in map as JavaxJson.Key instances.

ApiConstants - Class in net.adamcin.oakpal.api

Hosts constants as static singleton getter methods defined by interfaces.

ApiConstants.ViolationKeys - Interface in net.adamcin.oakpal.api

Json key constant accessors for violations.

appliedRepoInitScripts(PackageId, List<String>, SlingInstallable, Session) - Method in interface net.adamcin.oakpal.api.ProgressCheck

Provides an opportunity to inspect repository state after installing a RepoInit scripts resource submitted to the SlingSimulator.

appliedRepoInitScripts(PackageId, List<String>, SlingInstallable, Session) - Method in class net.adamcin.oakpal.core.checks.Echo

appliedRepoInitScripts(PackageId, List<String>, SlingInstallable, Session) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

apply(Session, Reader) - Method in interface net.adamcin.oakpal.core.OakMachine.RepoInitProcessor

apply() - Method in interface net.adamcin.oakpal.testing.TestUtil.TestBody

ARCHIVE_TYPE - Static variable in class net.adamcin.oakpal.maven.mojo.OpearPackageMojo.OpearArchiver

ArchiveAware - Interface in net.adamcin.oakpal.webster

Interface that allows the WebsterPlan to provide a WebsterTarget with a fresh FileVault Archive to traverse.

arr(Object...) - Static method in class net.adamcin.oakpal.api.JavaxJson

Creates an array with the provided values.

arrayOrEmpty(JsonObject, String) - Static method in class net.adamcin.oakpal.api.JavaxJson

Retrieve a value as an array, or return the empty array if key is not present or if the value is the wrong type.

arrKeys() - Method in class net.adamcin.oakpal.api.JavaxJson.Obj

Transform to an array consisting of the object keys, un-deduplicated.

arrVals() - Method in class net.adamcin.oakpal.api.JavaxJson.Obj

Transform to an array consisting of the object values.

asInitStage() - Method in class net.adamcin.oakpal.core.Checklist

AUTOMATIC_MODULE_NAME - Static variable in class net.adamcin.oakpal.core.ChecklistPlanner

B

BASIC_PLAN_URL - Static variable in class net.adamcin.oakpal.core.OakpalPlan

Preferred default plan when no custom classpath is specified, and no plan name is specified.

beforeExtract(PackageId, Session, PackageProperties, MetaInf, List<PackageId>) - Method in interface net.adamcin.oakpal.api.ProgressCheck

Called for each package before it is extracted.

beforeExtract(PackageId, Session, PackageProperties, MetaInf, List<PackageId>) - Method in class net.adamcin.oakpal.core.checks.Echo

beforeExtract(PackageId, Session, PackageProperties, MetaInf, List<PackageId>) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

beforeSlingInstall(PackageId, SlingInstallable, Session) - Method in interface net.adamcin.oakpal.api.ProgressCheck

Provides an opportunity to inspect repository state before installing a resource submitted to the SlingSimulator.

beforeSlingInstall(PackageId, SlingInstallable, Session) - Method in class net.adamcin.oakpal.core.checks.Echo

beforeSlingInstall(PackageId, SlingInstallable, Session) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

BINDING_CHECK_CONFIG - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

BINDING_SCRIPT_HELPER - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

bindParser(RepoInitParser) - Static method in class net.adamcin.oakpal.core.repoinit.DefaultRepoInitFactory

build() - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder

Build a simple violation.

build() - Method in class net.adamcin.oakpal.core.InitStage.Builder

Construct an InitStage from the InitStage.Builder state.

build() - Method in class net.adamcin.oakpal.core.NamespaceMappingRequest.Builder

Build the NamespaceMappingRequest.

build() - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Construct a OakMachine from the OakMachine.Builder state.

build() - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

build() - Method in class net.adamcin.oakpal.webster.ChecklistExporter.Builder

Create the new exporter instance.

build() - Method in class net.adamcin.oakpal.webster.CndExporter.Builder

build() - Method in class net.adamcin.oakpal.webster.WebsterPlan.Builder

builder() - Static method in class net.adamcin.oakpal.api.SimpleViolation

Use this builder method to more easily construct a violation with MessageFormat arguments.

builder(ResourceBundle) - Static method in class net.adamcin.oakpal.api.SimpleViolation

Use this builder method to more easily construct a violation with MessageFormat arguments.

Builder() - Constructor for class net.adamcin.oakpal.core.InitStage.Builder

Builder() - Constructor for class net.adamcin.oakpal.core.NamespaceMappingRequest.Builder

Builder() - Constructor for class net.adamcin.oakpal.core.OakMachine.Builder

Builder(URL, String) - Constructor for class net.adamcin.oakpal.core.OakpalPlan.Builder

Builder() - Constructor for class net.adamcin.oakpal.webster.ChecklistExporter.Builder

Builder() - Constructor for class net.adamcin.oakpal.webster.CndExporter.Builder

Builder() - Constructor for class net.adamcin.oakpal.webster.WebsterPlan.Builder

buildJarFromDir(File, File, Map<String, File>) - Static method in class net.adamcin.oakpal.testing.TestPackageUtil

BUILTIN_MAPPINGS - Static variable in class net.adamcin.oakpal.core.JsonCnd

BUILTIN_NODETYPES - Static variable in class net.adamcin.oakpal.core.JsonCnd

BUILTIN_NODETYPES - Static variable in class net.adamcin.oakpal.webster.CndExporter

BUILTIN_PRIVILEGES - Static variable in class net.adamcin.oakpal.core.JsonCnd

BUNDLE_SYMBOLICNAME - Static variable in class net.adamcin.oakpal.core.ChecklistPlanner

byName(String) - Static method in enum net.adamcin.oakpal.api.Severity

Runtime throwing function to lookup severity codes by name.

byName(String) - Static method in enum net.adamcin.oakpal.webster.ChecklistExporter.ForcedRootUpdatePolicy

byName(String) - Static method in enum net.adamcin.oakpal.webster.ChecklistExporter.SelectorType

byNodeType(String...) - Method in class net.adamcin.oakpal.webster.ChecklistExporter.Builder

Add an operation to export a set of roots returned by a nodetype query.

byPath(String...) - Method in class net.adamcin.oakpal.webster.ChecklistExporter.Builder

Add an operation to export a set of roots by individual paths.

byQuery(String) - Method in class net.adamcin.oakpal.webster.ChecklistExporter.Builder

Add an operation to export a set of roots returned by the specified JCR query.

byType(String) - Static method in enum net.adamcin.oakpal.webster.targets.JsonTargetFactory

C

canConvert(Class<?>) - Method in class net.adamcin.oakpal.maven.component.JsonConverter

canGetItem() - Method in enum net.adamcin.oakpal.api.PathAction

Returns true if it is safe to get the item at the referenced path based on this action type.

Checklist - Class in net.adamcin.oakpal.core

It's a list of checks, along with initStage properties allowing jars to share CNDs, JCR namespaces and privileges, and forced roots.

Checklist.JsonKeys - Interface in net.adamcin.oakpal.core

Json keys for Checklist.

ChecklistExporter - Class in net.adamcin.oakpal.webster

Exports namespaces, node types, and ForcedRoots from a JCR session to assist with project checklist management.

ChecklistExporter.Builder - Class in net.adamcin.oakpal.webster

Builder for a ChecklistExporter, which is otherwise immutable.

ChecklistExporter.ForcedRootUpdatePolicy - Enum in net.adamcin.oakpal.webster

ChecklistExporter.SelectorType - Enum in net.adamcin.oakpal.webster

ChecklistExporter.WriterOpener - Interface in net.adamcin.oakpal.webster

Function type that provides a Writer.

ChecklistPlanner - Class in net.adamcin.oakpal.core

Discoverer of checklists and computer of checkSpecs.

ChecklistPlanner(List<String>) - Constructor for class net.adamcin.oakpal.core.ChecklistPlanner

checklists() - Method in interface net.adamcin.oakpal.core.OakpalPlan.JsonKeys

checkName() - Method in interface net.adamcin.oakpal.core.CoreConstants.CheckReportKeys

checkName() - Method in interface net.adamcin.oakpal.core.ReportMapper.JsonKeys

CheckReport - Interface in net.adamcin.oakpal.core

Type for collected Violations from a particlular ProgressCheck.

checkReportKeys() - Static method in class net.adamcin.oakpal.core.CoreConstants

checks() - Method in interface net.adamcin.oakpal.core.Checklist.JsonKeys

checks() - Method in interface net.adamcin.oakpal.core.OakpalPlan.JsonKeys

CheckSpec - Class in net.adamcin.oakpal.core

DTO for full-featured check spec.

CheckSpec() - Constructor for class net.adamcin.oakpal.core.CheckSpec

CheckSpec.ImmutableSpec - Class in net.adamcin.oakpal.core

This is an Immutable variant of CheckSpec for composition in Checklist.

CheckSpec.JsonKeys - Interface in net.adamcin.oakpal.core

Json keys for CheckSpec.

clearViolations() - Method in class net.adamcin.oakpal.api.ReportCollector

CliArgParser - Class in net.adamcin.oakpal.webster

Simple parser for reliably turning a single property String value into an array of String arguments for passing to CLI parsers, like oak-run's.

CndExporter - Class in net.adamcin.oakpal.webster

Interface independent logic for exporting .cnd files from a JCR session.

CndExporter.Builder - Class in net.adamcin.oakpal.webster

CndExporter.WriterOpener - Interface in net.adamcin.oakpal.webster

Function type that provides a Writer.

cndNames() - Method in interface net.adamcin.oakpal.core.Checklist.JsonKeys

cndUrls() - Method in interface net.adamcin.oakpal.core.Checklist.JsonKeys

collector - Variable in class net.adamcin.oakpal.api.SimpleProgressCheck

combine(Nothing) - Method in class net.adamcin.oakpal.api.Nothing

compareTo(ForcedRoot) - Method in class net.adamcin.oakpal.core.ForcedRoot

compareTo(JcrNs) - Method in class net.adamcin.oakpal.core.JcrNs

comparingJsonKeys(Function<T, String>) - Static method in class net.adamcin.oakpal.core.Checklist

compose(Function<T, I>, Function<I, R>) - Static method in class net.adamcin.oakpal.core.Util

Deprecated.

1.3.0 use Fun.compose1(Function, Function) instead

compose0(Supplier<? extends R>, Function<? super R, ? extends S>) - Static method in class net.adamcin.oakpal.api.Fun

Compose a Supplier with a Function that maps the original supplied type to a new supplied type.

compose1(Function<T, ? extends I>, Function<? super I, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Essentially the same as calling Function.andThen(Function), except needing no cast for a method reference as the before argument, resulting in function composition of before followed by after.

compose2(BiFunction<K, V, ? extends I>, Function<? super I, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Essentially the same as calling BiFunction.andThen(Function), except needing no cast for a method reference as the before argument, resulting in function composition of before followed by after.

composeTest1(Function<? super T, ? extends P>, Predicate<? super P>) - Static method in class net.adamcin.oakpal.api.Fun

Compose a Predicate with a preceding input Function that maps the stream element type to the input type of the Predicate.

composeTest2(Function<? super K, ? extends P>, Function<? super V, ? extends Q>, BiPredicate<? super P, ? super Q>) - Static method in class net.adamcin.oakpal.api.Fun

Compose a BiPredicate with preceding left and right input Functions that map the stream Entry element key and value types to the respective input type of the provided BiPredicate.

composeTest2(BiFunction<? super K, ? super V, ? extends P>, Predicate<? super P>) - Static method in class net.adamcin.oakpal.api.Fun

Compose a BiPredicate with a single preceding BiFunction that maps the stream Entry element key and value types to the input type of the provided Predicate.

composeTry(Function<R, M>, Supplier<M>, Util.TryFunction<T, R>, BiConsumer<T, Exception>) - Static method in class net.adamcin.oakpal.core.Util

Deprecated.

1.3.0 use Fun.composeTry1(Function, Supplier, Fun.ThrowingFunction, BiConsumer)

composeTry0(Function<? super R, ? extends M>, Supplier<? extends M>, Fun.ThrowingSupplier<? extends R>, Consumer<? super Exception>) - Static method in class net.adamcin.oakpal.api.Fun

Composes four lambdas into a single supplier for use with flatMap() defined by Stream, Optional, etc.

composeTry0(Function<? super R, ? extends M>, Function<? super Exception, ? extends M>, Fun.ThrowingSupplier<? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Composes four lambdas into a single supplier for use with flatMap() defined by Stream, Optional, etc.

composeTry1(Function<? super R, ? extends M>, Supplier<? extends M>, Fun.ThrowingFunction<? super T, ? extends R>, BiConsumer<? super T, ? super Exception>) - Static method in class net.adamcin.oakpal.api.Fun

Composes four lambdas into a single function for use with flatMap() defined by Stream, Optional, etc.

composeTry1(Function<? super R, ? extends M>, Function<? super Exception, ? extends M>, Fun.ThrowingFunction<? super T, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Composes four lambdas into a single function for use with flatMap() defined by Stream, Optional, etc.

composeTry2(Function<? super R, ? extends M>, Supplier<? extends M>, Fun.ThrowingBiFunction<? super K, ? super V, ? extends R>, BiConsumer<? super Map.Entry<? super K, ? super V>, ? super Exception>) - Static method in class net.adamcin.oakpal.api.Fun

Composes four lambdas into a single bifunction for use with flatMap() defined by Stream, Optional, etc.

composeTry2(Function<? super R, ? extends M>, Function<? super Exception, ? extends M>, Fun.ThrowingBiFunction<? super K, ? super V, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Composes four lambdas into a single function for use with flatMap() defined by Stream, Optional, etc.

CompositeStoreAlignment - Class in net.adamcin.oakpal.core.checks

Report packages which affect paths in more than one composite node store.

CompositeStoreAlignment() - Constructor for class net.adamcin.oakpal.core.checks.CompositeStoreAlignment

CompositeStoreAlignment.JsonKeys - Interface in net.adamcin.oakpal.core.checks

config() - Method in interface net.adamcin.oakpal.core.CheckSpec.JsonKeys

CONFIG_AFTER_PACKAGE_ID_RULES - Static variable in class net.adamcin.oakpal.core.checks.ExpectAces

Deprecated.

CONFIG_AFTER_PACKAGE_ID_RULES - Static variable in class net.adamcin.oakpal.core.checks.ExpectPaths

Deprecated.

CONFIG_ALLOW_EMPTY_FILTER - Static variable in class net.adamcin.oakpal.core.checks.FilterSets

Deprecated.

CONFIG_ALLOW_ROOT_FILTER - Static variable in class net.adamcin.oakpal.core.checks.FilterSets

Deprecated.

CONFIG_ALLOWED_MODES - Static variable in class net.adamcin.oakpal.core.checks.AcHandling

Deprecated.

CONFIG_DENY_ALL - Static variable in class net.adamcin.oakpal.core.checks.Subpackages

Deprecated.

CONFIG_DENY_ALL_DELETES - Static variable in class net.adamcin.oakpal.core.checks.Paths

Deprecated.

CONFIG_DENY_IF_ABSENT - Static variable in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

Deprecated.

CONFIG_DENY_IF_MULTIVALUED - Static variable in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

Deprecated.

CONFIG_DENY_IF_PRESENT - Static variable in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

Deprecated.

CONFIG_DENY_NODE_TYPES - Static variable in class net.adamcin.oakpal.core.checks.JcrProperties

Deprecated.

CONFIG_EXPECTED_ACES - Static variable in class net.adamcin.oakpal.core.checks.ExpectAces

Deprecated.

CONFIG_EXPECTED_PATHS - Static variable in class net.adamcin.oakpal.core.checks.ExpectPaths

Deprecated.

CONFIG_IMPORT_MODE_SEVERITY - Static variable in class net.adamcin.oakpal.core.checks.FilterSets

Deprecated.

CONFIG_LEVEL_SET - Static variable in class net.adamcin.oakpal.core.checks.AcHandling

Deprecated.

CONFIG_MOUNTS - Static variable in class net.adamcin.oakpal.core.checks.CompositeStoreAlignment

Deprecated.

CONFIG_NAME - Static variable in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

Deprecated.

CONFIG_NOT_EXPECTED_ACES - Static variable in class net.adamcin.oakpal.core.checks.ExpectAces

Deprecated.

CONFIG_NOT_EXPECTED_PATHS - Static variable in class net.adamcin.oakpal.core.checks.ExpectPaths

Deprecated.

CONFIG_PRINCIPAL - Static variable in class net.adamcin.oakpal.core.checks.ExpectAces

Deprecated.

CONFIG_PRINCIPALS - Static variable in class net.adamcin.oakpal.core.checks.ExpectAces

Deprecated.

CONFIG_PROPERTIES - Static variable in class net.adamcin.oakpal.core.checks.JcrProperties

Deprecated.

CONFIG_REPORT_ALL_OVERLAPS - Static variable in class net.adamcin.oakpal.core.checks.Overlaps

Deprecated.

CONFIG_REQUIRE_TYPE - Static variable in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

Deprecated.

CONFIG_RULES - Static variable in class net.adamcin.oakpal.core.checks.Paths

Deprecated.

CONFIG_RULES - Static variable in class net.adamcin.oakpal.core.checks.Subpackages

Deprecated.

CONFIG_SCOPE_NODE_TYPES - Static variable in class net.adamcin.oakpal.core.checks.JcrProperties

Deprecated.

CONFIG_SCOPE_PACKAGE_IDS - Static variable in class net.adamcin.oakpal.core.checks.CompositeStoreAlignment

Deprecated.

CONFIG_SCOPE_PATHS - Static variable in class net.adamcin.oakpal.core.checks.JcrProperties

Deprecated.

CONFIG_SCRIPTS - Static variable in class net.adamcin.oakpal.core.sling.SlingRepoInitScripts

CONFIG_SEVERITY - Static variable in class net.adamcin.oakpal.core.checks.CompositeStoreAlignment

Deprecated.

CONFIG_SEVERITY - Static variable in class net.adamcin.oakpal.core.checks.ExpectPaths

Deprecated.

CONFIG_SEVERITY - Static variable in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

Deprecated.

CONFIG_SEVERITY - Static variable in class net.adamcin.oakpal.core.checks.Paths

Deprecated.

CONFIG_VALUE_RULES - Static variable in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

Deprecated.

Console - Interface in net.adamcin.oakpal.cli

Abstraction of standard CLI environment I/O channels.

constantly1(Supplier<? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Fits a supplier into a pipeline as a constant Function.

constantly2(Supplier<? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Fits a supplier into a pipeline as a constant BiFunction.

constructChecklists(Map<URL, List<JsonObject>>) - Static method in class net.adamcin.oakpal.core.ChecklistPlanner

convertChild(PlexusConfiguration, ExpressionEvaluator) - Method in class net.adamcin.oakpal.maven.component.JsonConverter

Perform type inference and delegate conversion appropriately.

copyOf(CheckSpec) - Static method in class net.adamcin.oakpal.core.CheckSpec

CoreConstants - Class in net.adamcin.oakpal.core

Hosts constants for interface types as static singleton getter methods defined by associated interfaces.

CoreConstants.CheckReportKeys - Interface in net.adamcin.oakpal.core

Json keys for CheckReport.

COVARIANT_PREFIX - Static variable in class net.adamcin.oakpal.webster.ChecklistExporter

create(String, String) - Static method in class net.adamcin.oakpal.core.JcrNs

Create a new JcrNs with both values set.

createBlob(InputStream) - Method in class net.adamcin.oakpal.core.FileBlobMemoryNodeStore

createContainerClassLoader() - Method in interface net.adamcin.oakpal.maven.mojo.MojoWithRepositoryParams

Creates a classloader for execution of oakpal logic.

createInlineScriptCheckFactory(String, String) - Static method in class net.adamcin.oakpal.core.ScriptProgressCheck

createInstallable(PackageId, String) - Method in class net.adamcin.oakpal.core.sling.EmbeddedPackageInstallableParams

createInstallable(PackageId, String) - Method in class net.adamcin.oakpal.core.sling.OsgiConfigInstallableParams

createInstallable(PackageId, String) - Method in interface net.adamcin.oakpal.core.sling.SlingInstallableParams

Create a SlingInstallable from these parameters.

createScriptCheckFactory(URL) - Static method in class net.adamcin.oakpal.core.ScriptProgressCheck

createScriptCheckFactory(String, URL) - Static method in class net.adamcin.oakpal.core.ScriptProgressCheck

createScriptCheckFactory(ScriptEngine, URL) - Static method in class net.adamcin.oakpal.core.ScriptProgressCheck

createTarget(File, JsonObject) - Method in enum net.adamcin.oakpal.webster.targets.JsonTargetFactory

createTarget(File, JsonObject) - Method in interface net.adamcin.oakpal.webster.WebsterTargetFactory

customize(Jcr) - Method in interface net.adamcin.oakpal.core.OakMachine.JcrCustomizer

D

debugFilter(Logger, String) - Static method in class net.adamcin.oakpal.core.Util

Logger function to inject into a stream by way of filter() method.

DEFAULT - Static variable in enum net.adamcin.oakpal.core.InstallHookPolicy

DEFAULT_ALLOW - Static variable in class net.adamcin.oakpal.api.Rules

A default ALLOW rule that matches everything.

DEFAULT_DENY - Static variable in class net.adamcin.oakpal.api.Rules

A default DENY rule that matches everything.

DEFAULT_EXCLUDE - Static variable in class net.adamcin.oakpal.api.Rules

A default EXCLUDE rule that matches everything.

DEFAULT_IMPORT_MODE_SEVERITY - Static variable in class net.adamcin.oakpal.core.checks.FilterSets

DEFAULT_INCLUDE - Static variable in class net.adamcin.oakpal.api.Rules

A default INCLUDE rule that matches everything.

DEFAULT_PLAN_NAME - Static variable in class net.adamcin.oakpal.core.OakpalPlan

When otherwise unspecified, the default name for a plan should be plan.json.

DEFAULT_SCRIPT_ENGINE_EXTENSION - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

DEFAULT_SEVERITY - Static variable in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

DEFAULT_SEVERITY - Static variable in class net.adamcin.oakpal.core.checks.Paths

DEFAULT_UPDATE_POLICY - Static variable in class net.adamcin.oakpal.webster.ChecklistExporter

DefaultErrorListener - Class in net.adamcin.oakpal.core

Default implementation which reports all exceptions as violations.

DefaultErrorListener() - Constructor for class net.adamcin.oakpal.core.DefaultErrorListener

DefaultRepoInitFactory - Class in net.adamcin.oakpal.core.repoinit

Default provider for RepoInitProcessors.

DefaultSlingSimulator - Class in net.adamcin.oakpal.core.sling

Noop implementation of a SlingSimulator.

DefaultSlingSimulator() - Constructor for class net.adamcin.oakpal.core.sling.DefaultSlingSimulator

deletedPath(PackageId, String, Session) - Method in interface net.adamcin.oakpal.api.ProgressCheck

Notified when package importer deletes an existing node.

deletedPath(PackageId, String, Session) - Method in class net.adamcin.oakpal.core.checks.Echo

deletedPath(PackageId, String, Session) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

deleteTestPackage(String) - Static method in class net.adamcin.oakpal.testing.TestPackageUtil

DELIM_LIST - Static variable in class net.adamcin.oakpal.core.checks.ExpectAces

DELIM_PARAM - Static variable in class net.adamcin.oakpal.core.checks.ExpectAces

DELIM_VALUE - Static variable in class net.adamcin.oakpal.core.checks.ExpectAces

denyAll() - Method in interface net.adamcin.oakpal.core.checks.Subpackages.JsonKeys

denyAllDeletes() - Method in interface net.adamcin.oakpal.core.checks.Paths.JsonKeys

denyIfAbsent() - Method in interface net.adamcin.oakpal.core.checks.JcrPropertyConstraints.JsonKeys

denyIfMultivalued() - Method in interface net.adamcin.oakpal.core.checks.JcrPropertyConstraints.JsonKeys

denyIfPresent() - Method in interface net.adamcin.oakpal.core.checks.JcrPropertyConstraints.JsonKeys

denyNodeTypes() - Method in interface net.adamcin.oakpal.core.checks.JcrProperties.JsonKeys

DependencyFilter - Class in net.adamcin.oakpal.maven.mojo

Simple pojo for matching resolved dependencies based on limited coordinate specification.

DependencyFilter() - Constructor for class net.adamcin.oakpal.maven.mojo.DependencyFilter

depToArtifact(Dependency, RepositoryRequest, boolean) - Method in interface net.adamcin.oakpal.maven.mojo.MojoWithRepositoryParams

dequeueInstallable() - Method in class net.adamcin.oakpal.core.sling.DefaultSlingSimulator

dequeueInstallable() - Method in class net.adamcin.oakpal.core.sling.NoopSlingSimulator

dequeueInstallable() - Method in interface net.adamcin.oakpal.core.sling.SlingSimulatorBackend

Get the next installable path and remove from the queue.

description() - Method in interface net.adamcin.oakpal.api.ApiConstants.ViolationKeys

discoverChecklists() - Method in class net.adamcin.oakpal.core.ChecklistPlanner

discoverChecklists(ClassLoader) - Method in class net.adamcin.oakpal.core.ChecklistPlanner

discoverChecklists(List<File>) - Method in class net.adamcin.oakpal.core.ChecklistPlanner

DisposablePrinter - Interface in net.adamcin.oakpal.cli

Extension of simple IO printer function type to add a dispose() method.

dispose() - Method in interface net.adamcin.oakpal.cli.Console

Dispose open printers.

dispose() - Method in interface net.adamcin.oakpal.cli.DisposablePrinter

E

Echo - Class in net.adamcin.oakpal.core.checks

Simple verbose package check that logs all scan events to standard out.

Echo() - Constructor for class net.adamcin.oakpal.core.checks.Echo

echo(String, Object...) - Method in class net.adamcin.oakpal.core.checks.Echo

Override this method to use a logger instead of System.out, for example.

editJson(JsonObjectBuilder) - Method in class net.adamcin.oakpal.core.CheckSpec

Override to ensure subtype details are retained in JSON.

EmbeddedPackageInstallable - Class in net.adamcin.oakpal.api

An installable path identified as an embedded package.

EmbeddedPackageInstallable(PackageId, String, PackageId) - Constructor for class net.adamcin.oakpal.api.EmbeddedPackageInstallable

Constructor.

EmbeddedPackageInstallableParams - Class in net.adamcin.oakpal.core.sling

EmbeddedPackageInstallableParams(PackageId) - Constructor for class net.adamcin.oakpal.core.sling.EmbeddedPackageInstallableParams

empty - Static variable in interface net.adamcin.oakpal.cli.IO

EMPTY_PLAN_URL - Static variable in class net.adamcin.oakpal.core.OakpalPlan

Preferred default plan when a custom classpath is specified without specifying a plan name.

enablePreInstallHooks() - Method in interface net.adamcin.oakpal.core.OakpalPlan.JsonKeys

entriesToMap() - Static method in class net.adamcin.oakpal.api.Fun

Shorthand for Collectors.toMap(Function, Function) for collecting streams of Map.Entry, except using Fun.keepLastMerger() as the merge function, and LinkedHashMap as the supplied map type.

entriesToMap(BinaryOperator<V>) - Static method in class net.adamcin.oakpal.api.Fun

Shorthand for Collectors.toMap(Function, Function, BinaryOperator, Supplier) for collecting streams of Map.Entry, except using LinkedHashMap as the supplied map type.

entriesToMapOfType(Supplier<Map<K, V>>) - Static method in class net.adamcin.oakpal.api.Fun

Shorthand for Collectors.toMap(Function, Function, BinaryOperator, Supplier) for collecting streams of Map.Entry, except using Fun.keepLastMerger() as the merge function.

entriesToMapOfType(Supplier<Map<K, V>>, BinaryOperator<V>) - Static method in class net.adamcin.oakpal.api.Fun

Shorthand for Collectors.toMap(Function, Function, BinaryOperator, Supplier) for collecting streams of Map.Entry.

entryTee(BiConsumer<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun

Like Fun.tee(Consumer), this method transforms a BiConsumer into a "tee" (like the Unix command, evoking the shape of the letter, 'T') function for Map.Entry streams, that passes the input entry to output after calling BiConsumer.accept(Object, Object) with the input entry key and value.

ENV_OAKPAL_OPEAR - Static variable in interface net.adamcin.oakpal.cli.Console

equals(Object) - Method in class net.adamcin.oakpal.api.EmbeddedPackageInstallable

equals(Object) - Method in class net.adamcin.oakpal.api.Rule

equals(Object) - Method in class net.adamcin.oakpal.api.SimpleViolation

equals(Object) - Method in class net.adamcin.oakpal.core.CheckSpec

equals(Object) - Method in class net.adamcin.oakpal.core.ForcedRoot

equals(Object) - Method in class net.adamcin.oakpal.core.JcrNs

equals(Object) - Method in class net.adamcin.oakpal.core.SimpleReport

equals(Object) - Method in class net.adamcin.oakpal.webster.QName

ErrorListener - Interface in net.adamcin.oakpal.core

A single error handler is used during an OakPAL scan.

escapeManifestHeaderValue(String...) - Static method in class net.adamcin.oakpal.core.Util

escapeManifestHeaderValues(List<String>) - Static method in class net.adamcin.oakpal.core.Util

execute() - Method in class net.adamcin.oakpal.maven.mojo.HelpMojo

execute() - Method in class net.adamcin.oakpal.maven.mojo.OpearPackageMojo

execute() - Method in class net.adamcin.oakpal.maven.mojo.OpearPlanMojo

execute() - Method in class net.adamcin.oakpal.maven.mojo.WebsterMojo

executeGuardedIntegrationTest() - Method in class net.adamcin.oakpal.maven.mojo.ScanArtifactMojo

executeGuardedIntegrationTest() - Method in class net.adamcin.oakpal.maven.mojo.ScanManyArtifactsMojo

ExpectAces - Class in net.adamcin.oakpal.core.checks

ExpectAces: assert the existence or non-existence of specific access control entries after extracting a package.

ExpectAces() - Constructor for class net.adamcin.oakpal.core.checks.ExpectAces

ExpectAces.JsonKeys - Interface in net.adamcin.oakpal.core.checks

expectedAces() - Method in interface net.adamcin.oakpal.core.checks.ExpectAces.JsonKeys

expectedPaths() - Method in interface net.adamcin.oakpal.core.checks.ExpectPaths.JsonKeys

ExpectPaths - Class in net.adamcin.oakpal.core.checks

ExpectPaths: assert the existence or non-existence of specific repository item paths after extracting a package.

ExpectPaths() - Constructor for class net.adamcin.oakpal.core.checks.ExpectPaths

ExpectPaths.JsonKeys - Interface in net.adamcin.oakpal.core.checks

F

failure(String) - Static method in class net.adamcin.oakpal.api.Result

failure(Exception) - Static method in class net.adamcin.oakpal.api.Result

failure(String, Exception) - Static method in class net.adamcin.oakpal.api.Result

failure(RuntimeException) - Static method in class net.adamcin.oakpal.api.Result

FileBlobMemoryNodeStore - Class in net.adamcin.oakpal.core

A MemoryNodeStore that offloads binaries to a FileBlobStore.

FileBlobMemoryNodeStore(String) - Constructor for class net.adamcin.oakpal.core.FileBlobMemoryNodeStore

FILENAME_INLINE_SCRIPT - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

FileVaultNameFinder - Class in net.adamcin.oakpal.webster

FileVaultNameFinder() - Constructor for class net.adamcin.oakpal.webster.FileVaultNameFinder

FilterSets - Class in net.adamcin.oakpal.core.checks

Sanity check for WorkspaceFilter.

FilterSets() - Constructor for class net.adamcin.oakpal.core.checks.FilterSets

FilterSets.JsonKeys - Interface in net.adamcin.oakpal.core.checks

findCause(Predicate<? super Throwable>) - Method in class net.adamcin.oakpal.api.Result

Filters the exception stack as a stream using the provided Throwable predicate.

findCause(Class<E>) - Method in class net.adamcin.oakpal.api.Result

Filters the exception stack as a stream, matching causes against the provided error type.

findNodeTypeDefinitions() - Static method in class net.adamcin.oakpal.core.SlingNodetypesScanner

Find all node type definition classpath paths by searching all MANIFEST.MF files in the classpath and reading the paths from the "Sling-Nodetypes" entry.

findNodeTypeDefinitions(ClassLoader) - Static method in class net.adamcin.oakpal.core.SlingNodetypesScanner

Find all node type definition classpath paths by searching all MANIFEST.MF files in the classpath and reading the paths from the "Sling-Nodetypes" entry.

findNodeTypeDefinitions(List<File>) - Static method in class net.adamcin.oakpal.core.SlingNodetypesScanner

Find all node type definition classpath paths by searching all MANIFEST.MF files in the classpath and reading the paths from the "Sling-Nodetypes" entry.

findRoots(Session) - Method in class net.adamcin.oakpal.webster.ChecklistExporter

Perform all retrieval operations against the provided session.

finishedScan() - Method in interface net.adamcin.oakpal.api.ScanListener

Called once at the end of the scan to notify for cleanup of resources.

finishedScan() - Method in class net.adamcin.oakpal.core.checks.Echo

finishedScan() - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

flatMap(Function<? super V, Result<W>>) - Method in class net.adamcin.oakpal.api.Result

Flat-map it.

flatMap(Function<A, IO<B>>) - Method in interface net.adamcin.oakpal.cli.IO

ForcedRoot - Class in net.adamcin.oakpal.core

Encapsulation of details necessary to force creation of a particular root path.

ForcedRoot() - Constructor for class net.adamcin.oakpal.core.ForcedRoot

ForcedRoot.JsonKeys - Interface in net.adamcin.oakpal.core

Json keys for ForcedRoot.

forcedRoots() - Method in interface net.adamcin.oakpal.core.Checklist.JsonKeys

forcedRoots() - Method in interface net.adamcin.oakpal.core.OakpalPlan.JsonKeys

forEach(Consumer<? super V>) - Method in class net.adamcin.oakpal.api.Result

Standard forEach method calling a consumer to accept the value.

forName(String) - Static method in enum net.adamcin.oakpal.core.InstallHookPolicy

fromConfiguration(ConverterLookup, PlexusConfiguration, Class<?>, Class<?>, ClassLoader, ExpressionEvaluator, ConfigurationListener) - Method in class net.adamcin.oakpal.maven.component.JsonConverter

fromDirectory(File) - Static method in class net.adamcin.oakpal.core.opear.OpearFile

fromJar(JarFile, File) - Static method in class net.adamcin.oakpal.core.opear.OpearFile

fromJson(JsonObject) - Static method in class net.adamcin.oakpal.api.Rules

Construct a single rule from a JSON object with keys type and pattern.

fromJson(JsonObject) - Static method in class net.adamcin.oakpal.api.SimpleViolation

fromJson(String, URL, JsonObject) - Static method in class net.adamcin.oakpal.core.Checklist

Create a Checklist from a JsonObject.

fromJson(Supplier<ResourceBundle>) - Static method in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

fromJson(JsonObject) - Static method in class net.adamcin.oakpal.core.CheckSpec

Build a CheckSpec from a Checklist json snippet.

fromJson(JsonObject) - Static method in class net.adamcin.oakpal.core.ForcedRoot

Map a JSON object to a ForcedRoot.

fromJson(JsonObject) - Static method in class net.adamcin.oakpal.core.JcrNs

Map a JSON object to a JcrNs.

fromJson(JsonObject) - Static method in class net.adamcin.oakpal.core.OakpalPlan

Constructs an OakpalPlan without a base url or a name.

fromJson(URL) - Static method in class net.adamcin.oakpal.core.OakpalPlan

fromJson(JsonObject) - Static method in class net.adamcin.oakpal.core.SimpleReport

fromJson(File, JsonObject, String) - Static method in enum net.adamcin.oakpal.webster.targets.JsonTargetFactory

fromJsonArray(JsonArray) - Static method in class net.adamcin.oakpal.api.Rules

Conveniently creates a list of Rules from the conventional use case of a JSON array containing a list of rule JSON objects to be evaluated in sequence.

fromJsonArray(Supplier<ResourceBundle>, JsonArray) - Static method in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

fromJsonHintMap(File, JsonObject) - Static method in enum net.adamcin.oakpal.webster.targets.JsonTargetFactory

For convenience, one target of each type is supported at the root of the targets configuration object, with each key referencing the type of the target.

fromName(String) - Static method in enum net.adamcin.oakpal.api.RuleType

fromPlanFile(File, File) - Static method in class net.adamcin.oakpal.core.opear.AdhocOpear

fromReported(Violation) - Static method in class net.adamcin.oakpal.api.SimpleViolation

fromShortCode(String) - Static method in enum net.adamcin.oakpal.api.PathAction

Lookup an action type by the short code.

fromSlingInstallable(SlingInstallable) - Static method in class net.adamcin.oakpal.core.sling.SlingRepoInitScripts

Fun - Class in net.adamcin.oakpal.api

This alphabet soup provides function transformation methods targeting usage within Java 8+ Streams.

Fun.FunRuntimeException - Exception in net.adamcin.oakpal.api

Wrapping runtime error type for unchecked throwing functions.

Fun.ThrowingBiConsumer<K,V> - Interface in net.adamcin.oakpal.api

Inferrable type for BiConsumers that throw.

Fun.ThrowingBiFunction<K,V,R> - Interface in net.adamcin.oakpal.api

Inferrable type for BiFunctions that throw.

Fun.ThrowingBiPredicate<K,V> - Interface in net.adamcin.oakpal.api

Inferrable type for BiPredicates that throw.

Fun.ThrowingConsumer<T> - Interface in net.adamcin.oakpal.api

Inferrable type for Consumers that throw.

Fun.ThrowingFunction<T,R> - Interface in net.adamcin.oakpal.api

Inferrable type for Functions that throw.

Fun.ThrowingPredicate<T> - Interface in net.adamcin.oakpal.api

Inferrable type for Predicates that throw

Fun.ThrowingSupplier<R> - Interface in net.adamcin.oakpal.api

Inferrable type for Suppliers that throw.

fuzzyDefaultAllow(List<Rule>) - Static method in class net.adamcin.oakpal.api.Rules

Return Rules.DEFAULT_ALLOW, unless first element in rules list is an explicit allow, in which case return Rules.DEFAULT_DENY.

fuzzyDefaultDeny(List<Rule>) - Static method in class net.adamcin.oakpal.api.Rules

Return Rules.DEFAULT_DENY, unless first element in rules list is an explicit deny, in which case return Rules.DEFAULT_ALLOW.

fuzzyDefaultExclude(List<Rule>) - Static method in class net.adamcin.oakpal.api.Rules

Return Rules.DEFAULT_EXCLUDE, unless first element in rules list is an explicit exclude, in which case return Rules.DEFAULT_INCLUDE.

fuzzyDefaultInclude(List<Rule>) - Static method in class net.adamcin.oakpal.api.Rules

Return Rules.DEFAULT_INCLUDE, unless first element in rules list is an explicit include, in which case return Rules.DEFAULT_EXCLUDE.

G

generateReport(ProgressCheck) - Static method in class net.adamcin.oakpal.core.SimpleReport

generateReport(ErrorListener) - Static method in class net.adamcin.oakpal.core.SimpleReport

get() - Method in class net.adamcin.oakpal.api.JavaxJson.Arr

get() - Method in interface net.adamcin.oakpal.api.JavaxJson.As

get() - Method in class net.adamcin.oakpal.api.JavaxJson.Key

get() - Method in class net.adamcin.oakpal.api.JavaxJson.Obj

Builds a new JsonObject instance putting all the key value pairs in order.

get() - Method in class net.adamcin.oakpal.api.JavaxJson.Value

getAllowedModes() - Method in enum net.adamcin.oakpal.core.checks.AcHandling.ACHandlingLevelSet

getArtifactId() - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

getBase() - Method in class net.adamcin.oakpal.core.OakpalPlan

getCaliperPackage() - Static method in class net.adamcin.oakpal.testing.TestPackageUtil

getChecklists() - Method in class net.adamcin.oakpal.core.OakpalPlan

getChecklists() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

getChecklists() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

getCheckName() - Method in interface net.adamcin.oakpal.api.ProgressCheck

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

getCheckName() - Method in class net.adamcin.oakpal.api.SimpleProgressCheckFactoryCheck

getCheckName() - Method in interface net.adamcin.oakpal.core.CheckReport

The serialized display name of the package check that created the report.

getCheckName() - Method in class net.adamcin.oakpal.core.checks.Echo

getCheckName() - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

getCheckName() - Method in class net.adamcin.oakpal.core.SimpleReport

getChecks() - Method in class net.adamcin.oakpal.core.Checklist

getChecks() - Method in class net.adamcin.oakpal.core.OakpalPlan

getChecks() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

getChecks() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

getClassifier() - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

getCndNames() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

getCndNames() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

getCndUrls() - Method in class net.adamcin.oakpal.core.Checklist

getConfig() - Method in class net.adamcin.oakpal.core.CheckSpec

If impl references a script check or a ProgressCheckFactory, or if the check loaded from a checklist by name is a script check or a ProgressCheckFactory, this is used to configure the check.

getCurrentPackageFile() - Method in exception net.adamcin.oakpal.core.AbortedScanException

getCurrentPackageNode() - Method in exception net.adamcin.oakpal.core.AbortedScanException

getCurrentPackageUrl() - Method in exception net.adamcin.oakpal.core.AbortedScanException

getCwd() - Method in interface net.adamcin.oakpal.cli.Console

Return the current working directory (at time of execution).

getDefaultPlan() - Method in class net.adamcin.oakpal.core.opear.AdhocOpear

getDefaultPlan() - Method in interface net.adamcin.oakpal.core.opear.Opear

Get the default plan url specfied by the opear manifest, which may be OakpalPlan.EMPTY_PLAN_URL if no other plan is exported.

getDefaultPlan() - Method in class net.adamcin.oakpal.core.opear.OpearFile

getDescription() - Method in class net.adamcin.oakpal.api.SimpleViolation

getDescription() - Method in interface net.adamcin.oakpal.api.Violation

Describes the nature of the violation.

getEffectiveCheckSpecs(List<CheckSpec>) - Method in class net.adamcin.oakpal.core.ChecklistPlanner

Compute the checklist plan for progress checks, given a list of override specs to apply.

getEmbeddedId() - Method in class net.adamcin.oakpal.api.EmbeddedPackageInstallable

getEmbeddedId() - Method in class net.adamcin.oakpal.core.sling.EmbeddedPackageInstallableParams

getEngineName() - Method in exception net.adamcin.oakpal.core.ScriptProgressCheck.UnregisteredScriptEngineNameException

getEnv() - Method in interface net.adamcin.oakpal.cli.Console

Return the environment variables as a read-only map.

getError() - Method in class net.adamcin.oakpal.api.Result

All Failures will be created with a top-level RuntimeException.

getErrorListener() - Method in class net.adamcin.oakpal.core.OakMachine

getExecution() - Method in interface net.adamcin.oakpal.maven.mojo.MojoWithCommonParams

Get the current mojo execution.

getFactoryPid() - Method in class net.adamcin.oakpal.api.OsgiConfigInstallable

getFactoryPid() - Method in class net.adamcin.oakpal.core.sling.OsgiConfigInstallableParams

getFailedPackageMessage() - Method in exception net.adamcin.oakpal.core.AbortedScanException

getForcedRoots() - Method in class net.adamcin.oakpal.core.Checklist

getForcedRoots() - Method in class net.adamcin.oakpal.core.OakpalPlan

getForcedRoots() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

getForcedRoots() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

getGroupId() - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

getImpl() - Method in class net.adamcin.oakpal.core.CheckSpec

The direct classpath lookup name for a particular check.

getInitStages() - Method in class net.adamcin.oakpal.core.ChecklistPlanner

getInlineEngine() - Method in class net.adamcin.oakpal.core.CheckSpec

Specifies a ScriptEngineFactory name, or null to use the default of "javascript", in conjunction with a non-null value for CheckSpec.getInlineScript().

getInlineScript() - Method in class net.adamcin.oakpal.core.CheckSpec

As an alternative to CheckSpec.getImpl(), a CheckSpec may specify script check source code inline, i.e., as a javascript string.

getInstallableType() - Method in class net.adamcin.oakpal.core.sling.EmbeddedPackageInstallableParams

getInstallableType() - Method in class net.adamcin.oakpal.core.sling.OsgiConfigInstallableParams

getInstallableType() - Method in interface net.adamcin.oakpal.core.sling.SlingInstallableParams

Get the constructed installable type.

getInstallHookPolicy() - Method in class net.adamcin.oakpal.core.OakpalPlan

getInstallHookPolicy() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

getInstallHookPolicy() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

getJcr(NodeStoreFixture) - Static method in class net.adamcin.oakpal.webster.JcrFactory

Create an in-memory JCR repository backed by a read-only composite mount on top of the provided node store fixture.

getJcr(NodeStoreFixture, NodeStore) - Static method in class net.adamcin.oakpal.webster.JcrFactory

Create an in-memory JCR repository backed by a read-only composite mount on top of the provided node store fixture.

getJcrNamespaces() - Method in class net.adamcin.oakpal.core.Checklist

getJcrNamespaces() - Method in class net.adamcin.oakpal.core.OakpalPlan

getJcrNamespaces() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

getJcrNamespaces() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

getJcrNodetypes() - Method in class net.adamcin.oakpal.core.Checklist

getJcrNodetypes() - Method in class net.adamcin.oakpal.core.OakpalPlan

getJcrPath() - Method in class net.adamcin.oakpal.api.EmbeddedPackageInstallable

getJcrPath() - Method in class net.adamcin.oakpal.api.OsgiConfigInstallable

getJcrPath() - Method in interface net.adamcin.oakpal.api.SlingInstallable

The JCR path of the resource.

getJcrPrivilegeNames() - Method in class net.adamcin.oakpal.core.Checklist

getJcrPrivileges() - Method in class net.adamcin.oakpal.core.Checklist

getJcrPrivileges() - Method in class net.adamcin.oakpal.core.OakpalPlan

getJcrPrivileges() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

getJcrPrivileges() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

getKey() - Method in interface net.adamcin.oakpal.api.JavaxJson.Cursor

getKey() - Method in class net.adamcin.oakpal.api.JavaxJson.KeyCursor

getKey() - Method in class net.adamcin.oakpal.api.JavaxJson.ObjCursor

getLocalName() - Method in class net.adamcin.oakpal.webster.QName

getManifestHeaderValues(Manifest, String) - Static method in class net.adamcin.oakpal.core.Util

getMessage() - Method in exception net.adamcin.oakpal.core.AbortedScanException

getMixinTypes() - Method in class net.adamcin.oakpal.core.ForcedRoot

getModuleName() - Method in class net.adamcin.oakpal.core.Checklist

getName() - Method in class net.adamcin.oakpal.core.Checklist

getName() - Method in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

getName() - Method in class net.adamcin.oakpal.core.CheckSpec

The display name for the check.

getName() - Method in class net.adamcin.oakpal.core.OakpalPlan

getNamespacePrefixes() - Method in class net.adamcin.oakpal.core.ForcedRoot

List the namespace prefixes referenced by elements of this forcedRoot.

getNodeStore() - Method in class net.adamcin.oakpal.core.FileBlobMemoryNodeStore

getNodeStoreFixture(boolean, String...) - Static method in class net.adamcin.oakpal.webster.JcrFactory

getNodeStoreFixture(boolean, File, String...) - Static method in class net.adamcin.oakpal.webster.JcrFactory

getObj() - Method in class net.adamcin.oakpal.api.JavaxJson.ObjCursor

getOrDefault(V) - Method in class net.adamcin.oakpal.api.Result

getOrElse(Supplier<? extends V>) - Method in class net.adamcin.oakpal.api.Result

getOriginalJson() - Method in class net.adamcin.oakpal.core.OakpalPlan

getPackages() - Method in class net.adamcin.oakpal.api.SimpleViolation

getPackages() - Method in interface net.adamcin.oakpal.api.Violation

Provides a list of one or more Packages responsible for the violation.

getParentId() - Method in class net.adamcin.oakpal.api.EmbeddedPackageInstallable

getParentId() - Method in class net.adamcin.oakpal.api.OsgiConfigInstallable

getParentId() - Method in interface net.adamcin.oakpal.api.SlingInstallable

PackageId of the package that imported the resource.

getParseError() - Method in class net.adamcin.oakpal.core.sling.OsgiConfigInstallableParams

getPath() - Method in class net.adamcin.oakpal.core.ForcedRoot

getPattern() - Method in class net.adamcin.oakpal.api.Rule

getPlanBuilderParams() - Method in class net.adamcin.oakpal.maven.mojo.OpearPlanMojo

getPlanClassLoader(ClassLoader) - Method in class net.adamcin.oakpal.core.opear.AdhocOpear

getPlanClassLoader(ClassLoader) - Method in interface net.adamcin.oakpal.core.opear.Opear

Get a URL classloader constructed for this opear using the provided classloader as the parent.

getPlanClassLoader(ClassLoader) - Method in class net.adamcin.oakpal.core.opear.OpearFile

getPrefix() - Method in class net.adamcin.oakpal.core.JcrNs

The namespace prefix.

getPrefix() - Method in class net.adamcin.oakpal.webster.QName

getPreInstallArtifacts() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

getPreInstallArtifacts() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

getPreInstallFiles() - Method in class net.adamcin.oakpal.core.OakMachine

Deprecated.

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

getPreInstallFiles() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

getPreInstallFiles() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

getPreInstallUrls() - Method in class net.adamcin.oakpal.core.OakMachine

Return the urls for preinstall packages.

getPreInstallUrls() - Method in class net.adamcin.oakpal.core.OakpalPlan

getPrimaryType() - Method in class net.adamcin.oakpal.core.ForcedRoot

getPrivilegesFromJson(JsonValue, NamespaceMapping) - Static method in class net.adamcin.oakpal.core.JsonCnd

Read a serialized JSON privileges object (or array of privilege names) into a list of qualified privilege definitions.

getProgressChecks() - Method in class net.adamcin.oakpal.core.OakMachine

getProject() - Method in interface net.adamcin.oakpal.maven.mojo.MojoWithCommonParams

Get the maven project if available.

getProperties() - Method in class net.adamcin.oakpal.api.OsgiConfigInstallable

getProperties() - Method in class net.adamcin.oakpal.core.sling.OsgiConfigInstallableParams

getQTypesFromJson(JsonObject, NamespaceMapping) - Static method in class net.adamcin.oakpal.core.JsonCnd

Read a serialized JSON CND into a list of qualified node type definitions.

getReadOnlyFixture(File, String...) - Static method in class net.adamcin.oakpal.webster.JcrFactory

getReadWriteFixture(File, String...) - Static method in class net.adamcin.oakpal.webster.JcrFactory

getRepoInitFiles() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

getRepoInitFiles() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

getRepoInits() - Method in class net.adamcin.oakpal.core.Checklist

getRepoInits() - Method in class net.adamcin.oakpal.core.OakpalPlan

getRepoInits() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

getRepoInits() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

getRepoInitUrls() - Method in class net.adamcin.oakpal.core.OakpalPlan

getReportedViolations() - Method in class net.adamcin.oakpal.api.ReportCollector

getReportedViolations() - Method in class net.adamcin.oakpal.api.SimpleProgressCheck

getReportedViolations() - Method in interface net.adamcin.oakpal.api.ViolationReporter

Called at the end of execution to collect any detected violations.

getReportedViolations() - Method in class net.adamcin.oakpal.core.checks.Echo

getReportedViolations() - Method in class net.adamcin.oakpal.core.DefaultErrorListener

getReportedViolations() - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

getRepositorySystem() - Method in interface net.adamcin.oakpal.maven.mojo.MojoWithRepositoryParams

getRequireType() - Method in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

getResourceBundle() - Method in class net.adamcin.oakpal.api.SimpleProgressCheck

Used by SimpleProgressCheck.getString(String) to retrieve localized messages.

getResourceBundle() - Method in class net.adamcin.oakpal.core.DefaultErrorListener

Used by DefaultErrorListener.getString(String) to retrieve localized messages.

getResourceBundleBaseName() - Method in class net.adamcin.oakpal.api.SimpleProgressCheckFactoryCheck

getResourceBundleBaseName() - Method in interface net.adamcin.oakpal.api.ViolationReporter

Get the resource bundle base name for loading the default resource bundle for this violation reporter.

getResourceBundleBaseName() - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

getRunModes() - Method in class net.adamcin.oakpal.core.OakpalPlan

getRunModes() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

getRunModes() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

getScripts() - Method in class net.adamcin.oakpal.core.sling.SlingRepoInitScripts

getServicePid() - Method in class net.adamcin.oakpal.api.OsgiConfigInstallable

getServicePid() - Method in class net.adamcin.oakpal.core.sling.OsgiConfigInstallableParams

getSession() - Method in interface net.adamcin.oakpal.maven.mojo.MojoWithCommonParams

Get the current maven session.

getSettings() - Method in interface net.adamcin.oakpal.maven.mojo.MojoWithCommonParams

Get the maven settings.

getSeverity() - Method in class net.adamcin.oakpal.api.SimpleViolation

getSeverity() - Method in interface net.adamcin.oakpal.api.Violation

Describe the severity of the violation.

getSeverity() - Method in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

getShortCode() - Method in enum net.adamcin.oakpal.api.PathAction

Get the short code reported by filevault.

getSlingInstallable() - Method in class net.adamcin.oakpal.core.sling.SlingRepoInitScripts

getSpecificPlan(String) - Method in class net.adamcin.oakpal.core.opear.AdhocOpear

getSpecificPlan(String) - Method in interface net.adamcin.oakpal.core.opear.Opear

When the opear exports multiple plans, use this method to request a specific plan other than the default.

getSpecificPlan(String) - Method in class net.adamcin.oakpal.core.opear.OpearFile

getString(String) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck

Lookup a localized string from the resource bundle.

getString(String) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

Lookup a localized string from the resource bundle.

getString(String) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck.ScriptHelper

getSystemProperties() - Method in interface net.adamcin.oakpal.cli.Console

Return the system properties.

getTemplate() - Method in class net.adamcin.oakpal.core.CheckSpec

If specified, inherit the CheckSpec.getConfig() and either the CheckSpec.getImpl() or CheckSpec.getInlineScript() and CheckSpec.getInlineEngine() of another CheckSpec, following the same rules of name matching that apply to CheckSpec.getName().

getType() - Method in class net.adamcin.oakpal.api.Rule

getType() - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

getType() - Method in class net.adamcin.oakpal.webster.QName

getUri() - Method in class net.adamcin.oakpal.core.JcrNs

The namespace URI.

getUri() - Method in class net.adamcin.oakpal.webster.QName

getValueRules() - Method in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

getVersion() - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

getViolations() - Method in interface net.adamcin.oakpal.core.CheckReport

The reported violations.

getViolations(Severity) - Method in interface net.adamcin.oakpal.core.CheckReport

The list of violations filtered to ignore severities less than atLeastAsSevere.

getViolations() - Method in class net.adamcin.oakpal.core.SimpleReport

H

Handler - Class in net.adamcin.oakpal.testing.oakpaltest

Handler() - Constructor for class net.adamcin.oakpal.testing.oakpaltest.Handler

hashCode() - Method in class net.adamcin.oakpal.api.EmbeddedPackageInstallable

hashCode() - Method in class net.adamcin.oakpal.api.Rule

hashCode() - Method in class net.adamcin.oakpal.api.SimpleViolation

hashCode() - Method in class net.adamcin.oakpal.core.CheckSpec

hashCode() - Method in class net.adamcin.oakpal.core.ForcedRoot

hashCode() - Method in class net.adamcin.oakpal.core.JcrNs

hashCode() - Method in class net.adamcin.oakpal.core.SimpleReport

hashCode() - Method in class net.adamcin.oakpal.webster.QName

hasNonNull(JsonObject, String) - Static method in class net.adamcin.oakpal.api.JavaxJson

Convenience method to check to avoid type errors when getting a typed value backed by a JsonValue.NULL.

hasPath() - Method in class net.adamcin.oakpal.core.ForcedRoot

Return true if path is not null.

HelpMojo - Class in net.adamcin.oakpal.maven.mojo

Display help information on oakpal-maven-plugin.
Call mvn oakpal:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class net.adamcin.oakpal.maven.mojo.HelpMojo

HINT - Static variable in class net.adamcin.oakpal.maven.component.OakpalComponentConfigurator

HINT_KEY_MORE_TARGETS - Static variable in enum net.adamcin.oakpal.webster.targets.JsonTargetFactory

I

identifyEmbeddedPackage(PackageId, PackageId, EmbeddedPackageInstallable) - Method in interface net.adamcin.oakpal.api.ProgressCheck

Called after each embedded package is opened, if it has been submitted to the SlingSimulator.

identifyEmbeddedPackage(PackageId, PackageId, EmbeddedPackageInstallable) - Method in class net.adamcin.oakpal.core.checks.Echo

identifyEmbeddedPackage(PackageId, PackageId, EmbeddedPackageInstallable) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

identifyPackage(PackageId, File) - Method in interface net.adamcin.oakpal.api.ProgressCheck

Called after the package is uploaded to the package manager at the beginning of the scan.

identifyPackage(PackageId, File) - Method in class net.adamcin.oakpal.core.checks.Echo

identifyPackage(PackageId, File) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

identifySubpackage(PackageId, PackageId) - Method in interface net.adamcin.oakpal.api.ProgressCheck

Called after each subpackage is opened.

identifySubpackage(PackageId, PackageId) - Method in class net.adamcin.oakpal.core.checks.Echo

identifySubpackage(PackageId, PackageId) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

immutableCopyOf(CheckSpec) - Static method in class net.adamcin.oakpal.core.CheckSpec

impl() - Method in interface net.adamcin.oakpal.core.CheckSpec.JsonKeys

importedPath(PackageId, String, Node) - Method in interface net.adamcin.oakpal.api.ProgressCheck

Deprecated.

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

importedPath(PackageId, String, Node, PathAction) - Method in interface net.adamcin.oakpal.api.ProgressCheck

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

importedPath(PackageId, String, Node) - Method in class net.adamcin.oakpal.core.checks.Echo

Deprecated.

importedPath(PackageId, String, Node, PathAction) - Method in class net.adamcin.oakpal.core.checks.Echo

importedPath(PackageId, String, Node, PathAction) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

importModeSeverity() - Method in interface net.adamcin.oakpal.core.checks.FilterSets.JsonKeys

infer0(Supplier<? extends T>) - Static method in class net.adamcin.oakpal.api.Fun

Infers a method ref to a Supplier.

infer1(Function<? super T, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Infers a static method ref to a Function.

infer2(BiFunction<? super K, ? super V, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Infers a static method ref to a BiFunction.

inferTest1(Predicate<? super T>) - Static method in class net.adamcin.oakpal.api.Fun

Infers a method ref to a Predicate.

inferTest2(BiPredicate<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun

Infers a method ref to a BiPredicate.

inherit(CheckSpec) - Method in class net.adamcin.oakpal.core.CheckSpec

Apply this spec's attributes to that as an overlay to that spec's attributes.

inherits(CheckSpec) - Method in class net.adamcin.oakpal.core.CheckSpec

Return true if this spec identifies that spec by name in this spec's template attribute.

initAndInspect(OakMachine.InspectBody<E>) - Method in class net.adamcin.oakpal.core.OakMachine

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

InitStage - Class in net.adamcin.oakpal.core

Encapsulation of JCR initialization parameters for multistage inits.

InitStage.Builder - Class in net.adamcin.oakpal.core

Use the builder to construct the InitStage.

inlineEngine() - Method in interface net.adamcin.oakpal.core.CheckSpec.JsonKeys

inlineScript() - Method in interface net.adamcin.oakpal.core.CheckSpec.JsonKeys

inSet(S) - Static method in class net.adamcin.oakpal.api.Fun

This method is used to support type inference around the Collection.contains(Object) method, whose argument is not otherwise typed with the element type parameter of the collection.

InstallHookPolicy - Enum in net.adamcin.oakpal.core

Enumeration of policies for dealing with InstallHook processing during a scan.

installHookPolicy() - Method in interface net.adamcin.oakpal.core.OakpalPlan.JsonKeys

instance - Static variable in class net.adamcin.oakpal.api.Nothing

This is the singleton sentinel value.

instance() - Static method in class net.adamcin.oakpal.core.sling.DefaultSlingSimulator

instance() - Static method in class net.adamcin.oakpal.core.sling.NoopSlingSimulator

INVOKE_GET_CHECK_NAME - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_AFTER_EXTRACT - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_AFTER_SCAN_PACKAGE - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_APPLIED_REPO_INIT_SCRIPTS - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_BEFORE_EXTRACT - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_BEFORE_SLING_INSTALL - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_DELETED_PATH - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_FINISHED_SCAN - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_IDENTIFY_EMBEDDED_PACKAGE - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_IDENTIFY_PACKAGE - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_IDENTIFY_SUBPACKAGE - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_IMPORTED_PATH - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_READ_MANIFEST - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_SIMULATE_SLING - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

INVOKE_ON_STARTED_SCAN - Static variable in class net.adamcin.oakpal.core.ScriptProgressCheck

IO<A> - Interface in net.adamcin.oakpal.cli

Just a simple IO monad.

isAbstract() - Method in class net.adamcin.oakpal.core.CheckSpec

An abstract check spec has neither a non-empty CheckSpec.getImpl() nor a non-null CheckSpec.getInlineScript(), and is therefore not invokable on its own.

isAllow() - Method in class net.adamcin.oakpal.api.Rule

Readability alias for Rule.isInclude() when the rule is used in the more abstract context of scope definition.

isDeny() - Method in class net.adamcin.oakpal.api.Rule

Readability alias for Rule.isExclude() when the rule is used in the more literal context of acceptable vs unacceptable values.

isDenyIfAbsent() - Method in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

isDenyIfMultivalued() - Method in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

isDenyIfPresent() - Method in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

isEnablePreInstallHooks() - Method in class net.adamcin.oakpal.core.OakpalPlan

isEnablePreInstallHooks() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

isEnablePreInstallHooks() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

isExclude() - Method in class net.adamcin.oakpal.api.Rule

Readability alias for Rule.isDeny() when the rule is used in the more abstract context of scope definition.

isFailure() - Method in class net.adamcin.oakpal.api.Result

isInclude() - Method in class net.adamcin.oakpal.api.Rule

Readability alias for Rule.isAllow() when the rule is used in the more abstract context of scope definition.

isIndividuallySkipped() - Method in class net.adamcin.oakpal.maven.mojo.ScanArtifactMojo

isIndividuallySkipped() - Method in class net.adamcin.oakpal.maven.mojo.ScanManyArtifactsMojo

isIndividuallySkipped() - Method in class net.adamcin.oakpal.maven.mojo.VerifyMojo

isInheritedBy(CheckSpec) - Method in class net.adamcin.oakpal.core.CheckSpec

The inverse of CheckSpec.inherits(CheckSpec).

isKeyIn(M) - Static method in class net.adamcin.oakpal.api.Fun

This method is used to support type inference around the Map.containsKey(Object) method, whose argument is not otherwise typed with the key type parameter of the Map.

isLessSevereThan(Severity) - Method in enum net.adamcin.oakpal.api.Severity

isNoop() - Method in enum net.adamcin.oakpal.api.PathAction

Returns true if this is the NOOP action type.

isOverriddenBy(CheckSpec) - Method in class net.adamcin.oakpal.core.CheckSpec

The inverse of CheckSpec.overrides(CheckSpec).

isSkip() - Method in class net.adamcin.oakpal.core.CheckSpec

Whether to skip this check during a scan.

isSlingNodeTypes() - Method in interface net.adamcin.oakpal.maven.mojo.PlanBuilderParams

isSlingNodeTypes() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

isSuccess() - Method in class net.adamcin.oakpal.api.Result

isTargetType(String) - Static method in enum net.adamcin.oakpal.webster.targets.JsonTargetFactory

isTestScopeContainer() - Method in interface net.adamcin.oakpal.maven.mojo.MojoWithRepositoryParams

There are basically two use cases for the oakpal-maven-plugin: 1) Adhoc testing of a content-package project artifact, in which case all oakpal classpath resources will be found in test scope, or 2) Creation and testing of an oakpal module with checklists, and/or creation and testing of an opear archive, in which case all oakpal classpath resources will be found in a non-test scope classpath.

isUnknown() - Method in enum net.adamcin.oakpal.api.PathAction

Returns true if this is the PathAction.UNKNOWN fallback action type.

isValueIn(M) - Static method in class net.adamcin.oakpal.api.Fun

This method is used to support type inference around the Map.containsValue(Object) method, whose argument is not otherwise typed with the value type parameter of the Map.

J

JavaxJson - Class in net.adamcin.oakpal.api

Simple DSL for constructing javax.json objects for ProgressCheckFactory configs using only three-letter identifiers.

JavaxJson.Arr - Class in net.adamcin.oakpal.api

Constructs an array by iterating over a list of JavaxJson.Value instances.

JavaxJson.As<TYPE> - Interface in net.adamcin.oakpal.api

Defines a get method returns the constructed type parameter.

JavaxJson.Cursor - Interface in net.adamcin.oakpal.api

Type which allows a different fluent style for building keys, i.e.

JavaxJson.HasValue - Interface in net.adamcin.oakpal.api

Defines a method toValue which coalesces the underlying value to prevent over-wrapping by the JavaxJson.val(Object) method.

JavaxJson.Key - Class in net.adamcin.oakpal.api

Iterative key-value pair type for building JavaxJson.Obj instances.

JavaxJson.KeyCursor - Class in net.adamcin.oakpal.api

Cursor type originating from a call to JavaxJson.key(String), and which therefore returns a lone JavaxJson.Key for JavaxJson.KeyCursor.val(Object).

JavaxJson.Obj - Class in net.adamcin.oakpal.api

Constructs an object by iterating over a list of JavaxJson.Key instances.

JavaxJson.ObjCursor - Class in net.adamcin.oakpal.api

Cursor type originating from a call to JavaxJson.Key.key(String) or JavaxJson.Obj.key(String), and which therefore returns a new JavaxJson.Obj with the newly-finished key appended internally.

JavaxJson.Value - Class in net.adamcin.oakpal.api

Discrete value wrapper.

JcrFactory - Class in net.adamcin.oakpal.webster

JCR Repository factory for NodeStoreFixture instances defined by oak-run option sets.

jcrNamespaces() - Method in interface net.adamcin.oakpal.core.Checklist.JsonKeys

jcrNamespaces() - Method in interface net.adamcin.oakpal.core.OakpalPlan.JsonKeys

jcrNodetypes() - Method in interface net.adamcin.oakpal.core.Checklist.JsonKeys

jcrNodetypes() - Method in interface net.adamcin.oakpal.core.OakpalPlan.JsonKeys

JcrNs - Class in net.adamcin.oakpal.core

Config DTO for JCR Namespace Prefix to URI Mappings.

JcrNs() - Constructor for class net.adamcin.oakpal.core.JcrNs

JcrNs.JsonKeys - Interface in net.adamcin.oakpal.core

Json keys for JcrNs.

jcrPrivileges() - Method in interface net.adamcin.oakpal.core.Checklist.JsonKeys

jcrPrivileges() - Method in interface net.adamcin.oakpal.core.OakpalPlan.JsonKeys

JcrProperties - Class in net.adamcin.oakpal.core.checks

A complex check for enforcing characteristics of JCR Properties of imported nodes and their descendants within the scope of the workspace filter.

JcrProperties() - Constructor for class net.adamcin.oakpal.core.checks.JcrProperties

JcrProperties.JsonKeys - Interface in net.adamcin.oakpal.core.checks

JcrPropertyConstraints - Class in net.adamcin.oakpal.core.checks

Encapsulation of constraints on a JCR property for the JcrProperties check.

JcrPropertyConstraints(String, boolean, boolean, boolean, String, List<Rule>, Severity, Supplier<ResourceBundle>) - Constructor for class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

JcrPropertyConstraints.JsonKeys - Interface in net.adamcin.oakpal.core.checks

JSON_VALUE_STRING - Static variable in class net.adamcin.oakpal.api.JavaxJson

This is needed to easily map untyped JsonString instances to String, since we don't use the JsonObject.getString(String) methods.

JsonArrayConvertible - Interface in net.adamcin.oakpal.api

Custom pojo types which should be usable within the JavaxJson DSL should implement this method to provide a JsonArray, which can be wrapped quickly by JavaxJson.val(Object).

JsonCnd - Class in net.adamcin.oakpal.core

Methods and types used to encode/decode QNodeTypeDefinitions as JSON for use in checklists.

JsonConverter - Class in net.adamcin.oakpal.maven.component

This implementation converts a deeply-nested PlexusConfiguration graph into a JsonObject.

JsonConverter() - Constructor for class net.adamcin.oakpal.maven.component.JsonConverter

JsonObjectConvertible - Interface in net.adamcin.oakpal.api

Custom pojo types which should be usable within the JavaxJson DSL should implement this method to provide a JsonObject, which can be wrapped quickly by JavaxJson.val(Object).

JsonTargetFactory - Enum in net.adamcin.oakpal.webster.targets

TODO Examples...

K

keepFirstMerger() - Static method in class net.adamcin.oakpal.api.Fun

A merge function for Fun.entriesToMap(BinaryOperator) and Fun.entriesToMapOfType(Supplier, BinaryOperator) that keeps the first element defined for a key when merging duplicates.

keepLastMerger() - Static method in class net.adamcin.oakpal.api.Fun

A merge function for Fun.entriesToMap(BinaryOperator) and Fun.entriesToMapOfType(Supplier, BinaryOperator) that keeps the last element defined for a key when merging duplicates.

key(String, Object) - Static method in class net.adamcin.oakpal.api.JavaxJson

Creates a key-value pair for use with JavaxJson.obj(Key...).

key(String) - Static method in class net.adamcin.oakpal.api.JavaxJson

Begin a key-value pair without providing a value argument.

key(String) - Method in class net.adamcin.oakpal.api.JavaxJson.Key

key(String, Object) - Method in class net.adamcin.oakpal.api.JavaxJson.Key

key(String) - Method in class net.adamcin.oakpal.api.JavaxJson.Obj

Begin another JavaxJson.Key instance without providing an associated value.

key(String, Object) - Method in class net.adamcin.oakpal.api.JavaxJson.Obj

Append another JavaxJson.Key instance.

KEY_CONFIG - Static variable in enum net.adamcin.oakpal.webster.targets.JsonTargetFactory

KEY_FILE - Static variable in enum net.adamcin.oakpal.webster.targets.JsonTargetFactory

KEY_TYPE - Static variable in enum net.adamcin.oakpal.webster.targets.JsonTargetFactory

keys() - Static method in class net.adamcin.oakpal.api.Rule

keys() - Static method in class net.adamcin.oakpal.core.Checklist

keys() - Static method in class net.adamcin.oakpal.core.checks.AcHandling

keys() - Static method in class net.adamcin.oakpal.core.checks.CompositeStoreAlignment

keys() - Static method in class net.adamcin.oakpal.core.checks.ExpectAces

keys() - Static method in class net.adamcin.oakpal.core.checks.ExpectPaths

keys() - Static method in class net.adamcin.oakpal.core.checks.FilterSets

keys() - Static method in class net.adamcin.oakpal.core.checks.JcrProperties

keys() - Static method in class net.adamcin.oakpal.core.checks.JcrPropertyConstraints

keys() - Static method in class net.adamcin.oakpal.core.checks.Overlaps

keys() - Static method in class net.adamcin.oakpal.core.checks.Paths

keys() - Static method in class net.adamcin.oakpal.core.checks.SlingJcrInstaller

keys() - Static method in class net.adamcin.oakpal.core.checks.Subpackages

keys() - Static method in class net.adamcin.oakpal.core.CheckSpec

keys() - Static method in class net.adamcin.oakpal.core.ForcedRoot

keys() - Static method in class net.adamcin.oakpal.core.JcrNs

keys() - Static method in class net.adamcin.oakpal.core.OakpalPlan

keys() - Static method in class net.adamcin.oakpal.core.ReportMapper

L

lastMatch(List<Rule>, String, Function<List<Rule>, Rule>) - Static method in class net.adamcin.oakpal.api.Rules

Evaluate the provided list of rules against the String value using the provided selector function to select the default rule when none match.

lastMatch(List<Rule>, String) - Static method in class net.adamcin.oakpal.api.Rules

Evaluate the provided list of rules against the String value, using Rules.fuzzyDefaultInclude(List) to select the default rule when none match.

levelSet() - Method in interface net.adamcin.oakpal.core.checks.AcHandling.JsonKeys

ListenerReadOnlyException - Exception in net.adamcin.oakpal.core

Common exception type for attempted repository writes by ScanListeners.

ListenerReadOnlyException() - Constructor for exception net.adamcin.oakpal.core.ListenerReadOnlyException

LN_UNDECLARED - Static variable in class net.adamcin.oakpal.core.OakMachine

loadFromCheckSpecs(List<CheckSpec>) - Static method in class net.adamcin.oakpal.core.Locator

Load a list of ProgressChecks from from a list of CheckSpecs using the default classloader.

loadFromCheckSpecs(List<CheckSpec>, ClassLoader) - Static method in class net.adamcin.oakpal.core.Locator

Load a list of ProgressChecks from from a list of CheckSpecs using the provided classloader.

loadProgressCheck(String) - Static method in class net.adamcin.oakpal.core.Locator

Attempt to load a ProgressCheck from the class path.

loadProgressCheck(String, JsonObject) - Static method in class net.adamcin.oakpal.core.Locator

Attempt to load a ProgressCheck from a particular class loader.

loadProgressCheck(String, JsonObject, ClassLoader) - Static method in class net.adamcin.oakpal.core.Locator

Attempt to load a ProgressCheck from a particular class loader.

Locator - Class in net.adamcin.oakpal.core

Unified class path locator for PackageLister classes and scripts.

logAndRestream() - Static method in class net.adamcin.oakpal.api.Result

logAndRestream(String) - Static method in class net.adamcin.oakpal.api.Result

M

majorViolation(String, PackageId...) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck

majorViolation(String, PackageId...) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck.ScriptHelper

map(Function<? super V, W>) - Method in class net.adamcin.oakpal.api.Result

Map it.

map(Function<A, B>) - Method in interface net.adamcin.oakpal.cli.IO

mapArrayOfObjects(JsonArray, Function<JsonObject, R>) - Static method in class net.adamcin.oakpal.api.JavaxJson

Filters and maps the provided JsonArray into a List<JsonObject>, then applies the provided mapFunction to each result to return a typed list.

mapArrayOfObjects(JsonArray, Function<JsonObject, R>, boolean) - Static method in class net.adamcin.oakpal.api.JavaxJson

Filters and maps the provided JsonArray into a List<JsonObject>, then applies the provided mapFunction to each result to return a typed list.

mapArrayOfStrings(JsonArray) - Static method in class net.adamcin.oakpal.api.JavaxJson

Filters and maps the provided JsonArray into a List<String>.

mapArrayOfStrings(JsonArray, Function<String, R>) - Static method in class net.adamcin.oakpal.api.JavaxJson

Filters and maps the provided JsonArray into a List<String>, then applies the provided mapFunction to each result to return a typed list.

mapArrayOfStrings(JsonArray, Function<String, R>, boolean) - Static method in class net.adamcin.oakpal.api.JavaxJson

Filters and maps the provided JsonArray into a List<String>, then applies the provided mapFunction to each result to return a typed list.

mapEntry(BiFunction<? super K, ? super V, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a BiFunction to a Function over Map.Entry stream elements of the same key and value type parameters.

mapKey(BiFunction<? super K, ? super V, ? extends L>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a BiFunction to a Function over Map.Entry stream elements of the same key and value type parameters, that returns new Map.Entry elements that retain the input value but take the output of the BiFunction as the new key.

mapKey(Function<? super K, ? extends L>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Function over key types to a Function over Map.Entry stream elements whose key type matches the input type of the Function, that returns new Map.Entry elements that retain the input value but take the output of the Function as the new key.

mapManifestHeaderResources(String, ClassLoader) - Static method in class net.adamcin.oakpal.core.Util

mapManifestHeaderResources(String, List<File>) - Static method in class net.adamcin.oakpal.core.Util

mapManifestHeaderResources(String, URL) - Static method in class net.adamcin.oakpal.core.Util

mapObjectValues(JsonObject, BiFunction<String, JsonObject, R>, boolean) - Static method in class net.adamcin.oakpal.api.JavaxJson

Filters and maps the provided JsonObject into a Map<String, JsonObject>, then applies the provided mapBiFunction to each result pair to return a typed list.

mapValue(BiFunction<? super K, ? super V, ? extends W>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a BiFunction to a Function over Map.Entry stream elements of the same key and value type parameters, that returns new Map.Entry elements that retain the input key but take the output of the BiFunction as the new value.

mapValue(Function<? super V, ? extends W>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Function over value types to a Function over Map.Entry stream elements whose value type matches the input type of the Function, that returns new Map.Entry elements that retain the input key but take the output of the Function as the new value.

matches(String) - Method in class net.adamcin.oakpal.api.Rule

Conventional usage of the rule's Pattern to match the entirety of the provided string value.

maxDepth() - Method in interface net.adamcin.oakpal.core.checks.SlingJcrInstaller.JsonKeys

maxDepth represents the depth of a watched folder path relative to the repository root.

maxSeverity(Severity) - Method in enum net.adamcin.oakpal.api.Severity

meetsMinimumSeverity() - Method in enum net.adamcin.oakpal.api.Severity

MF_BUNDLE_SYMBOLICNAME - Static variable in interface net.adamcin.oakpal.core.opear.Opear

MF_BUNDLE_VERSION - Static variable in interface net.adamcin.oakpal.core.opear.Opear

MF_CLASS_PATH - Static variable in interface net.adamcin.oakpal.core.opear.Opear

MF_OAKPAL_PLAN - Static variable in interface net.adamcin.oakpal.core.opear.Opear

MF_OAKPAL_VERSION - Static variable in interface net.adamcin.oakpal.core.opear.Opear

minorViolation(String, PackageId...) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck

minorViolation(String, PackageId...) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck.ScriptHelper

mixinTypes() - Method in interface net.adamcin.oakpal.core.ForcedRoot.JsonKeys

MojoWithCommonParams - Interface in net.adamcin.oakpal.maven.mojo

Common getters for Mojo context objects.

MojoWithRepositoryParams - Interface in net.adamcin.oakpal.maven.mojo

Mojo Interface providing default methods for resolution of artifacts and creation of maven classloaders.

mounts() - Method in interface net.adamcin.oakpal.core.checks.CompositeStoreAlignment.JsonKeys

N

name() - Method in interface net.adamcin.oakpal.core.Checklist.JsonKeys

name() - Method in interface net.adamcin.oakpal.core.checks.JcrPropertyConstraints.JsonKeys

name() - Method in interface net.adamcin.oakpal.core.CheckSpec.JsonKeys

NAME_BUNDLE_SYMBOLICNAME - Static variable in class net.adamcin.oakpal.core.opear.OpearFile

NAME_BUNDLE_VERSION - Static variable in class net.adamcin.oakpal.core.opear.OpearFile

NAME_CLASS_PATH - Static variable in class net.adamcin.oakpal.core.opear.OpearFile

NAME_OAKPAL_PLAN - Static variable in class net.adamcin.oakpal.core.opear.OpearFile

NAME_OAKPAL_VERSION - Static variable in class net.adamcin.oakpal.core.opear.OpearFile

namedBy(QNodeTypeDefinition) - Static method in class net.adamcin.oakpal.core.JsonCnd

Stream the qualified names referenced in a node type definition in order to determine which namespaces must be represented in a serialized mapping.

namedBy(PrivilegeDefinition) - Static method in class net.adamcin.oakpal.core.JsonCnd

Stream the qualified names referenced in a privilege definition in order to determine which namespaces must be represented in a serialized mapping.

NamespaceMappingRequest - Class in net.adamcin.oakpal.core

Given all the JCR namespace gymnastics that have to be performed for JsonCnd and webster, dealing with builtins and aggregation and references by prefix or uri, this class was created to encapsulate the resolution logic to map NamespaceMapping objects to lists of JcrNs objects in a standard way.

NamespaceMappingRequest.Builder - Class in net.adamcin.oakpal.core

Build a NamespaceMappingRequest by specifying which namespace mappings (by prefix or by uri) should be retained.

net.adamcin.oakpal.api - package net.adamcin.oakpal.api

net.adamcin.oakpal.cli - package net.adamcin.oakpal.cli

net.adamcin.oakpal.core - package net.adamcin.oakpal.core

net.adamcin.oakpal.core.checks - package net.adamcin.oakpal.core.checks

net.adamcin.oakpal.core.opear - package net.adamcin.oakpal.core.opear

net.adamcin.oakpal.core.repoinit - package net.adamcin.oakpal.core.repoinit

net.adamcin.oakpal.core.sling - package net.adamcin.oakpal.core.sling

net.adamcin.oakpal.maven.component - package net.adamcin.oakpal.maven.component

net.adamcin.oakpal.maven.mojo - package net.adamcin.oakpal.maven.mojo

net.adamcin.oakpal.testing - package net.adamcin.oakpal.testing

net.adamcin.oakpal.testing.oakpaltest - package net.adamcin.oakpal.testing.oakpaltest

net.adamcin.oakpal.webster - package net.adamcin.oakpal.webster

net.adamcin.oakpal.webster.targets - package net.adamcin.oakpal.webster.targets

newDefaultRepoInitProcessor(ClassLoader) - Static method in class net.adamcin.oakpal.core.repoinit.DefaultRepoInitFactory

newFactoryInstance(ClassLoader) - Static method in class net.adamcin.oakpal.core.repoinit.DefaultRepoInitFactory

newInstance(JsonObject) - Method in interface net.adamcin.oakpal.api.ProgressCheckFactory

Returns a new check with the provided config.

newInstance(JsonObject) - Method in class net.adamcin.oakpal.core.checks.AcHandling

newInstance(JsonObject) - Method in class net.adamcin.oakpal.core.checks.CompositeStoreAlignment

newInstance(JsonObject) - Method in class net.adamcin.oakpal.core.checks.ExpectAces

newInstance(JsonObject) - Method in class net.adamcin.oakpal.core.checks.ExpectPaths

newInstance(JsonObject) - Method in class net.adamcin.oakpal.core.checks.FilterSets

newInstance(JsonObject) - Method in class net.adamcin.oakpal.core.checks.JcrProperties

newInstance(JsonObject) - Method in class net.adamcin.oakpal.core.checks.Overlaps

newInstance(JsonObject) - Method in class net.adamcin.oakpal.core.checks.Paths

newInstance(JsonObject) - Method in class net.adamcin.oakpal.core.checks.SlingJcrInstaller

newInstance(JsonObject) - Method in class net.adamcin.oakpal.core.checks.Subpackages

newOakpalPackagingService() - Static method in class net.adamcin.oakpal.core.OakMachine

newOakpalPackagingService(ClassLoader) - Static method in class net.adamcin.oakpal.core.OakMachine

nonDefaultValue(JsonValue, JsonValue) - Static method in class net.adamcin.oakpal.api.JavaxJson

Return true if the value is not equal to the provided default value.

nonEmptyValue(JsonValue) - Static method in class net.adamcin.oakpal.api.JavaxJson

To keep things simple and concise, the JSON CND format does not need to serialize null values, empty arrays, or empty objects.

NoopSlingSimulator - Class in net.adamcin.oakpal.core.sling

Noop implementation of a SlingSimulator.

NoopSlingSimulator() - Constructor for class net.adamcin.oakpal.core.sling.NoopSlingSimulator

notAbstract() - Method in class net.adamcin.oakpal.core.CheckSpec

Inverse of CheckSpec.isAbstract().

notExpectedAces() - Method in interface net.adamcin.oakpal.core.checks.ExpectAces.JsonKeys

notExpectedPaths() - Method in interface net.adamcin.oakpal.core.checks.ExpectPaths.JsonKeys

Nothing - Class in net.adamcin.oakpal.api

A sentinel type for functional parameters representing Nothing, like Void.

notSkipped() - Method in class net.adamcin.oakpal.core.CheckSpec

The inverse of CheckSpec.isSkip().

NS_PREFIX_OAKPAL - Static variable in class net.adamcin.oakpal.core.OakMachine

NS_URI_OAKPAL - Static variable in class net.adamcin.oakpal.core.OakMachine

NT_UNDECLARED - Static variable in class net.adamcin.oakpal.core.OakMachine

O

OakMachine - Class in net.adamcin.oakpal.core

Entry point for OakPAL Acceptance Library.

OakMachine.Builder - Class in net.adamcin.oakpal.core

Use the builder to construct the OakMachine.

OakMachine.InspectBody<E extends Throwable> - Interface in net.adamcin.oakpal.core

Functional interface for OakMachine.initAndInspect(InspectBody).

OakMachine.JcrCustomizer - Interface in net.adamcin.oakpal.core

OakMachine.RepoInitProcessor - Interface in net.adamcin.oakpal.core

Functional interface for a repoinit processor that unifies the RepoInitParser and JcrRepoInitOpsProcessor signatures.

OakMachine.SubpackageSilencer - Interface in net.adamcin.oakpal.core

Functional interface for Builder.withSubpackageSilencer(SubpackageSilencer).

OAKPAL_CHECKLIST - Static variable in class net.adamcin.oakpal.core.ChecklistPlanner

OAKPAL_MODULENAME - Static variable in class net.adamcin.oakpal.core.ChecklistPlanner

OakpalComponentConfigurator - Class in net.adamcin.oakpal.maven.component

Adds a JsonConverter to the BasicComponentConfigurator to support mapping arbitrarily nested PlexusConfiguration elements to a single JsonObject graph.

OakpalComponentConfigurator() - Constructor for class net.adamcin.oakpal.maven.component.OakpalComponentConfigurator

OakpalPlan - Class in net.adamcin.oakpal.core

A plan is a reproducible execution plan, similar in design to a Checklist, but with the following differences: 1.

OakpalPlan.Builder - Class in net.adamcin.oakpal.core

OakpalPlan.JsonKeys - Interface in net.adamcin.oakpal.core

obj(JavaxJson.Key...) - Static method in class net.adamcin.oakpal.api.JavaxJson

Create an object with the provided key-value pairs.

obj(JsonObject) - Static method in class net.adamcin.oakpal.api.JavaxJson

Create an object, and add all the keys from the provided json object to it.

obj(Map<?, ?>) - Static method in class net.adamcin.oakpal.api.JavaxJson

Create an object, and add all the keys from the provided map to it.

objectOrEmpty(JsonObject, String) - Static method in class net.adamcin.oakpal.api.JavaxJson

Retrieve a value as an object, or return the empty object if key is not present or if the value is the wrong type.

onEntry(BiConsumer<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a BiConsumer to a Consumer of Map.Entry stream elements with matching respective key and value type parameters.

onForcedRootCreationError(Throwable, ForcedRoot) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onForcedRootCreationError(Throwable, ForcedRoot) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called for each error thrown during creation of a forced JCR root.

onImporterException(Exception, PackageId, String) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onImporterException(Exception, PackageId, String) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called when the package FileVault importer encounters an error such as an XML syntax exception.

onInstallHookError(Throwable, PackageId) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onInstallHookError(Throwable, PackageId) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called when an exception is thrown when attempting to register install hooks for a particular package.

onJcrNamespaceRegistrationError(Throwable, String, String) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onJcrNamespaceRegistrationError(Throwable, String, String) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called for each unresolved error thrown during JCR namespace prefix registration.

onJcrPrivilegeRegistrationError(Throwable, String) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onJcrPrivilegeRegistrationError(Throwable, String) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called for each unresolved error thrown during JCR privilege registration.

onKey(Consumer<? super K>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Consumer of key types to a Consumer of Map.Entry stream elements with a matching key type parameter.

onListenerException(Exception, ProgressCheck, PackageId) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onListenerException(Exception, ProgressCheck, PackageId) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called when a ProgressCheck throws an exception.

onListenerPathException(Exception, ProgressCheck, PackageId, String) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onListenerPathException(Exception, ProgressCheck, PackageId, String) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called when a ProgressCheck throws an exception when handling an imported path.

onNodeTypeRegistrationError(Throwable, URL) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onNodeTypeRegistrationError(Throwable, URL) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called for each unresolved error thrown during node type definition auto-installation.

onProhibitedInstallHookRegistration(PackageId) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onProhibitedInstallHookRegistration(PackageId) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called after any install hooks have been registered for a particular package during a scan which has specified OakpalPlan.getInstallHookPolicy() value of InstallHookPolicy.PROHIBIT.

onRepoInitInlineError(Throwable, List<String>) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onRepoInitInlineError(Throwable, List<String>) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called for an IOException or RepoInitParsingException when parsing a list of repoinit scripts during InitStage.initSession().

onRepoInitUrlError(Throwable, URL) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onRepoInitUrlError(Throwable, URL) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called for an IOException or RepoInitParsingException when parsing a repoinit url during InitStage.initSession().

onSlingCreateInstallableError(Exception, Class<? extends SlingInstallable>, PackageId, String) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onSlingCreateInstallableError(Exception, Class<? extends SlingInstallable>, PackageId, String) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called for errors occurring during an attempt to create an installable from a node submitted to a SlingSimulator, such as parsing errors for OSGi Config files.

onSlingEmbeddedPackageError(Throwable, EmbeddedPackageInstallable) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onSlingEmbeddedPackageError(Throwable, EmbeddedPackageInstallable) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called for an IOException, PackageException, or RepositoryException when installing an embedded package submitted to a SlingSimulator.

onSlingRepoInitScriptsError(Throwable, List<String>, String, SlingInstallable) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onSlingRepoInitScriptsError(Throwable, List<String>, String, SlingInstallable) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called for an IOException or RepoInitParsingException when parsing an installable repoinit script submitted to a SlingSimulator.

onSubpackageException(Exception, PackageId) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

onSubpackageException(Exception, PackageId) - Method in interface net.adamcin.oakpal.core.ErrorListener

Called when an exception was thrown when attempting to open or extract a package.

onValue(Consumer<? super V>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Consumer of value types to a Consumer of Map.Entry stream elements with a matching value type parameter.

Opear - Interface in net.adamcin.oakpal.core.opear

OPEAR stands for "OakPal Encapsulated ARchive".

OPEAR - Static variable in class net.adamcin.oakpal.maven.mojo.OpearPackageMojo

OpearArchiver() - Constructor for class net.adamcin.oakpal.maven.mojo.OpearPackageMojo.OpearArchiver

OpearFile - Class in net.adamcin.oakpal.core.opear

The default implemenation of Opear.

OpearPackageMojo - Class in net.adamcin.oakpal.maven.mojo

Bundles up project dependencies an exported plans as an opear (OakPAL Encapsulated Archive) file, and attaches it to the project.

OpearPackageMojo() - Constructor for class net.adamcin.oakpal.maven.mojo.OpearPackageMojo

OpearPackageMojo.OpearArchiver - Class in net.adamcin.oakpal.maven.mojo

OpearPlanMojo - Class in net.adamcin.oakpal.maven.mojo

Exports a plan builder configuration for inclusion in an opear file, using the OpearPackageMojo.

OpearPlanMojo() - Constructor for class net.adamcin.oakpal.maven.mojo.OpearPlanMojo

open() - Method in interface net.adamcin.oakpal.core.ReportMapper.ReaderSupplier

open() - Method in interface net.adamcin.oakpal.core.ReportMapper.WriterSupplier

open(SlingOpenable<ResourceType>) - Method in class net.adamcin.oakpal.core.sling.DefaultSlingSimulator

open(SlingOpenable<ResourceType>) - Method in class net.adamcin.oakpal.core.sling.NoopSlingSimulator

open(SlingOpenable<ResourceType>) - Method in interface net.adamcin.oakpal.core.sling.SlingSimulatorBackend

Return a supplier that tries to open an installable resource from the specified installable path.

open() - Method in interface net.adamcin.oakpal.webster.ChecklistExporter.WriterOpener

open() - Method in interface net.adamcin.oakpal.webster.CndExporter.WriterOpener

open() - Method in interface net.adamcin.oakpal.webster.PrivilegeXmlExporter.WriterOpener

openConnection(URL) - Method in class net.adamcin.oakpal.testing.oakpaltest.Handler

openEmbeddedPackage(EmbeddedPackageInstallable) - Method in class net.adamcin.oakpal.core.sling.DefaultSlingSimulator

openFixture() - Method in interface net.adamcin.oakpal.webster.WebsterPlan.FixtureProvider

openPrinter(File) - Method in interface net.adamcin.oakpal.cli.Console

Create a new printer that must be disposed eventually, which specifically writes lines to the specified path.

opt(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.Arr

opt(Object, Object) - Method in class net.adamcin.oakpal.api.JavaxJson.Arr

opt(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.KeyCursor

opt(Object, Object) - Method in class net.adamcin.oakpal.api.JavaxJson.KeyCursor

opt(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.ObjCursor

opt(Object, Object) - Method in class net.adamcin.oakpal.api.JavaxJson.ObjCursor

optArray(JsonObject, String) - Static method in class net.adamcin.oakpal.api.JavaxJson

Retrieve a value as an array if the specified key is present, or empty() if not.

optFunc(Function<T, R>) - Static method in class net.adamcin.oakpal.core.Util

Deprecated.

1.3.0 use Fun.compose(Optional::ofNullable, inputFunc)

optObject(JsonObject, String) - Static method in class net.adamcin.oakpal.api.JavaxJson

Retrieve a value as an object if the specified key is present, or empty() if not.

orderedKeys() - Method in interface net.adamcin.oakpal.core.Checklist.JsonKeys

orElse(Supplier<Result<V>>) - Method in class net.adamcin.oakpal.api.Result

OsgiConfigInstallable - Class in net.adamcin.oakpal.api

Sling Installable representing an OSGi config node.

OsgiConfigInstallable(PackageId, String, Map<String, Object>, String, String) - Constructor for class net.adamcin.oakpal.api.OsgiConfigInstallable

OsgiConfigInstallableParams - Class in net.adamcin.oakpal.core.sling

OsgiConfigInstallableParams(Map<String, Object>, String, String, Exception) - Constructor for class net.adamcin.oakpal.core.sling.OsgiConfigInstallableParams

Overlaps - Class in net.adamcin.oakpal.core.checks

The overlaps check keeps track of installed package workspace filters, and checks every affected path going forward against previous workspace filters for overlap, using WorkspaceFilter.contains(String).

Overlaps() - Constructor for class net.adamcin.oakpal.core.checks.Overlaps

Overlaps.JsonKeys - Interface in net.adamcin.oakpal.core.checks

overlay(CheckSpec) - Method in class net.adamcin.oakpal.core.CheckSpec

Apply this spec's attributes as an overlay to that spec's attributes.

overrides(CheckSpec) - Method in class net.adamcin.oakpal.core.CheckSpec

Returns true if this overrides that.

P

packages() - Method in interface net.adamcin.oakpal.api.ApiConstants.ViolationKeys

PARAM_OAK_RUN_ARGS - Static variable in class net.adamcin.oakpal.maven.mojo.WebsterMojo

PARAM_REPOSITORY_HOME - Static variable in class net.adamcin.oakpal.maven.mojo.WebsterMojo

PARAM_TMPDIR - Static variable in class net.adamcin.oakpal.maven.mojo.WebsterMojo

parse(String) - Static method in class net.adamcin.oakpal.webster.CliArgParser

parseChecklists(URL) - Static method in class net.adamcin.oakpal.core.ChecklistPlanner

parseChecklists(ClassLoader) - Static method in class net.adamcin.oakpal.core.ChecklistPlanner

parseChecklists(List<File>) - Static method in class net.adamcin.oakpal.core.ChecklistPlanner

parseFromArray(JsonArray, Fun.ThrowingFunction<String, R>, BiConsumer<String, Exception>) - Static method in class net.adamcin.oakpal.api.JavaxJson

Parse string elements of an array into arbitrary objects, (like URLs).

parseQName(NamespaceMapping, QName.Type, String) - Static method in class net.adamcin.oakpal.webster.QName

path() - Method in interface net.adamcin.oakpal.core.checks.ExpectAces.JsonKeys

path() - Method in interface net.adamcin.oakpal.core.ForcedRoot.JsonKeys

PathAction - Enum in net.adamcin.oakpal.api

Enumeration of progress tracker path import action types.

Paths - Class in net.adamcin.oakpal.core.checks

Deny path imports/deletes by regular expression.

Paths() - Constructor for class net.adamcin.oakpal.core.checks.Paths

Paths.JsonKeys - Interface in net.adamcin.oakpal.core.checks

pattern() - Method in interface net.adamcin.oakpal.api.Rule.JsonKeys

perform() - Method in class net.adamcin.oakpal.webster.WebsterPlan

perform(Session) - Method in interface net.adamcin.oakpal.webster.WebsterTarget

Perform the action using the given session.

PlanBuilderParams - Interface in net.adamcin.oakpal.maven.mojo

PlanParams - Class in net.adamcin.oakpal.maven.mojo

PlanParams() - Constructor for class net.adamcin.oakpal.maven.mojo.PlanParams

plexusPluralStem(String) - Static method in class net.adamcin.oakpal.maven.component.JsonConverter

Perform plural stemming on the provided key to normalize parent and child config element names for the purpose of identifying implicit list configurations.

prefix() - Method in interface net.adamcin.oakpal.core.JcrNs.JsonKeys

preInstallUrls() - Method in interface net.adamcin.oakpal.core.OakpalPlan.JsonKeys

prepareTestPackage(String) - Static method in class net.adamcin.oakpal.testing.TestPackageUtil

prepareTestPackageFromFolder(String, File) - Static method in class net.adamcin.oakpal.testing.TestPackageUtil

prepareTestPackageFromFolder(String, File, Map<String, File>) - Static method in class net.adamcin.oakpal.testing.TestPackageUtil

primaryType() - Method in interface net.adamcin.oakpal.core.ForcedRoot.JsonKeys

principal() - Method in interface net.adamcin.oakpal.core.checks.ExpectAces.JsonKeys

principals() - Method in interface net.adamcin.oakpal.core.checks.ExpectAces.JsonKeys

printLine(Object) - Method in interface net.adamcin.oakpal.cli.Console

Monad for printing stuff to stdout.

printLineErr(Object) - Method in interface net.adamcin.oakpal.cli.Console

Monad for printing stuff to stderr.

privileges() - Method in interface net.adamcin.oakpal.core.checks.ExpectAces.JsonKeys

privilegesToJson(List<PrivilegeDefinition>, NamespaceMapping) - Static method in class net.adamcin.oakpal.core.JsonCnd

Write a list of privilege definitions to a JSON privileges object.

PrivilegeXmlExporter - Class in net.adamcin.oakpal.webster

Interface independent logic for exporting privileges.xml files from a JCR session.

PrivilegeXmlExporter.WriterOpener - Interface in net.adamcin.oakpal.webster

Function type that provides a Writer.

ProgressCheck - Interface in net.adamcin.oakpal.api

Primary point of customization for the OakPAL framework.

ProgressCheckFactory - Interface in net.adamcin.oakpal.api

A factory for creating ProgressChecks that accepts a config map.

properties() - Method in interface net.adamcin.oakpal.core.checks.JcrProperties.JsonKeys

PROTO - Static variable in class net.adamcin.oakpal.testing.oakpaltest.Handler

provideChecklists(List<Checklist>) - Method in class net.adamcin.oakpal.core.ChecklistPlanner

Q

QName - Class in net.adamcin.oakpal.webster

Representation of a Qualified Name.

QName(QName.Type, String, String, String) - Constructor for class net.adamcin.oakpal.webster.QName

Create a new QName.

QName.Type - Enum in net.adamcin.oakpal.webster

QName.UnqualifiedNameException - Exception in net.adamcin.oakpal.webster

R

readManifest(PackageId, Manifest) - Method in interface net.adamcin.oakpal.api.ProgressCheck

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

readManifest(PackageId, Manifest) - Method in class net.adamcin.oakpal.core.checks.Echo

readManifest(PackageId, Manifest) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

readNodeTypes(NamespaceMapping, List<URL>) - Static method in class net.adamcin.oakpal.core.JsonCnd

Read node types from a list of CND urls.

readReports(ReportMapper.ReaderSupplier) - Static method in class net.adamcin.oakpal.core.ReportMapper

Opens a reader, reads a json object, closes the reader, and returns a list of reports.

readReportsFromFile(File) - Static method in class net.adamcin.oakpal.core.ReportMapper

Read reports from a file and return a list of check reports.

register() - Static method in class net.adamcin.oakpal.testing.oakpaltest.Handler

REPO_INIT_FACTORY_PID - Static variable in class net.adamcin.oakpal.core.sling.SlingRepoInitScripts

repoInits() - Method in interface net.adamcin.oakpal.core.Checklist.JsonKeys

repoInits() - Method in interface net.adamcin.oakpal.core.OakpalPlan.JsonKeys

repoInitUrls() - Method in interface net.adamcin.oakpal.core.OakpalPlan.JsonKeys

reportAllOverlaps() - Method in interface net.adamcin.oakpal.core.checks.Overlaps.JsonKeys

ReportCollector - Class in net.adamcin.oakpal.api

Simple collector of violations for use by ProgressCheck implementations.

ReportCollector() - Constructor for class net.adamcin.oakpal.api.ReportCollector

reporting(Consumer<SimpleViolation.Builder>) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck

Report a violation with a customizing consumer function.

ReportMapper - Class in net.adamcin.oakpal.core

Serialize violations to/from json.

ReportMapper.JsonKeys - Interface in net.adamcin.oakpal.core

ReportMapper.ReaderSupplier - Interface in net.adamcin.oakpal.core

Functional interface that indicates that the consuming method will open AND close the stream for reading.

ReportMapper.WriterSupplier - Interface in net.adamcin.oakpal.core

Functional interface that indicates that the consuming method will open AND close the stream for writing.

reports() - Method in interface net.adamcin.oakpal.core.ReportMapper.JsonKeys

reportsToJson(Collection<CheckReport>) - Static method in class net.adamcin.oakpal.core.ReportMapper

Transforms a collection of CheckReports to a JsonArray

reportsToJsonObject(Collection<CheckReport>) - Static method in class net.adamcin.oakpal.core.ReportMapper

Transforms a collection of CheckReports to a JsonArray assigned to a key ReportMapper.JsonKeys.reports() in an outer object.

reportViolation(Violation) - Method in class net.adamcin.oakpal.api.ReportCollector

reportViolation(Violation) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck

reportViolation(Severity, String, PackageId...) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck

reportViolation(Violation) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

requireType() - Method in interface net.adamcin.oakpal.core.checks.JcrPropertyConstraints.JsonKeys

resolveArtifacts(List<Dependency>, boolean) - Method in interface net.adamcin.oakpal.maven.mojo.MojoWithRepositoryParams

resolveDependencies(List<Dependency>, boolean) - Method in interface net.adamcin.oakpal.maven.mojo.MojoWithRepositoryParams

resolveManifestResources(URL, List<String>) - Static method in class net.adamcin.oakpal.core.Util

resolveNodeTypeDefinitions(List<String>) - Static method in class net.adamcin.oakpal.core.SlingNodetypesScanner

resolveNodeTypeDefinitions(List<String>, ClassLoader) - Static method in class net.adamcin.oakpal.core.SlingNodetypesScanner

resolveNodeTypeDefinitions(List<String>, List<File>) - Static method in class net.adamcin.oakpal.core.SlingNodetypesScanner

resolveToJcrNs(NamespaceMapping) - Method in class net.adamcin.oakpal.core.NamespaceMappingRequest

Resolve the retained prefixes and URIs from the provided NamespaceMapping object to produce a list of JcrNs objects (wrapped in Result types) suitable for serialization to Json.

Result<V> - Class in net.adamcin.oakpal.api

A type representing either a successful result value, or failure, with an error.

Result.Builder<V,A> - Class in net.adamcin.oakpal.api

Builds a result for a wrapped collector.

result0(Fun.ThrowingSupplier<? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingSupplier to a Supplier of Result whose success type parameter is the same as the type parameter of the Fun.ThrowingSupplier.

result1(Fun.ThrowingFunction<? super T, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingFunction to a Function over the same input type parameter, which returns a Result whose success type parameter is the same as the output type of the Fun.ThrowingFunction.

result2(Fun.ThrowingBiFunction<? super K, ? super V, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingBiFunction to a BiFunction over the same input type parameters, which returns a Result whose success type parameter is the same as the output type of the Fun.ThrowingBiFunction.

resultNothing1(Fun.ThrowingConsumer<? super T>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingConsumer to a Function over the same input type parameter, but which returns a Result of success type Nothing.

resultNothing2(Fun.ThrowingBiConsumer<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingBiConsumer to a BiFunction over the same input type parameters, but which returns a Result of success type Nothing.

retrieveNodeTypes(Session, Collection<Name>) - Static method in class net.adamcin.oakpal.webster.CndExporter

Simple method to recursively retrieve types from the provided session.

retrieveNodeTypes(Session, Collection<Name>, BiPredicate<NamePathResolver, NodeType>) - Static method in class net.adamcin.oakpal.webster.CndExporter

Simple method to recursively retrieve types from the provided session.

rootPaths() - Method in interface net.adamcin.oakpal.core.checks.SlingJcrInstaller.JsonKeys

Rule - Class in net.adamcin.oakpal.api

Standard Rule tuple capturing a rule type (include/exclude or allow/deny) and a regex pattern.

Rule(RuleType, Pattern) - Constructor for class net.adamcin.oakpal.api.Rule

Create a new rule.

Rule.JsonKeys - Interface in net.adamcin.oakpal.api

Rules - Class in net.adamcin.oakpal.api

Factory methods and defaults for Rule.

rules() - Method in interface net.adamcin.oakpal.core.checks.Paths.JsonKeys

rules() - Method in interface net.adamcin.oakpal.core.checks.Subpackages.JsonKeys

RuleType - Enum in net.adamcin.oakpal.api

Type for a Rule.

runModes() - Method in interface net.adamcin.oakpal.core.OakpalPlan.JsonKeys

S

ScanArtifactMojo - Class in net.adamcin.oakpal.maven.mojo

Scans the main project artifact by simulating package installation and listening for violations reported by the configured checks.

ScanArtifactMojo() - Constructor for class net.adamcin.oakpal.maven.mojo.ScanArtifactMojo

ScanListener - Interface in net.adamcin.oakpal.api

Defines listener notifications for beginning and end of scan common to ProgressCheck and ErrorListener.

ScanManyArtifactsMojo - Class in net.adamcin.oakpal.maven.mojo

Scans a list of artifacts by simulating package installation and listening for violations reported by the configured checks.

ScanManyArtifactsMojo() - Constructor for class net.adamcin.oakpal.maven.mojo.ScanManyArtifactsMojo

scanPackage(File...) - Method in class net.adamcin.oakpal.core.OakMachine

Perform a scan of the provided package file or files.

scanPackages(List<File>) - Method in class net.adamcin.oakpal.core.OakMachine

Execute a scan by installing each of the provided package files in sequence.

scopeNodeTypes() - Method in interface net.adamcin.oakpal.core.checks.JcrProperties.JsonKeys

scopePackageIds() - Method in interface net.adamcin.oakpal.core.checks.CompositeStoreAlignment.JsonKeys

scopePaths() - Method in interface net.adamcin.oakpal.core.checks.JcrProperties.JsonKeys

ScriptHelper() - Constructor for class net.adamcin.oakpal.core.ScriptProgressCheck.ScriptHelper

ScriptProgressCheck - Class in net.adamcin.oakpal.core

The ScriptProgressCheck uses the Invocable interface from JSR223 to listen for scan events and optionally report check violations.

ScriptProgressCheck.ScriptHelper - Class in net.adamcin.oakpal.core

ScriptHelper helps scripts to report violations by eliminating the need to import the severity enumerator type.

ScriptProgressCheck.UnregisteredScriptEngineNameException - Exception in net.adamcin.oakpal.core

ScriptRepositoryException - Exception in net.adamcin.oakpal.core

Adapter for ScriptException to satisfy listener contracts which throw RepositoryException within an Invocable.

ScriptRepositoryException(ScriptException) - Constructor for exception net.adamcin.oakpal.core.ScriptRepositoryException

Adapt a script exception.

search(Archive) - Method in class net.adamcin.oakpal.webster.FileVaultNameFinder

setArchive(Archive, File) - Method in interface net.adamcin.oakpal.webster.ArchiveAware

Provides a newly opened archive to the target for scanning.

setArtifactId(String) - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

setChecklists(List<String>) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setChecks(List<CheckSpec>) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setClassifier(String) - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

setCndNames(List<String>) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setConfig(JsonObject) - Method in class net.adamcin.oakpal.core.CheckSpec.ImmutableSpec

setConfig(JsonObject) - Method in class net.adamcin.oakpal.core.CheckSpec

Set a new config object value.

setEnablePreInstallHooks(boolean) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setErrorListener(ErrorListener) - Method in class net.adamcin.oakpal.core.sling.DefaultSlingSimulator

setErrorListener(ErrorListener) - Method in class net.adamcin.oakpal.core.sling.NoopSlingSimulator

setErrorListener(ErrorListener) - Method in interface net.adamcin.oakpal.core.sling.SlingSimulatorBackend

Provide an ErrorListener.

setForcedRoots(List<ForcedRoot>) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setGroupId(String) - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

setImpl(String) - Method in class net.adamcin.oakpal.core.CheckSpec.ImmutableSpec

setImpl(String) - Method in class net.adamcin.oakpal.core.CheckSpec

Set a new impl value.

setInlineEngine(String) - Method in class net.adamcin.oakpal.core.CheckSpec.ImmutableSpec

setInlineEngine(String) - Method in class net.adamcin.oakpal.core.CheckSpec

Set a new ScriptEngineFactory name, or null for the default.

setInlineScript(String) - Method in class net.adamcin.oakpal.core.CheckSpec.ImmutableSpec

setInlineScript(String) - Method in class net.adamcin.oakpal.core.CheckSpec

Set a new invokable script check source value.

setInstallHookPolicy(InstallHookPolicy) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setJcrNamespaces(List<JcrNs>) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setJcrPrivileges(List<String>) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setMixinTypes(List<String>) - Method in class net.adamcin.oakpal.core.ForcedRoot

setName(String) - Method in class net.adamcin.oakpal.core.CheckSpec.ImmutableSpec

setName(String) - Method in class net.adamcin.oakpal.core.CheckSpec

Set a new display name for the check.

setPackageManager(JcrPackageManager) - Method in class net.adamcin.oakpal.core.sling.DefaultSlingSimulator

setPackageManager(JcrPackageManager) - Method in class net.adamcin.oakpal.core.sling.NoopSlingSimulator

setPackageManager(JcrPackageManager) - Method in interface net.adamcin.oakpal.core.sling.SlingSimulatorBackend

Provide a JCR package manager.

setPath(String) - Method in class net.adamcin.oakpal.core.ForcedRoot

setPrefix(String) - Method in class net.adamcin.oakpal.core.JcrNs

setPreInstallArtifacts(List<DependencyFilter>) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setPreInstallFiles(List<File>) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setPrimaryType(String) - Method in class net.adamcin.oakpal.core.ForcedRoot

setRepoInitFiles(List<File>) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setRepoInits(List<String>) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setResourceBundle(ResourceBundle) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck

setResourceBundle(ResourceBundle) - Method in interface net.adamcin.oakpal.api.ViolationReporter

Called by the framework before a scan to provide a resource bundle for immediate localization of strings.

setResourceBundle(ResourceBundle) - Method in class net.adamcin.oakpal.core.DefaultErrorListener

setResourceBundle(ResourceBundle) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

setRunModes(List<String>) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setSession(Session) - Method in class net.adamcin.oakpal.core.sling.DefaultSlingSimulator

setSession(Session) - Method in class net.adamcin.oakpal.core.sling.NoopSlingSimulator

setSession(Session) - Method in interface net.adamcin.oakpal.core.sling.SlingSimulatorBackend

Provide a JCR session.

setSilenced(boolean) - Method in interface net.adamcin.oakpal.api.SilenceableCheck

If silenced is true, this check must DISABLE the collection of violations until this method is called again with silenced=false.

setSkip(boolean) - Method in class net.adamcin.oakpal.core.CheckSpec.ImmutableSpec

setSkip(boolean) - Method in class net.adamcin.oakpal.core.CheckSpec

Set to true to skip the check.

setSlingNodeTypes(boolean) - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

setTemplate(String) - Method in class net.adamcin.oakpal.core.CheckSpec.ImmutableSpec

setTemplate(String) - Method in class net.adamcin.oakpal.core.CheckSpec

Set a new template value.

setType(String) - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

setUri(String) - Method in class net.adamcin.oakpal.core.JcrNs

setVersion(String) - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

severeViolation(String, PackageId...) - Method in class net.adamcin.oakpal.api.SimpleProgressCheck

severeViolation(String, PackageId...) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck.ScriptHelper

severity() - Method in interface net.adamcin.oakpal.api.ApiConstants.ViolationKeys

Severity - Enum in net.adamcin.oakpal.api

Levels of severity for violations detected during package scans.

severity() - Method in interface net.adamcin.oakpal.core.checks.CompositeStoreAlignment.JsonKeys

severity() - Method in interface net.adamcin.oakpal.core.checks.ExpectAces.JsonKeys

severity() - Method in interface net.adamcin.oakpal.core.checks.ExpectPaths.JsonKeys

severity() - Method in interface net.adamcin.oakpal.core.checks.JcrPropertyConstraints.JsonKeys

severity() - Method in interface net.adamcin.oakpal.core.checks.Paths.JsonKeys

shallowMergeObjects(JsonObject, JsonObject) - Static method in class net.adamcin.oakpal.api.JavaxJson

Merge an overlay json object's entries into a base json object, replacing values for duplicate keys.

SilenceableCheck - Interface in net.adamcin.oakpal.api

Extended interface marking progress checks that respect a mid-scan mode that expects oakpal to temporarily silence violations triggered by scan events.

SIMPLE_DIR_PLAN - Static variable in interface net.adamcin.oakpal.core.opear.Opear

SimpleProgressCheck - Class in net.adamcin.oakpal.api

Simple implementation of a ProgressCheck with convenient methods for reporting and collecting violations.

SimpleProgressCheck() - Constructor for class net.adamcin.oakpal.api.SimpleProgressCheck

SimpleProgressCheckFactoryCheck<FACTORY extends ProgressCheckFactory> - Class in net.adamcin.oakpal.api

Convenience type for simple progress checks that are identified by their factory.

SimpleProgressCheckFactoryCheck(Class<FACTORY>) - Constructor for class net.adamcin.oakpal.api.SimpleProgressCheckFactoryCheck

Need to keep a handle on the concrete class.

SimpleReport - Class in net.adamcin.oakpal.core

Simple POJO implementing a CheckReport, used for deserialization.

SimpleReport(String, Collection<Violation>) - Constructor for class net.adamcin.oakpal.core.SimpleReport

SimpleViolation - Class in net.adamcin.oakpal.api

Simple implementation of a Violation.

SimpleViolation(Severity, String, PackageId...) - Constructor for class net.adamcin.oakpal.api.SimpleViolation

Constructor.

SimpleViolation(Severity, String, List<PackageId>) - Constructor for class net.adamcin.oakpal.api.SimpleViolation

Constructor.

SimpleViolation.Builder - Class in net.adamcin.oakpal.api

simulateSling(SlingSimulator, Set<String>) - Method in interface net.adamcin.oakpal.api.ProgressCheck

Override this method to accept an SlingSimulator to request installation of JCR resources like FileVault packages and RepositoryInitializer factory configs, as if running within a Sling repository instance.

simulateSling(SlingSimulator, Set<String>) - Method in class net.adamcin.oakpal.core.checks.Echo

simulateSling(SlingSimulator, Set<String>) - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

skip() - Method in interface net.adamcin.oakpal.core.CheckSpec.JsonKeys

skip - Variable in class net.adamcin.oakpal.maven.mojo.ScanArtifactMojo

Specifically skip this plugin's execution.

SLING_NODETYPES - Static variable in class net.adamcin.oakpal.core.SlingNodetypesScanner

SlingInstallable - Interface in net.adamcin.oakpal.api

Type representing a Sling-installable resource JCR path.

SlingInstallableParams<T extends SlingInstallable> - Interface in net.adamcin.oakpal.core.sling

Encapsulation of parameters that

SlingJcrInstaller - Class in net.adamcin.oakpal.core.checks

The SlingJcrInstaller is a check implementation that watches for Sling installable nodes and registers them with the SlingSimulator when sling simulation is active.

SlingJcrInstaller() - Constructor for class net.adamcin.oakpal.core.checks.SlingJcrInstaller

SlingJcrInstaller.JsonKeys - Interface in net.adamcin.oakpal.core.checks

SlingNodetypesScanner - Class in net.adamcin.oakpal.core

Singleton class that fetches all node type definitions from OSGi bundle MANIFEST.MF files with "Sling-Nodetypes" definitions in the classpath.

SlingOpenable<ResourceType> - Interface in net.adamcin.oakpal.api

Some sling installable resources must be opened to be read, perhaps throwing an exception, and then maybe closed.

SlingRepoInitScripts - Class in net.adamcin.oakpal.core.sling

Locates a jcr path that should be treated as an installable provider of repoinit scripts.

SlingSimulator - Interface in net.adamcin.oakpal.api

Simulates aspects of the Sling runtime.

SlingSimulatorBackend - Interface in net.adamcin.oakpal.core.sling

Interface defining internal-facing behavior for the SlingSimulator, primarily regarding the retrieval and processing of Sling JCR installable resources submitted by ProgressChecks.

startedScan() - Method in interface net.adamcin.oakpal.api.ScanListener

Called once at the beginning of the scan to notify for re-initialization of listener state.

startedScan() - Method in class net.adamcin.oakpal.api.SimpleProgressCheck

startedScan() - Method in class net.adamcin.oakpal.core.checks.Echo

startedScan() - Method in class net.adamcin.oakpal.core.ScriptProgressCheck

startedScan() - Method in class net.adamcin.oakpal.core.sling.DefaultSlingSimulator

startingWithPlan(OakpalPlan) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

stream() - Method in class net.adamcin.oakpal.api.Result

streamIt(T) - Static method in class net.adamcin.oakpal.api.Fun

What's the most efficient way to stream a single nullable element? I don't know, but maybe I randomly got it right under the hood.

streamNsPrefix(String) - Static method in class net.adamcin.oakpal.core.JsonCnd

Utility method to return a namespace prefix if a colon is present.

streamOpt(Optional<T>) - Static method in class net.adamcin.oakpal.api.Fun

Use this to transform a less useful Optional into an equivalent single-element stream.

stringToValue(String) - Static method in class net.adamcin.oakpal.maven.component.JsonConverter

Borrowed from org.json.JSONObject.

StructuredMessage - Interface in net.adamcin.oakpal.cli

Extends JsonObjectConvertible to ensure conformance with --output json.

Subpackages - Class in net.adamcin.oakpal.core.checks

Check for subpackage inclusion.

Subpackages() - Constructor for class net.adamcin.oakpal.core.checks.Subpackages

Subpackages.JsonKeys - Interface in net.adamcin.oakpal.core.checks

success(V) - Static method in class net.adamcin.oakpal.api.Result

T

tee(Consumer<? super T>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a consumer into a "tee" (like the Unix command, evoking the shape of the letter, 'T') function that passes the input argument to output after calling Consumer.accept(Object) with the input.

teeLogError() - Method in class net.adamcin.oakpal.api.Result

template() - Method in interface net.adamcin.oakpal.core.CheckSpec.JsonKeys

test(PackageId, PackageId) - Method in interface net.adamcin.oakpal.core.OakMachine.SubpackageSilencer

test(Dependency) - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

Predicate function for finding first matching dependency in a stream.

testBlock(TestUtil.TestBody) - Static method in class net.adamcin.oakpal.testing.TestUtil

testEntry(BiPredicate<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a BiPredicate to a Predicate testing Map.Entry stream elements with matching respective key and value type parameters.

testKey(Predicate<? super K>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Predicate of key types to a Predicate testing Map.Entry stream elements with a matching key type parameter.

testOrDefault1(Fun.ThrowingPredicate<? super T>, boolean) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingPredicate to a Predicate, providing a default boolean value to return if an exception is thrown.

testOrDefault2(Fun.ThrowingBiPredicate<? super K, ? super V>, boolean) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingBiPredicate to a BiPredicate, providing a default boolean value to return if an exception is thrown.

TestPackageUtil - Class in net.adamcin.oakpal.testing

FileVault Test Package Factory

TestUtil - Class in net.adamcin.oakpal.testing

Some simple utilities for scoped subtests.

TestUtil.TestBody - Interface in net.adamcin.oakpal.testing

testValue(Predicate<? super V>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Predicate of value types to a Predicate testing Map.Entry stream elements with a matching value type parameter.

throwCause(Class<E>) - Method in class net.adamcin.oakpal.api.Result

Feeling down because of too much functional wrapping? This method has you covered.

throwingMerger() - Static method in class net.adamcin.oakpal.api.Fun

A merge function for Fun.entriesToMap(BinaryOperator) and Fun.entriesToMapOfType(Supplier, BinaryOperator) that throws an IllegalStateException when merging duplicates to guarantee distinct pairs.

throwingVoidToNothing1(Fun.ThrowingConsumer<? super T>) - Static method in class net.adamcin.oakpal.api.Fun

Parallel method to Nothing.voidToNothing1(Consumer), for transforming a Fun.ThrowingConsumer to a Fun.ThrowingFunction that returns Nothing.

throwingVoidToNothing2(Fun.ThrowingBiConsumer<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun

Parallel method to Nothing.voidToNothing2(BiConsumer), for transforming a Fun.ThrowingBiConsumer to a Fun.ThrowingBiFunction that returns Nothing.

toDependency() - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

If this filter does not match a dependency, try creating one from the provided parameters and resolving it.

toDependency(String) - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

If this filter does not match a dependency, try creating one from the provided parameters and resolving it.

toEntry(K, V) - Static method in class net.adamcin.oakpal.api.Fun

An alias for creating a AbstractMap.SimpleImmutableEntry for the provided key and value.

toExpandedForm() - Method in class net.adamcin.oakpal.webster.QName

toJcrNsList(NamespaceMapping, NamespaceMappingRequest) - Static method in class net.adamcin.oakpal.core.JsonCnd

Return a list of JCR namespace pairs exported from the provided mapping.

toJson() - Method in interface net.adamcin.oakpal.api.JsonArrayConvertible

toJson() - Method in interface net.adamcin.oakpal.api.JsonObjectConvertible

toJson() - Method in class net.adamcin.oakpal.api.Rule

Serializes the rule to a JsonObject.

toJson() - Method in interface net.adamcin.oakpal.api.Violation

Serializes the Violation to a JsonObject.

toJson() - Method in class net.adamcin.oakpal.core.Checklist

Serialize the Checklist to a JsonObject for writing.

toJson() - Method in interface net.adamcin.oakpal.core.CheckReport

Serializes the report to a JsonObject.

toJson() - Method in class net.adamcin.oakpal.core.CheckSpec

toJson() - Method in class net.adamcin.oakpal.core.ForcedRoot

toJson() - Method in class net.adamcin.oakpal.core.JcrNs

toJson(List<QNodeTypeDefinition>, NamespaceMapping) - Static method in class net.adamcin.oakpal.core.JsonCnd

Write a list of qualified node types to a JSON CND object.

toJson() - Method in class net.adamcin.oakpal.core.OakpalPlan

toNamespaceMapping(List<JcrNs>) - Static method in class net.adamcin.oakpal.core.JsonCnd

Aggregate a list of Oakpal JcrNs prefix to uri mappings into a JCR NamespaceMapping object.

toOakMachineBuilder(ErrorListener, ClassLoader) - Method in class net.adamcin.oakpal.core.OakpalPlan

toOptional() - Method in class net.adamcin.oakpal.api.Result

toString() - Method in enum net.adamcin.oakpal.api.PathAction

toString() - Method in class net.adamcin.oakpal.api.Rule

toString() - Method in class net.adamcin.oakpal.api.SimpleViolation

toString() - Method in class net.adamcin.oakpal.core.Checklist

toString() - Method in class net.adamcin.oakpal.core.CheckSpec

toString() - Method in class net.adamcin.oakpal.core.ForcedRoot

toString() - Method in class net.adamcin.oakpal.core.JcrNs

toString() - Method in class net.adamcin.oakpal.core.OakpalPlan

toString() - Method in class net.adamcin.oakpal.core.SimpleReport

toString() - Method in class net.adamcin.oakpal.maven.mojo.PlanParams

toString() - Method in class net.adamcin.oakpal.webster.QName

toValue() - Method in class net.adamcin.oakpal.api.JavaxJson.Arr

toValue() - Method in interface net.adamcin.oakpal.api.JavaxJson.HasValue

toValue() - Method in class net.adamcin.oakpal.api.JavaxJson.Key

toValue() - Method in class net.adamcin.oakpal.api.JavaxJson.Obj

toValue() - Method in class net.adamcin.oakpal.api.JavaxJson.Value

toVoid1(Function<? super T, ?>) - Static method in class net.adamcin.oakpal.api.Fun

Infers a Function.apply(Object) signature as a Consumer.

toVoid2(BiFunction<? super K, ? super V, ?>) - Static method in class net.adamcin.oakpal.api.Fun

Infers a BiFunction.apply(Object, Object) signature as a BiConsumer.

traceFilter(Logger, String) - Static method in class net.adamcin.oakpal.core.Util

Logger function to inject into a stream by way of filter() method.

tryAccept(K, V) - Method in interface net.adamcin.oakpal.api.Fun.ThrowingBiConsumer

tryAccept(T) - Method in interface net.adamcin.oakpal.api.Fun.ThrowingConsumer

tryAccept(Session) - Method in interface net.adamcin.oakpal.core.OakMachine.InspectBody

tryApply(K, V) - Method in interface net.adamcin.oakpal.api.Fun.ThrowingBiFunction

tryApply(T) - Method in interface net.adamcin.oakpal.api.Fun.ThrowingFunction

tryCollect(Collector<V, A, R>) - Static method in class net.adamcin.oakpal.api.Result

Create a collector that accumulates a stream of Results into a single Result containing either: 1.

tryGet() - Method in interface net.adamcin.oakpal.api.Fun.ThrowingSupplier

tryOrDefault0(Fun.ThrowingSupplier<R>, R) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingSupplier to a Supplier, providing a default value to return if an exception is thrown.

tryOrDefault1(Fun.ThrowingFunction<? super T, R>, R) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingFunction to a Function, providing a default value to return if an exception is thrown.

tryOrDefault2(Fun.ThrowingBiFunction<? super K, ? super V, R>, R) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingBiFunction to a BiFunction, providing a default value to return if an exception is thrown.

tryOrOptional0(Fun.ThrowingSupplier<R>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingSupplier to a Supplier of the same type, wrapped in an Optional.

tryOrOptional1(Fun.ThrowingFunction<? super T, R>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingFunction to a Function of the same input type, with the output type wrapped in an Optional.

tryOrOptional2(Fun.ThrowingBiFunction<? super K, ? super V, R>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingBiFunction to a BiFunction of the same input types, with the output type wrapped in an Optional.

tryOrVoid1(Fun.ThrowingConsumer<? super T>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingConsumer to a Consumer of the same input type, that simply suppresses any exceptions if thrown.

tryOrVoid2(Fun.ThrowingBiConsumer<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingBiConsumer to a BiConsumer of the same input types, that simply suppresses any exceptions if thrown.

tryTest(K, V) - Method in interface net.adamcin.oakpal.api.Fun.ThrowingBiPredicate

tryTest(T) - Method in interface net.adamcin.oakpal.api.Fun.ThrowingPredicate

type() - Method in interface net.adamcin.oakpal.api.Rule.JsonKeys

type() - Method in interface net.adamcin.oakpal.core.checks.ExpectAces.JsonKeys

U

uncheck0(Fun.ThrowingSupplier<? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingSupplier to an unchecked Supplier of the same supplied type parameter.

uncheck1(Fun.ThrowingFunction<? super T, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingFunction to an unchecked Function of the same input and output type parameters.

uncheck2(Fun.ThrowingBiFunction<? super K, ? super V, ? extends R>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingBiFunction to an unchecked BiFunction of the same input and output type parameters.

uncheckTest1(Fun.ThrowingPredicate<? super T>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingPredicate to a Predicate of the same input type parameter.

uncheckTest2(Fun.ThrowingBiPredicate<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingBiPredicate to a BiPredicate of the same input type parameter.

uncheckVoid1(Fun.ThrowingConsumer<? super T>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingConsumer to a Consumer of the same input type parameter.

uncheckVoid2(Fun.ThrowingBiConsumer<? super K, ? super V>) - Static method in class net.adamcin.oakpal.api.Fun

Transform a Fun.ThrowingBiConsumer to a BiConsumer of the same input type parameter.

unit(A) - Static method in interface net.adamcin.oakpal.cli.IO

unwrap(JsonValue) - Static method in class net.adamcin.oakpal.api.JavaxJson

This method performs the reverse of JavaxJson.wrap(Object).

unwrapArray(JsonArray) - Static method in class net.adamcin.oakpal.api.JavaxJson

Supports JavaxJson.unwrap(JsonValue) for typed unwrapping of JsonArray to List<Object>.

unwrapObject(JsonObject) - Static method in class net.adamcin.oakpal.api.JavaxJson

Supports JavaxJson.unwrap(JsonValue) for typed unwrapping of JsonObject to Map<String, Object>.

updateChecklist(ChecklistExporter.WriterOpener, Session, Checklist, ChecklistExporter.ForcedRootUpdatePolicy) - Method in class net.adamcin.oakpal.webster.ChecklistExporter

Update a checklist (or start a new one) with the forced roots exported from the provided session.

uri() - Method in interface net.adamcin.oakpal.core.JcrNs.JsonKeys

Util - Class in net.adamcin.oakpal.core

Util.TryFunction<T,R> - Interface in net.adamcin.oakpal.core

Deprecated.

1.3.0 use Fun.ThrowingFunction

V

val(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.Arr

val(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.KeyCursor

val(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.ObjCursor

val(Object) - Static method in class net.adamcin.oakpal.api.JavaxJson

Ensures that an object reference is wrapped appropriately for use in the DSL.

val(Object) - Method in class net.adamcin.oakpal.api.JavaxJson.Value

Conveniently allows one to start an array without the use of JavaxJson.arr(Object...).

valueOf(String) - Static method in enum net.adamcin.oakpal.api.PathAction

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.adamcin.oakpal.api.RuleType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.adamcin.oakpal.api.Severity

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.adamcin.oakpal.core.checks.AcHandling.ACHandlingLevelSet

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.adamcin.oakpal.core.InstallHookPolicy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.adamcin.oakpal.webster.ChecklistExporter.ForcedRootUpdatePolicy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.adamcin.oakpal.webster.ChecklistExporter.SelectorType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.adamcin.oakpal.webster.QName.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.adamcin.oakpal.webster.targets.JsonTargetFactory

Returns the enum constant of this type with the specified name.

valueRules() - Method in interface net.adamcin.oakpal.core.checks.JcrPropertyConstraints.JsonKeys

values() - Static method in enum net.adamcin.oakpal.api.PathAction

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.adamcin.oakpal.api.RuleType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.adamcin.oakpal.api.Severity

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.adamcin.oakpal.core.checks.AcHandling.ACHandlingLevelSet

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.adamcin.oakpal.core.InstallHookPolicy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.adamcin.oakpal.webster.ChecklistExporter.ForcedRootUpdatePolicy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.adamcin.oakpal.webster.ChecklistExporter.SelectorType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.adamcin.oakpal.webster.QName.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.adamcin.oakpal.webster.targets.JsonTargetFactory

Returns an array containing the constants of this enum type, in the order they are declared.

VerifyMojo - Class in net.adamcin.oakpal.maven.mojo

Deferred reporting and reacting to oakpal check reports during the verify phase.

VerifyMojo() - Constructor for class net.adamcin.oakpal.maven.mojo.VerifyMojo

Violation - Interface in net.adamcin.oakpal.api

Report type for validations.

violationKeys() - Static method in class net.adamcin.oakpal.api.ApiConstants

ViolationReporter - Interface in net.adamcin.oakpal.api

Base interface for violation reporters.

violations() - Method in interface net.adamcin.oakpal.core.CoreConstants.CheckReportKeys

violations() - Method in interface net.adamcin.oakpal.core.ReportMapper.JsonKeys

voidToNothing1(Consumer<? super T>) - Static method in class net.adamcin.oakpal.api.Nothing

voidToNothing2(BiConsumer<? super T, ? super U>) - Static method in class net.adamcin.oakpal.api.Nothing

W

WebsterMojo - Class in net.adamcin.oakpal.maven.mojo

Execute Webster targets that read from an external Oak JCR repository to update nodetypes, privileges, and checklist files managed in a maven project.

WebsterMojo() - Constructor for class net.adamcin.oakpal.maven.mojo.WebsterMojo

WebsterPlan - Class in net.adamcin.oakpal.webster

WebsterPlan.Builder - Class in net.adamcin.oakpal.webster

WebsterPlan.FixtureProvider - Interface in net.adamcin.oakpal.webster

WebsterTarget - Interface in net.adamcin.oakpal.webster

Simple interface for executing a Webster action that generates one source files.

WebsterTargetFactory - Interface in net.adamcin.oakpal.webster

withArchiveRoot(File) - Method in class net.adamcin.oakpal.webster.WebsterPlan.Builder

withArgument(Object...) - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder

Add one or more arguments.

withArguments(List<Object>) - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder

Set arguments.

withArtifactId(String) - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

withChecklists(List<String>) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

withChecks(List<CheckSpec>) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

withClassifier(String) - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

withDescription(String) - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder

Set description.

withEnablePreInstallHooks(boolean) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

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

withEnablePreInstallHooks(boolean) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

withErrorListener(ErrorListener) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Set the single ErrorListener for the scan.

withExportNodeTypes(List<String>) - Method in class net.adamcin.oakpal.webster.ChecklistExporter.Builder

To export node types that aren't necessarily referenced in exported forced roots or in a node type selector, list them here in the same format as you would in a node type selector.

withFixtureProvider(WebsterPlan.FixtureProvider) - Method in class net.adamcin.oakpal.webster.WebsterPlan.Builder

withForcedRoot(String, String...) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Force the creation of the described root path prior to the scan.

withForcedRoot(ForcedRoot) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Force the creation of the described root path prior to the scan.

withForcedRoots(List<ForcedRoot>) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Force the creation of the described root path prior to the scan.

withForcedRoots(List<ForcedRoot>) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

withGlobalMemoryStore() - Method in class net.adamcin.oakpal.webster.WebsterPlan.Builder

withGlobalSegmentStore(File) - Method in class net.adamcin.oakpal.webster.WebsterPlan.Builder

withGroupId(String) - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

withIncludeBuiltins(boolean) - Method in class net.adamcin.oakpal.webster.CndExporter.Builder

Determines whether to included Oak and JCR builtin nodetypes in the output.

withInitStage(InitStage...) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

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

withInitStages(List<InitStage>) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Add a list of InitStages to the scan.

withInstallHookClassLoader(ClassLoader) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Provide a classloader to ImportOptions.setHookClassLoader(ClassLoader).

withInstallHookPolicy(InstallHookPolicy) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Specify an InstallHookPolicy for the scan.

withInstallHookPolicy(InstallHookPolicy) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

withInstallHookProcessorFactory(InstallHookProcessorFactory) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Provide an InstallHookProcessorFactory.

withJcrCustomizer(OakMachine.JcrCustomizer) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

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

withJCRName(String) - Method in class net.adamcin.oakpal.core.NamespaceMappingRequest.Builder

Retain the namespace prefix or uri associated with the provided JCR name.

withJcrNamespaces(List<JcrNs>) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

withJcrNamespaces(List<JcrNs>) - Method in class net.adamcin.oakpal.webster.ChecklistExporter.Builder

Provide a list of JCR namespace prefix mappings to register or remap before performing the operations.

withJcrNodetypes(List<QNodeTypeDefinition>) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

withJcrPrivileges(List<PrivilegeDefinition>) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

withMixinTypes(String...) - Method in class net.adamcin.oakpal.core.ForcedRoot

withNodeStoreSupplier(Supplier<NodeStore>) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Specify a supplier that will produce a NodeStore for the scan.

withNodeTypeFilters(List<Rule>) - Method in class net.adamcin.oakpal.webster.ChecklistExporter.Builder

In situations where a checklist is only concerned with a subset of node types, use this method to exclude irrelevant types from the output.

withNs(String, String) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Register an additional JCR namespace prior to the scan.

withNs(List<JcrNs>) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Register additional JCR namespaces prior to the scan.

withOrderedCndUrl(URL...) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Provide a list of cnd resources to install, in order.

withOrderedCndUrls(List<URL>) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Provide a list of cnd resource URLs to install, in order.

withPackage(PackageId...) - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder

Add one or more packageIds.

withPackages(List<PackageId>) - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder

Set package ids.

withPackagingService(Packaging) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

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

withPath(String) - Method in class net.adamcin.oakpal.core.ForcedRoot

withPreInstallPackage(File...) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Deprecated.

1.3.1 pre-install packages are now handled as URIs

withPreInstallPackages(List<File>) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Deprecated.

1.3.1 pre-install packages are now handled as URIs

withPreInstallUrl(URL...) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Provide a list of package files to install before each scan.

withPreInstallUrls(List<URL>) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Provide a list of package files to install before each scan.

withPreInstallUrls(List<URL>) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

withPrimaryType(String) - Method in class net.adamcin.oakpal.core.ForcedRoot

withPrivilege(String...) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Register an additional JCR privilege prior to the scan.

withPrivilegeDefinition(PrivilegeDefinition...) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Register an additional JCR privilege prior to the scan.

withPrivilegeDefinitions(Collection<PrivilegeDefinition>) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Register an additional JCR privilege prior to the scan.

withPrivileges(Collection<String>) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Register an additional JCR privilege prior to the scan.

withProgressCheck(ProgressCheck...) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Set a single instance of ProgressCheck for the scan.

withProgressChecks(ProgressCheck...) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Deprecated.

1.4.0 use OakMachine.Builder.withProgressCheck(ProgressCheck...) instead.

withProgressChecks(List<? extends ProgressCheck>) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Set the list of ProgressChecks for the scan.

withQName(Name) - Method in class net.adamcin.oakpal.core.NamespaceMappingRequest.Builder

Retain the namespace uri associated with the provided qualified name.

withQNodeTypes(List<QNodeTypeDefinition>) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Provide a list of QNodeTypeDefinitions to register.

withRepoInitProcesser(OakMachine.RepoInitProcessor) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Provide a RepoInitProcessor.

withRepoInits(List<String>) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Provide a list of inline repoinit scripts, replacing any that have already been added.

withRepoInits(List<String>) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

withRepoInitUrls(List<URL>) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Provide a list of repoinit URLs to apply, in order.

withRepoInitUrls(List<URL>) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

withRetainBuiltins(boolean) - Method in class net.adamcin.oakpal.core.NamespaceMappingRequest.Builder

Specify whether Oak-builtin namespace mappings (i.e.

withRetainPrefix(String) - Method in class net.adamcin.oakpal.core.NamespaceMappingRequest.Builder

Specify a namespace prefix that should be retained by the request.

withRetainUri(String) - Method in class net.adamcin.oakpal.core.NamespaceMappingRequest.Builder

Specify a namespace uri that should be retained by the request.

withRunModes(Set<String>) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Provide a set of simulated sling run modes.

withRunModes(List<String>) - Method in class net.adamcin.oakpal.core.OakpalPlan.Builder

withScopeExportNames(List<Rule>) - Method in class net.adamcin.oakpal.webster.CndExporter.Builder

Define scope for export of desired nodetypes.

withScopePaths(List<Rule>) - Method in class net.adamcin.oakpal.webster.ChecklistExporter.Builder

Limit the scope of exported forced root paths using a list of Rule patterns.

withScopeReplaceNames(List<Rule>) - Method in class net.adamcin.oakpal.webster.CndExporter.Builder

Define scope for replacement of existing nodetypes in input file.

withSeverity(Severity) - Method in class net.adamcin.oakpal.api.SimpleViolation.Builder

Set severity.

withSlingSimulator(SlingSimulatorBackend) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

Provide a sling simulator

withSubpackageSilencer(OakMachine.SubpackageSilencer) - Method in class net.adamcin.oakpal.core.OakMachine.Builder

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.

withTarget(WebsterTarget...) - Method in class net.adamcin.oakpal.webster.WebsterPlan.Builder

withTargets(List<WebsterTarget>) - Method in class net.adamcin.oakpal.webster.WebsterPlan.Builder

withType(String) - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

withUnorderedCndUrl(URL...) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Provide a list of cnd resources to install.

withUnorderedCndUrls(List<URL>) - Method in class net.adamcin.oakpal.core.InitStage.Builder

Provide a list of cnd resource names to install.

withVersion(String) - Method in class net.adamcin.oakpal.maven.mojo.DependencyFilter

wrap(Object) - Static method in class net.adamcin.oakpal.api.JavaxJson

Ensures that a Java typed object is wrapped with the appropriate JsonValue type.

wrapSessionReadOnly(Session) - Static method in class net.adamcin.oakpal.core.Util

Public utility method to wrap an existing session with a facade that blocks writes.

wrapWithAlias(ProgressCheck, String) - Static method in class net.adamcin.oakpal.core.Locator

Rename the provided package check with the provided alias.

writeNodetypes(File, Session, List<String>) - Method in class net.adamcin.oakpal.webster.CndExporter

Serialize the desired nodetypes as a CND exported from the provided Session to the provided cndFile.

writeNodetypes(CndExporter.WriterOpener, Session, List<String>, File) - Method in class net.adamcin.oakpal.webster.CndExporter

Serialize the desired nodetypes as a CND to the provided stream writer.

writePrivileges(PrivilegeXmlExporter.WriterOpener, Session, List<String>, boolean) - Static method in class net.adamcin.oakpal.webster.PrivilegeXmlExporter

Serialize the desired privileges as an XML document to the provided stream writer.

writeReports(Collection<CheckReport>, ReportMapper.WriterSupplier) - Static method in class net.adamcin.oakpal.core.ReportMapper

writeReportsToFile(Collection<CheckReport>, File) - Static method in class net.adamcin.oakpal.core.ReportMapper

Z

zipKeysWithValueFunc(Function<? super K, ? extends V>) - Static method in class net.adamcin.oakpal.api.Fun

Zips stream elements into Map.Entry elements as keys, with values mapped from the provided function, which can, for example, be a Map.get(Object) method reference to perform a lookup.

zipValuesWithKeyFunc(Function<? super V, ? extends K>) - Static method in class net.adamcin.oakpal.api.Fun

Zips stream elements into Map.Entry elements as values, with keys mapped from the provided function, which can, for example, be a Map.get(Object) method reference to perform a lookup.

A B C D E F G H I J K L M N O P Q R S T U V W Z