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

Interface Importer

public interface Importer
Content importer. The XML import handlers use this interface to submit the parsed content to the repository. The implementation of this class decides how the content is actually persisted; either through the transient space of a session, or directly into the workspace.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    end()
    Called once at the end of the content import.
    void
    endNode(@NotNull NodeInfo nodeInfo)
    Called to end the import of a node.
    void
    start()
    Called once at the beginning of the content import.
    void
    startNode(@NotNull NodeInfo nodeInfo, @NotNull List<PropInfo> propInfos)
    Called to start the import of a node.

  • Method Details

    • start

      void start() throws RepositoryException
      Called once at the beginning of the content import.
      Throws:
      RepositoryException - on a repository error

    • startNode

      void startNode(@NotNull @NotNull NodeInfo nodeInfo, @NotNull @NotNull List<PropInfo> propInfos) throws RepositoryException
      Called to start the import of a node. Information about the imported node and all it's properties are passed as arguments. Possible child nodes are imported recursively using this same method until a endNode(NodeInfo) call is made with the same node information.
      Parameters:
      nodeInfo - information about the node being imported
      propInfos - information about the properties being imported (list of PropInfo instances)
      Throws:
      RepositoryException - on a repository error

    • endNode

      void endNode(@NotNull @NotNull NodeInfo nodeInfo) throws RepositoryException
      Called to end the import of a node. This method is called after a startNode(NodeInfo, List) call with the same node information and after all the possible child nodes have been imported with respective startNode/endNode calls.

      Just like XML elements, the startNode/endNode calls are guaranteed to be properly nested and complete.

      Parameters:
      nodeInfo - information about the node being imported
      Throws:
      RepositoryException - on a repository error

    • end

      void end() throws RepositoryException
      Called once at the end of the content import.
      Throws:
      RepositoryException - on a repository error