# Package org.modeshape.jcr

- Interface Summary
  Interface | Description
  --- | ---
  Connectors.PathMappings | The immutable mappings between the (federated) repository nodes and the external nodes exposed by a connector that they project.
  Environment | A basic environment in which a repository operates.
  InfinispanUtil.Combiner<T> | The interface that defines how the results should be merged
  InfinispanUtil.Sequence<T> | A sequence of values.
  ModeShapePermissions | The set of constants that can be used for action literals with the `Session.checkPermission(String, String)` method.
  ModeShapeRoles | ModeShape currently defines three roles: `readonly`, `readwrite`, and `admin`.
  NodeTypes.Listener |
  NodeTypes.NodeDefinitionSet | A set of child node definitions under a parent with a specific primary type and optional mixin types.
  NodeTypes.Supplier |
  Sequencers.WorkQueue |
  Upgrades.Context |

- Class Summary
  Class | Description
  --- | ---
  AccessControlManagerImpl | AccessControlManager implementation.
  BackupDocumentReader | A utility that writes `Document` instances to one or more sequential files in a backup directory.
  BackupDocumentWriter | A utility that writes `Document` instances to one or more sequential files in a backup directory.
  BackupObserver | A `ChangeSetListener` that captures the changes being made in a repository, forwarding the node and property changes to the supplied queue, and capturing the set of binary keys that are marked as being used or unused.
  BackupService | A service used to generate backups from content and restore repository content from backups.
  BackupService.Activity | An abstract activity used for the various backup and restore operations.
  BackupService.BackupActivity | The `BackupService.Activity` subclass that performs content backup operations.
  BackupService.FieldName |
  BackupService.RestoreActivity | The `BackupService.Activity` subclass that performs content restore operations.
  CndI18n | The internationalized string constants for the `org.modeshape.cnd*` packages.
  CndImporter | A class that imports the node types contained in a JCR Compact Node Definition (CND) file into `NodeTypeDefinition` instances.
  CndTokenizer | A `TokenStream.Tokenizer` implementation that adheres to the CND format by ignoring whitespace while including tokens for individual symbols, the period ('.'), single-quoted strings, double-quoted strings, whitespace-delimited words, and optionally comments.
  Connectors | Class which maintains (based on the configuration) the list of available connectors for a repository.
  Connectors.AbstractPathMappings |
  Connectors.BasicPathMappings |
  Connectors.EmptyPathMappings |
  Connectors.LocalDocumentStoreExtraProperties |
  Connectors.PathMapping |
  ExecutionContext | An ExecutionContext is a representation of the environment or context in which a component or operation is operating.
  ExtensionLogger | Implementation of the `Logger` interface which delegates the logging operations to an I18n based `Logger` implementation, using pass-through I18n objects.
  GraphI18n | The internationalized string constants for the `org.modeshape.graph*` packages.
  InfinispanUtil | A set of utility methods for Infinispan caches.
  InitialContentImporter | Class which handles the import of initial content files for new workspaces, using a `NodeImportXmlHandler`.
  JcrI18n | The internationalized string constants for the `org.modeshape.jcr*` packages.
  JcrLexicon | Lexicon of names from the standard JCR "`http://www.jcp.org/jcr/1.0`" namespace.
  JcrLexicon.Namespace |
  JcrMixLexicon | Lexicon of names from the standard JCR "`http://www.jcp.org/jcr/mix/1.0`" namespace.
  JcrMixLexicon.Namespace |
  JcrNodeTypeDelegate |
  JcrNodeTypeManager | Local implementation of @{link NodeTypeManager}.
  JcrNodeTypeTemplate | ModeShape implementation of the JCR NodeTypeTemplate interface
  JcrNtLexicon | Lexicon of names from the standard JCR "`http://www.jcp.org/jcr/nt/1.0`" namespace.
  JcrNtLexicon.Namespace |
  JcrProblems | A wrapper around an `internal Problems` object that implements the ModeShape JCR API `Problems` interface.
  JcrRepositoriesContainer | Service provider implementation of the `RepositoriesContainer` interface.
  JcrRepository |
  JcrRepository.BackgroundRepositoryTask | The garbage collection tasks should get cancelled before the repository is shut down, but just in case we'll use a weak reference to hold onto the JcrRepository instance and we'll also check that the repository is running before we actually do any work.
  JcrRepository.BinaryValueGarbageCollectionTask |
  JcrRepository.ConfigurationChange |
  JcrRepository.JournalingGCTask |
  JcrRepository.LockGarbageCollectionTask |
  JcrRepository.OptimizationTask |
  JcrRepository.QueryLanguage | The set of supported query language string constants.
  JcrRepository.RepositorySessionEnvironment |
  JcrRepositoryFactory | Service provider for the JCR2 `RepositoryFactory` interface.
  JcrRepositoryManager |
  JcrRepositoryMonitor | The session-specific monitoring interface.
  JcrSession |
  JcrSvLexicon | Lexicon of names from the standard JCR "`http://www.jcp.org/jcr/sv/1.0`" namespace.
  JcrSvLexicon.Namespace |
  JcrSystemNode | A Node implementation that is used to represent all nodes within the "/jcr:system" subgraph.
  JcrValueFactory | The `ValueFactory` implementation for ModeShape.
  JcrXaSession | An extension of `JcrSession` that is also an `XAResource`, enabling clients to explicitly enlist the session in the transaction.
  JndiRepositoryFactory | The `JndiRepositoryFactory` class provides a means of initializing and accessing `repositories` in a JNDI tree.
  LocalEnvironment | An `Environment` that can be used within a local (non-clustered) process.
  ModeShape | Information about ModeShape.
  ModeShapeEngine | A container for repositories.
  ModeShapeFederationManager | Implementation of the `FederationManager` interface.
  ModeShapeLexicon | A lexicon of names used within ModeShape.
  ModeShapeLexicon.Namespace |
  NodeTypes |
  NodeTypeSchemata | A `Schemata` implementation that is constructed from the `NodeType`s and `PropertyDefinition`s contained within a `RepositoryNodeTypeManager`.
  NodeTypesImporter | Class which performs the import of the optional, repository configured node-types
  RepositoryConfiguration | A representation of the configuration for a `JCR Repository`.
  RepositoryConfiguration.Default |
  RepositoryConfiguration.FieldName |
  RepositoryConfiguration.FieldValue |
  RepositoryI18n | The internationalized string constants for the `org.modeshape.repository*` packages.
  RepositoryIndexes | An immutable set of `IndexDefinition` instances describing all of the currently available indexes.
  RepositoryStatistics | A component that records statistics for a variety of repository metrics, and makes the statistics available for a variety of windows.
  RepositoryStatistics.DurationActivityImpl | The `RepositoryStatistics.MetricHistory` specialization used for recording the statistics for activities with measured durations.
  RepositoryStatistics.DurationHistory |
  RepositoryStatistics.MetricHistory | Abstract base class for the `RepositoryStatistics.ValueHistory` and `RepositoryStatistics.DurationHistory` classes.
  RepositoryStatistics.ValueHistory | The `RepositoryStatistics.MetricHistory` specialization used for recording the statistics for running values.
  Sequencers | Component that manages the library of sequencers configured for a repository.
  Sequencers.SequencingContext |
  Sequencers.SequencingWorkItem |
  SystemContent |
  SystemNamespaceRegistry | A `NamespaceRegistry` implementation that stores the namespaces in the '/jcr:system' area as individual nodes for each namespace.
  TextExtractors | Facility for managing `TextExtractor` instances and submitting text extraction work
  Upgrades |
  Upgrades.ModeShape_3_6_0 | Upgrade operation handling moving to ModeShape 3.6.0.Final.
  Upgrades.ModeShape_4_0_0_Alpha1 | Upgrade operation handling moving to ModeShape 4.0.0.Alpha1.
  Upgrades.ModeShape_4_0_0_Beta3 | Upgrade operation handling moving to ModeShape 4.0.0.Beta3.
  Upgrades.UpgradeOperation |

- Enum Summary
  Enum | Description
  --- | ---
  InfinispanUtil.Location |
  ModeShapeEngine.State |
  NodeTypes.NodeCardinality | List of ways to filter the returned node definitions
  NodeTypes.PropertyCardinality | List of ways to filter the returned property definitions
  RepositoryConfiguration.TransactionMode | Possible options for rebuilding the indexes upon startup.

- Exception Summary
  Exception | Description
  --- | ---
  ConfigurationException | An exception signalling errors in a `configuration`.
  NodeTypeExistsException | An exception that captures the error condition that a referenced node type already exists.
  NoSuchRepositoryException | Exception thrown when an operation attempts to access a repository that does not exist.
  TimeoutException | An exception that signals a timeout has occurred.

Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.