Package org.apache.jackrabbit.oak.spi.xml

Interface ProtectedItemImporter

All Known Subinterfaces:
ProtectedNodeImporter, ProtectedPropertyImporter
public interface ProtectedItemImporter
Base interface for ProtectedNodeImporter and ProtectedPropertyImporter.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PARAM_IMPORT_BEHAVIOR
    Parameter name for the import behavior configuration option.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    init(@NotNull Session session, @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper, boolean isWorkspaceImport, int uuidBehavior, @NotNull ReferenceChangeTracker referenceTracker, @NotNull SecurityProvider securityProvider)
    Initializes the importer.
    void
    processReferences()
    Post processing protected reference properties underneath a protected or non-protected parent node.

  • Field Details

    • PARAM_IMPORT_BEHAVIOR

      static final String PARAM_IMPORT_BEHAVIOR
      Parameter name for the import behavior configuration option.
      See Also:

  • Method Details

    • init

      boolean init(@NotNull @NotNull Session session, @NotNull @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper, boolean isWorkspaceImport, int uuidBehavior, @NotNull @NotNull ReferenceChangeTracker referenceTracker, @NotNull @NotNull SecurityProvider securityProvider)
      Initializes the importer.
      Parameters:
      session - The session that is running the import.
      root - The root associated with the import.
      namePathMapper - The name/path mapper used to translate names between their jcr and oak form.
      isWorkspaceImport - A flag indicating whether the import has been started from the Workspace or from the Session. Implementations are free to implement both types of imports or only a single one. For example it doesn't make sense to allow for importing versions along with a Session import as version operations are required to never leave transient changes behind.
      uuidBehavior - The uuid behavior specified with the import call.
      referenceTracker - The uuid/reference helper.
      securityProvider - The security provider.
      Returns:
      true if this importer was successfully initialized and is able to handle an import with the given setup; false otherwise.

    • processReferences

      void processReferences() throws RepositoryException
      Post processing protected reference properties underneath a protected or non-protected parent node. If the parent is protected it has been handled by this importer already.
      Throws:
      RepositoryException - If an error occurs.