# Uses of Package
org.modeshape.jcr.federation.spi

- Packages that use org.modeshape.jcr.federation.spi
  Package | Description
  --- | ---
  org.modeshape.connector.filesystem |
  org.modeshape.connector.git |
  org.modeshape.connector.meta.jdbc |
  org.modeshape.jcr |
  org.modeshape.jcr.federation |
  org.modeshape.jcr.federation.spi | This package provides a Service Provider Interface (SPI) for connectors to external systems.

- Classes in org.modeshape.jcr.federation.spi used by org.modeshape.connector.filesystem
  Class and Description
  Connector SPI of a generic external connector, representing the interface to an external system integrated with ModeShape.
  DocumentChanges Interface which encapsulates the changes that occurred on a document during an update process.
  Pageable Interface that should be implemented by `Connector`(s) that want to expose children of nodes in a "page by page" fashion.
  PageKey The key used to uniquely identify a page of children.
  WritableConnector A specialized abstract `Connector` class that is support both reads and writes.

- Classes in org.modeshape.jcr.federation.spi used by org.modeshape.connector.git
  Class and Description
  Connector SPI of a generic external connector, representing the interface to an external system integrated with ModeShape.
  DocumentWriter A writer which can create and manipulate the structure of `EditableDocument` instances, that should be used by connectors when they want to return the information regarding external nodes.
  Pageable Interface that should be implemented by `Connector`(s) that want to expose children of nodes in a "page by page" fashion.
  PageKey The key used to uniquely identify a page of children.
  PageWriter A type of document writer that can add paging information to documents.
  ReadOnlyConnector A specialized abstract `Connector` class that is readable and can never update content.

- Classes in org.modeshape.jcr.federation.spi used by org.modeshape.connector.meta.jdbc
  Class and Description
  Connector SPI of a generic external connector, representing the interface to an external system integrated with ModeShape.
  ConnectorException Exception class that can be thrown either by `Connector` implementations or in other exceptional cases involving federation operations.
  DocumentWriter A writer which can create and manipulate the structure of `EditableDocument` instances, that should be used by connectors when they want to return the information regarding external nodes.
  ReadOnlyConnector A specialized abstract `Connector` class that is readable and can never update content.

- Classes in org.modeshape.jcr.federation.spi used by org.modeshape.jcr
  Class and Description
  Connector SPI of a generic external connector, representing the interface to an external system integrated with ModeShape.
  ExtraPropertiesStore Store for extra properties, which a `Connector` implementation can use to store and retrieve "extra" properties on a node that cannot be persisted in the external system.

- Classes in org.modeshape.jcr.federation.spi used by org.modeshape.jcr.federation
  Class and Description
  Connector SPI of a generic external connector, representing the interface to an external system integrated with ModeShape.
  ConnectorChangeSet This interface represents an atomic set of changes that have occurred to resources in the remit of a `Connector`.
  DocumentChanges Interface which encapsulates the changes that occurred on a document during an update process.
  DocumentChanges.ChildrenChanges Interface which encapsulates the changes to a document's children during an update operation.
  DocumentChanges.MixinChanges Interface which encapsulates the changes to a document's mixins during an update operation.
  DocumentChanges.ParentChanges Interface which encapsulates the changes to a document's parents during an update operation.
  DocumentChanges.PropertyChanges Interface which encapsulates the changes to a document's properties during an update operation.
  DocumentChanges.ReferrerChanges Interface which encapsulates the changes to a document's referrers during an update operation.
  DocumentReader A reader which can be used read the structure of `Document` instances and expose the underlying information.
  DocumentWriter A writer which can create and manipulate the structure of `EditableDocument` instances, that should be used by connectors when they want to return the information regarding external nodes.
  ExtraPropertiesStore Store for extra properties, which a `Connector` implementation can use to store and retrieve "extra" properties on a node that cannot be persisted in the external system.
  PageWriter A type of document writer that can add paging information to documents.

- Classes in org.modeshape.jcr.federation.spi used by org.modeshape.jcr.federation.spi
  Class and Description
  Connector SPI of a generic external connector, representing the interface to an external system integrated with ModeShape.
  Connector.ExtraProperties
  ConnectorChangeSet This interface represents an atomic set of changes that have occurred to resources in the remit of a `Connector`.
  DocumentChanges Interface which encapsulates the changes that occurred on a document during an update process.
  DocumentChanges.ChildrenChanges Interface which encapsulates the changes to a document's children during an update operation.
  DocumentChanges.MixinChanges Interface which encapsulates the changes to a document's mixins during an update operation.
  DocumentChanges.ParentChanges Interface which encapsulates the changes to a document's parents during an update operation.
  DocumentChanges.PropertyChanges Interface which encapsulates the changes to a document's properties during an update operation.
  DocumentChanges.ReferrerChanges Interface which encapsulates the changes to a document's referrers during an update operation.
  DocumentReader A reader which can be used read the structure of `Document` instances and expose the underlying information.
  DocumentWriter A writer which can create and manipulate the structure of `EditableDocument` instances, that should be used by connectors when they want to return the information regarding external nodes.
  ExtraPropertiesStore Store for extra properties, which a `Connector` implementation can use to store and retrieve "extra" properties on a node that cannot be persisted in the external system.
  PageKey The key used to uniquely identify a page of children.
  PageWriter A type of document writer that can add paging information to documents.

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