net.adamcin.oakpal.core

Class OakpalPlan

java.lang.Object

net.adamcin.oakpal.core.OakpalPlan

All Implemented Interfaces:

JsonObjectConvertible

public final class OakpalPlan
extends Object
implements JsonObjectConvertible

A plan is a reproducible execution plan, similar in design to a Checklist, but with the following differences: 1. Identified by URL, supporting retrieval on the classpath. 2. No support for referencing external CND files. 3. Can reference pre-install packages by URL. 4. Can not aggregate multiple plans per execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OakpalPlan.Builder
static interface	OakpalPlan.JsonKeys

Field Summary

Fields

Modifier and Type	Field and Description
static URL	BASIC_PLAN_URL Preferred default plan when no custom classpath is specified, and no plan name is specified.
static String	DEFAULT_PLAN_NAME When otherwise unspecified, the default name for a plan should be plan.json.
static URL	EMPTY_PLAN_URL Preferred default plan when a custom classpath is specified without specifying a plan name.

Method Summary

Modifier and Type	Method and Description
static OakpalPlan	fromJson(@NotNull javax.json.JsonObject json) Constructs an OakpalPlan without a base url or a name.
static Result<OakpalPlan>	fromJson(@NotNull URL jsonUrl)
URL	getBase()
List<String>	getChecklists()
List<CheckSpec>	getChecks()
List<ForcedRoot>	getForcedRoots()
InstallHookPolicy	getInstallHookPolicy()
List<JcrNs>	getJcrNamespaces()
List<org.apache.jackrabbit.spi.QNodeTypeDefinition>	getJcrNodetypes()
List<org.apache.jackrabbit.spi.PrivilegeDefinition>	getJcrPrivileges()
String	getName()
javax.json.JsonObject	getOriginalJson()
List<URL>	getPreInstallUrls()
List<String>	getRepoInits()
List<URL>	getRepoInitUrls()
List<String>	getRunModes()
boolean	isEnablePreInstallHooks()
static @NotNull OakpalPlan.JsonKeys	keys()
javax.json.JsonObject	toJson()
OakMachine.Builder	toOakMachineBuilder(@Nullable ErrorListener errorListener, @NotNull ClassLoader classLoader)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_PLAN_URL

public static final URL EMPTY_PLAN_URL

Preferred default plan when a custom classpath is specified without specifying a plan name. This is also the preferred plan when a user indicates that NO plan should be used.

This should not be used as a default when a plan name is specified by a user, but is not found.

BASIC_PLAN_URL

public static final URL BASIC_PLAN_URL

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

This should not be used as a default when a plan name is specified by a user, but is not found.

DEFAULT_PLAN_NAME

public static final String DEFAULT_PLAN_NAME

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

See Also:

Constant Field Values

Method Detail

keys

@NotNull
public static @NotNull OakpalPlan.JsonKeys keys()

getBase

public URL getBase()

getName

public String getName()

getOriginalJson

public javax.json.JsonObject getOriginalJson()

getRunModes

public List<String> getRunModes()

getChecklists

public List<String> getChecklists()

getPreInstallUrls

public List<URL> getPreInstallUrls()

getJcrNamespaces

public List<JcrNs> getJcrNamespaces()

getJcrNodetypes

public List<org.apache.jackrabbit.spi.QNodeTypeDefinition> getJcrNodetypes()

getJcrPrivileges

public List<org.apache.jackrabbit.spi.PrivilegeDefinition> getJcrPrivileges()

getForcedRoots

public List<ForcedRoot> getForcedRoots()

getChecks

public List<CheckSpec> getChecks()

isEnablePreInstallHooks

public boolean isEnablePreInstallHooks()

getInstallHookPolicy

public InstallHookPolicy getInstallHookPolicy()

getRepoInitUrls

public List<URL> getRepoInitUrls()

getRepoInits

public List<String> getRepoInits()

toJson

public javax.json.JsonObject toJson()

Specified by:

toJson in interface JsonObjectConvertible

toString

public String toString()

Overrides:

toString in class Object

toOakMachineBuilder

public OakMachine.Builder toOakMachineBuilder(@Nullable
                                              @Nullable ErrorListener errorListener,
                                              @NotNull
                                              @NotNull ClassLoader classLoader)
                                       throws Exception

Throws:

Exception

fromJson

public static OakpalPlan fromJson(@NotNull
                                  @NotNull javax.json.JsonObject json)

Constructs an OakpalPlan without a base url or a name.

Parameters:

json - the json object to read.

Returns:

an OakpalPlan, guaranteed

fromJson

public static Result<OakpalPlan> fromJson(@NotNull
                                          @NotNull URL jsonUrl)