Package org.forgerock.am.trees.api

Interface Tree

public interface Tree
Tree model object.

  • Method Details

    • getLinks

      com.google.common.collect.Multimap<UUID,Tree.Link> getLinks()
      Retrieves a map of links for this tree.
      Returns:
      map of node UUIDs to Tree.Links

    • visitNodes

      <R> R visitNodes(NodeVisitor<R> visitor) throws NodeProcessException
      Visit the nodes in the tree starting at the entry node. Each node will be visited only once, so a node will not be revisited if an outcome path goes back to a previous node.
      Type Parameters:
      R - The type of the return object.
      Parameters:
      visitor - The node visitor.
      Returns:
      The result of the visiting.
      Throws:
      NodeProcessException - If the visiting results in an exception.

    • visitNodes

      <R> R visitNodes(UUID start, NodeVisitor<R> visitor) throws NodeProcessException
      Visit the nodes in the tree starting at the specified node. Each node will be visited only once, so a node will not be revisited if an outcome path goes back to a previous node.
      Type Parameters:
      R - The type of the return object.
      Parameters:
      start - The node to start from.
      visitor - The node visitor.
      Returns:
      The result of the visiting.
      Throws:
      NodeProcessException - If the visiting results in an exception.

    • nodeSupplier

      Supplier<Node> nodeSupplier(String type, Integer version, UUID nodeId) throws NodeProcessException
      Returns a supplier of a Node instance that matches the given type and node ID.
      Parameters:
      type - The type of the node to supply.
      version - The version of the node to supply.
      nodeId - The ID of the node to supply.
      Returns:
      Supplier of a node.
      Throws:
      NodeProcessException - If the node can't be created for some SMS reason.

    • getName

      String getName()
      Returns the name of the tree.
      Returns:
      tree name.

    • getIdentityResource

      String getIdentityResource()
      Returns the IDM identity resource for the tree.
      Returns:
      IDM identity resource.

    • isEnabled

      boolean isEnabled()
      Whether the tree is enabled.
      Returns:
      enabled flag.

    • containsNode

      boolean containsNode(UUID nodeId)
      Check if the tree contains the specified node.
      Parameters:
      nodeId - The node to check for.
      Returns:
      Whether the node is contained in the tree.

    • innerTreeOnly

      boolean innerTreeOnly()
      Whether the tree is an inner tree.
      Returns:
      isInnerTree flag.

    • mustRun

      boolean mustRun()
      Whether the tree must run.
      Returns:
      mustRun flag.

    • isTransactionalOnly

      boolean isTransactionalOnly()
      Whether the tree is a backchannel only tree.
      Returns:
      true if the tree is a backchannel only tree.

    • treeTimeout

      Optional<Duration> treeTimeout()
      The tree timeout.
      Returns:
      treeTimeout value in minutes.

    • getEntryNodeId

      UUID getEntryNodeId()
      Returns the starting node's ID.
      Returns:
      the ID of the entry node.

    • getNodeForId

      Tree.Node getNodeForId(UUID id)
      Returns the node for the given id.
      Parameters:
      id - the ID of the node.
      Returns:
      the node with the given ID.

    • getNextNodeId

      UUID getNextNodeId(UUID id, String outcome)
      Returns the ID of the next node to process given the ID and outcome of a node in the tree.
      Parameters:
      id - the ID of the current node.
      outcome - the outcome of the current node.
      Returns:
      the ID of the next node.

    • getRealm

      Realm getRealm()
      Returns the realm for this tree.
      Returns:
      The Realm for this tree.

    • getNodeIds

      Set<UUID> getNodeIds()
      Retrieves a set of node IDs for this tree.
      Returns:
      set of node UUIDs for this tree

    • getNodes

      Collection<? extends Tree.Node> getNodes()
      The nodes in the tree.
      Returns:
      a collection of nodes in the tree.