All Classes and Interfaces
Class
Description
Console...Implements a generic abstract artifact
Implements the 'ls' command.
AbstractCommand...VaultUserConfig...AbstractCommand...Abstract package dependency resolver supporting Maven repository dependency location URIs (starting with
maven:).Encapsulates Maven coordinates groupId, artifactId, version, packaging (default
zip), classifier (optional)Generic context for exporters
AbstractJcrFsCommand provides base functionality for JcrFs
commands.Abstraction for shared methods of PackageRegistry & InternalPackageRegistry implementations
AbstractJcrFsCommand provides base functionality for JcrFs
commands.JcrFsConfig...AccessControlHandling defines the behavior when importing
access control nodes.AccessType...AccessControlManagement...Listener that receive packaging events and logs them to the activity log.
Utility class to check if a session has administrative permissions (e.g. to check if a package can be installed)
Aggregate...Implements methods for creating a new
AggregateImplJcrCWO...Implements a console/shell that operates on a jcrfs.
Collects the items that form an aggregate.
AggregateManager...The artifact manager exposes an artifact node tree using the configured
aggregators and serializers.
Defines an artifact aggregator.
List of configured aggregators that selects one given a repository node.
Specifies a FileVault archive.
Entry of an archive
Implements a
ValidationContext based on a given Archive.Wrapper class that hides all implementation details from the underlying archive.
An artifact represents a fragment (or aspect) of a Vault file.
ArtifactHandlers are used to import artifacts into the
jcr repository.ArtifactIterator...ArtifactSet...Implements a set of artifacts.
Provides a simple enumeration of possible artifact types.
AutoSave...Implements an item filter that matches if a node only has the primary
properties: jcr:primaryType, jcr:mixinTypes, jcr:uuid, jcr:created and
jcr:createdBy
BinaryCheckOutputStream...A supplier wrapper which caches the supplied values.
Listener that is called for each line in a document.
Command Line Command
Highly customized help formatter to work with
CliCommands.Implements the 'add' command.
Implements the 'get' command.
CmdCd...Implements the 'checkout' command. there are 2 forms, either:
co rmi://localhost/crx.default/apps/components
or:
co --mountpoint=rmi://localhost/crx.default /apps/components
Implements the 'checkout' command. there are 2 forms, either:
co rmi://localhost/crx.default/apps/components
or:
co --mountpoint=rmi://localhost/crx.default /apps/components
Implements the 'export' command.
Implements the 'connect' command.
CmdShell...CmdExit...Implements the 'export' command.
Implements the 'delete' command.
Implements the 'diff' command.
Implements the 'diconnect' command.
Implements the 'mount' command.
CmdEnv...Implements the 'exec' command.
CmdExit...Implements the 'export' command.
Implements the 'export' command.
Implements the 'get' command.
CmdExit...CmdExit...Implements the 'import' command.
Implements the 'import' command.
Implements the 'info' command.
Implements the 'get' command.
CmdLs...Implements the 'mount' command.
Implements the 'unmount' command.
CmdLs...Implements the 'ls' command.
Implements the 'ls' command.
Implements the 'ls' command.
Implements the 'get' command.
Implements the 'mount' command.
Implements the 'export' command.
Implements the 'export' command.
Implements the 'propset' command.
Implements the 'put' command.
CmdEnv...Implements the 'rcp' command.
Implements the 'get' command.
Implements the 'resolved' command.
Implements the 'revert' command.
Implements the 'rm' command.
Implements the 'get' command.
CmdSetenv...Implements the 'status' command.
CmdLs...Implements the 'tree' command.
Implements the 'unmount' command.
Implements the 'update' command.
Implements the 'export' command.
CNDReader...Generic interface for a CND writer.
Helper class that allows to chain post processors.
Package registry wrapping a number of
PackageRegistry instances.CredentialsProvider...ConfigHelper...ConfigurationException...Console...Command...Console...FSContext...ConsoleFileSystem...Defines some (file) name constants.
CredentialsConfig...CredentialsProvider...CredentialsProvider...CyclicDependencyException...Filter that checks the declared type of an item
Provides a default output for a diff.
Provides a default document source
Abstracts the way of accessing the vault specific meta-info of a checkout.
DefaultNodeTypes...Very simple class that reads basic package info from a file.
The default path filter provides hierarchical filtering.
DefaultProgressListener...Holds a list of
PathFilterSets.Implements a package dependency reference.
DependencyException...Defines how package dependencies influence package installation and un-installation.
Reports dependency usages.
UsageReportImpl...Resolve the main meta information of a package dependency.
Dependency Utilities
Implements a filter that filters item according to their (passed) depth.
A class to compare vectors of objects.
The result of the diff.
Implements a writer that provides an additional method
DiffWriter.writeNewLine()
that can be used for writing line separators which can be defined.Implements a generic directory artifact.
A document represents a list of elements and have a source.
The annotated element include the document source.
Elements form a document.
The document diff is used to create a diff between 2 documents.
Implements a tree-way diff between a base document and 2 dervied ones.
DocumentSource...Validator interface for (enhanced) Document View XML files within content packages.
DocViewAnalyzerListener...This class provides access to the commonly used doc view xml format and functionality that checks files for the format or reformats them
accordingly.
Deprecated.
Helper class that represents an immutable JCR node abstraction encapsulating multiple
DocViewProperty2 properties.This is a thread-safe SAX parser which deals with FileVault Document View XML files
and passes them to a given
DocViewParserHandler.Thrown in case the XML is not
well-formed or
no valid docview format.
Handler to be used with
DocViewParser.Deprecated.
Use
DocViewProperty2 instead.Immutable helper class that represents a JCR property in the FileVault (enhanced) document view format.
Similar to
QNameComparator but acting on DocViewProperty2 leveraging its name and a given namespace resolverDumpable...DumpHandler...Effective node type as defined by JCR 2.0, Chapter 3.7.6.5.
The elements factory provides elements for a document
ExampleHook...Example hook that uses a class provided by the webapp (org.apache.sling.api.resource.ResourceUtil)
and/or osgi and is not explicitly imported by the vault bundle
Console...ExecutionException is used by commands reporting failure.Holds a list of tasks that perform package installation related operations.
Helps to construct an execution plan that can be serialized and given to the packaging backend for execution.
ExecutionPlanBuilderImpl...ExecutionPlanImpl...Marker interface that denotes an artifact that is exported by jcr fs.
Provides information about an export
Holds options used for exporting.
Defines a post processor that is invoked after a package is assembled.
Represents the root of a vault export or a vlt checkout. it has the following
structure:
The file action represents an action that was performed on a file.
Implements an archive based on the file system
FileDocumentSource...Defines an filter that matches file/folder like nodes.
Implements a input source that is based on a
File.FileList...Filter...The item filter set holds a set of item filters each attributed as include
or exclude filter.
Holds a filter entry
Validator interface for package filters.
StAX XML Stream Writer filter.
Internal (immutable) state object for a package to cache and pass the relevant metadata around.
FileSystem based registry not depending on a JCR Session.
Internal Status a package may have in
FSPackageRegistryRegistry package based on the
FSPackageRegistry.Low-level validator interface for all files below jcr_root.
Low-level validator interface for all files below META-INF (including
vault/filter.xml and vault/properties.xml).HelloWorldApp...Implements a generic hint artifact.
Implements a vault package that is a hollow representation of a file vault
export i.e. when original zipped representation has been truncated.
HtmlProgressTrackerListener implements a progress tracker listener that writes the progress in HTML.A hunk records a block of diff between the left and the right document.
A hunk3 represents a block of a change from the 3-way diff. it can either be
a modification on the left side (for which
Hunk3.getLeftRange() is not
null), or a change on the right side (for which
Hunk3.getRightRange() is not null. if the left and the right
ranges are null this hunk represents an unmodified block of the
base document. if both ranges are NOT null it represents a
conflicting block.Defines the handling of IDs on import.
Ignored...Marker interface that denotes an artifact that is imported into jcr fs.
Imports an
Archive into a repository.ImportInfo...The detailed information about an imported path
The modification type
ImportMode is used to define how importing content is applied
to the existing content in the repository.Option that control the package import.
An input stream pump feeds a
InputStreamPump.Pump in a dedicated thread with the input read from
the given input stream.The install context is passed to
InstallHooks during the different
phases of a package installation.The current phase of a package installation
InstallContextImpl...An install hook is used to do some pre and post work during a package
install. the hooks need to have at least one class that implements this
interface. the class is identified by the normal "Main-Class" manifest
property and needs to be instantiatable.
The install hook processor is used for handle the install hooks, from registration to execution.
InstallHookProcessorFactory...processor for install hooks
IsNodeFilter...Item filter that checks if an item is a node.
The item filter is used to include or exclude a set of repository items.
The item filter set holds a set of item filters each attributes as include
or exclude filter.
Deprecated.
Use
ItemNameComparator2 insteadOrders items by their qualified name by using
QNameComparator.Implements a Vault filesystem exporter that exports Vault files to a jar file.
Implements an archive that is based on nt:file/nt:folder nodes in a JCR
repository.
This Interface defines some of the item names that are defined in the
jcr spec 2.0 and some that are used in the cq5 platform, using the default
prefixes 'cq', 'jcr', 'nt' and 'mix'.
Implements a Vault filesystem exporter that exports Vault files to a JCR
repository.
A Vault package stored in the repository.
Specifies the interface of a package definition stored in the repository.
The JCR package definition is used to operate with a unwrapped package
in the repository.
Only limited meta information like package properties and filters are exposed which are available
from the underlying package definition node.
Implements a JcrPackage
Extends the
PackageManager by repository specific operations.Extends the
PackageManager by JCR specific methodsJcrPackagePersistence...Validator interface for validating file paths for files and folders below
jcr_root.JcrRegisteredPackage...Specifies the JCR Version
JcrWorkspaceFilter implements serializations of a workspace
filter that is stored in the repositoryImplements an element factory that creates elements from the lines of an
input text.
An element that is based on a string but ignores the whitespaces in the
equals method.
An element that is based on a string
todo: create non-annotated varian
Provides an input stream wrapper that detects line feed sequences and
replaces them by new ones.
Provides an output stream wrapper that detects line feed sequences and
replaces them by new ones.
Implements an archive wrapper that remaps the entries of an underlying archive using a
PathMapping.MD5...Implements an
InputStreamPump.Pump that extracts the relevant parts from the input stream into memory.Provides an abstraction of a virtual directory that holds additional information about the files under vault
control.
Provides an abstraction for a file of a
MetaDirectory.MetaFileDocSource...Abstracts the way of accessing the vault specific meta-info of a checkout.
Validator interface for validating file paths for files and folders
below META-INF.
MimeTypes contains a mapping from extensions to mime types.Utility method to mount a JCR FS.
Implements a path mapping that supports multiple symlinks
Filters items according to their names.
Utility methods to generate JCR names in the Expanded Form.
Meta information about a node:
JCR path
file system path of the file which defined the node
optionally line and column in the the file which defined the node
ItemNameComparator...SiblingNames...Validator interface for validating node paths.
NodeTypeInstaller...Filters on the node type of a node.
NodeTypesCollector...Defines a generic set of node types.
SAX filter which
orders attributes alphabetically
strips ignorable whitespace (works even without schema/DTD: all characters in FileVault can be stripped because all elements are supposed to be empty)
removes leading comments (prior to root element) due to bug in SAX2StAXStreamWriter in Java
Exception for errors where a specified package does not exist
The nt file item filter matches all properties that are defined my the
nt:file or nt:resource node type. the later only, if the respective nodes
name is 'jcr:content'.
Provides access to either system properties or bundle context properties (if running inside an OSGi container)
Validator interface for OSGi configurations in any of the serialization formats supported by
Sling Configuration Installer Factory.
Event that is sent via the packaging listeners.
Event type
Internal service that is used to dispatch packaging events.
Packaging observation helper
Listener that can receive packaging events.
Generic exception for package related operations.
Exception thrown if a specified package already exist.
PackageId provides the basic metrics for identifying a package.Exposes the main meta information about a package
The package manager is used to deal with packages. the following operations
are defined:
open
read underlying data and validate them
close
release underlying data. the package is unusable afterwards
upload
import the package from a binary source to the system. for example
create a new jcr node structure or create a file.
Implements the package manager
PackageManagerMBean...PackageManagerMBeanImpl provide a MBean that lists all available packages as tabular data.The package properties provide extra/meta information about the package to install.
package properties abstraction
The package registry is the next generation
PackageManager and
JcrPackageManager.Describes a package operation task.
Task state
Task type
ExecutionTaskBuilder...PackageTaskImpl...Specifies the type of the package.
Default access point to package managers.
PackagingImpl...Default access point to package managers for non OSGi clients.
PathComparator...The item filter is used to include or exclude a set of paths.
The path filter set holds a set of path filters each attributes as include
or exclude filter.
Provides an interface for a general path mapping.
PathUtil...Implements a console/shell that operates on a jcrfs.
Implements a Vault filesystem exporter that exports Vault files to a platform
file system.
PlatformFile...Implements a repository to platform name formatter.
PomProperties...Defines a set of privilege definitions together with the used namespaces
NodeTypeInstaller...ProgressTracker...A
ProgressTrackerListener can be provided by clients to
receive messages and errors during operations.Message mode
Validator interface for package properties.
Implements a artifact that is based on a property value.
Compares based on prefixes and local names as follows:
first ns prefixes
then prefixed names
only afterwards non-prefixed names
The latter case does not matter for the order, except when two names are equal.
Specifies a range in a document
RcpTask...RcpTaskManager...RcpTaskManager...Implements a path mapping that supports regular expressions, i.e.
RegisteredPackage...Registry...Default handler with special entity resolver that handles all entity resolution requests by returning an empty input
source.
Entity resolver that handles all entity resolution requests by returning an empty input source.
Implements a console/shell that operates on a jcrfs.
The repository address locates a jcr repository in with a URI representation.
RepositoryWorkObject...Repository Copier that copies content from a source to a destination repository.
RepositoryProvider...RepositoryProvider...Workspace filter wrapper that limits the filter in- or outside certain paths.
Provides a simple enumeration of possible serialization types.
Serializer...Implements an output artifact that is based on a serializer, i.e. the
preferred access method is
AccessType.SPOOLDefines a general provider for the JCR version specific services such as node
type management and access control handling.
StaticServiceProvider...Deprecated.
Rather use
MessageDigest.getInstance(String)HelloWorldApp...SimpleCredentialsConfig...Implements a simple path mapping that strips and prefixes a path.
A
ManagerProvider which works without an underlying JCR repository.Implements an archive that is based on a sub-tree of another archive
Helper class to handle sub-package exporting for non /etc/package package roots
Archive filter that suppresses the sub packages via the normal tree and allows to extract them individually.
The sub package handling specifies how sub package are handled during recursive package installation.
The sub package option
Implements a
ValidationContext based on a sub package given through an Archive.SyncConfig...SyncConstants...SyncHandler...SyncLog...SyncResult...Table...TempFileInputStream...Text...Deprecated.
Use
Text insteadProvides transactional brackets around a write back transaction to
the Vault filesystem.
Tree...TreeSync...Adds helper methods to a wrapped Map containing objects of different types.
Wraps a
RepositoryException with an unchecked exception.Wraps a
ValueFormatException with an unchecked exception.UserManagement...The validation context encapsulates information about the package for which the validation is triggered.
Provides methods to call all registered validators.
Creates
ValidationExecutors.Class encapsulating the actual message together with a
ValidationMessageSeverity.The severity of a
ValidationMessage.A ValidationViolation is a
ValidationMessage enriched with additional meta information like
validator idBase interface for all validators.
Each
Validator is created via the according factory.Settings relevant for one
ValidatorFactory.Comparator for values
VaultUserConfig...Representation of a node serialization in
VaultFileSystem.FileUtil...Implements the bridge between the repository based artifacts nodes and their
file system representation as a collection of artifacts.
Implements an input stream on a jcr file file.
The jcr file node combines the aggregates with the Vault file. each file
node produces a list of jcr files, composed out of the artifacts on the
artifacts node. the Vault files are the inserted into the overall hierarchy
of the Vault filesystem.
VaultFileOutput...Provides methods for writing jcr files.
The file system containing a repository export.
The Vault filesystem provides an additional abstraction layer on top of the
artifacts manager tree.
Implements a console/shell that operates on a jcrfs.
OsWorkObject...VaultFsConfig...JcrFsConsole...Implements a console/shell that operates on a jcrfs.
Implements a console/shell that operates on a jcrfs.
VaultFsTransaction...the transaction info
Extends the
InputSource by a content length and last modified.Defines a vault package.
VaultUserConfig...VaultSyncServiceImpl...Implements a package version.
Implements a version range
The string representation is either
the empty string, which means all versions match
or a simple version string consisting of arbitrarily many alphanumeric segments separated by
..VaultContext...VltDirectory...The vault entries provide meta information about the entries under vault control.
Represents an entry in
VltEntriesDescribes the state of an entry
Entry...VaultException...Implements a console/shell that operates on a jcrfs.
VltFile...Possible state of this file
Implements an element factory that creates the elements out from words of
the given input stream.
WorkspaceFilter defined a filter for items (node or property).Analyzes a xml source and guesses the type. the following types are
recognized:
SerializationType.GENERIC if the source is not a valid XML
SerializationType.XML_GENERIC if the XML type is not known. eg. a user-xml
SerializationType.XML_DOCVIEW if the XML is a docview serialization
Please note, that the docview serialization is recognized if the first
element contains a jcr:primaryType attribute.Implements an archive that is based on a zip file.
Archive leveraging Java NIO File and its Zip File System Provider.
Implements an archive based on a zip stream, but deflates the entries first into a buffer and later into a temporary
file, if the content length exceeds the buffer size.
Implements a vault package that is a zipped representation of a file vault
export.
DocViewNode2instead.