Package org.apache.curator.framework.api

Interface CreateBuilderMain

All Superinterfaces:
ACLable<BackgroundPathAndBytesable<String>>, ACLBackgroundPathAndBytesable<String>, ACLCreateModeBackgroundPathAndBytesable<String>, Backgroundable<ErrorListenerPathAndBytesable<String>>, BackgroundPathAndBytesable<String>, Compressible<CreateBackgroundModeStatACLable>, CreateModable<ACLBackgroundPathAndBytesable<String>>, ParentACLable<BackgroundPathAndBytesable<String>>, PathAndBytesable<String>, Statable<CreateProtectACLCreateModePathAndBytesable<String>>
All Known Subinterfaces:
CreateBuilder, CreateBuilder2
All Known Implementing Classes:
CreateBuilderImpl
public interface CreateBuilderMain extends BackgroundPathAndBytesable<String>, CreateModable<ACLBackgroundPathAndBytesable<String>>, ACLCreateModeBackgroundPathAndBytesable<String>, Compressible<CreateBackgroundModeStatACLable>, Statable<CreateProtectACLCreateModePathAndBytesable<String>>

  • Method Details

    • creatingParentsIfNeeded

      ProtectACLCreateModeStatPathAndBytesable<String> creatingParentsIfNeeded()
      Causes any parent nodes to get created if they haven't already been
      Returns:
      this

    • creatingParentContainersIfNeeded

      ProtectACLCreateModeStatPathAndBytesable<String> creatingParentContainersIfNeeded()
      Causes any parent nodes to get created using CreateMode.CONTAINER if they haven't already been. IMPORTANT NOTE: container creation is a new feature in recent versions of ZooKeeper. If the ZooKeeper version you're using does not support containers, the parent nodes are created as ordinary PERSISTENT nodes.
      Returns:
      this

    • withProtectedEphemeralSequential

      @Deprecated ACLPathAndBytesable<String> withProtectedEphemeralSequential()
      Deprecated.
      this has been generalized to support all create modes. Instead, use: 
           client.create().withProtection().withMode(CreateMode.EPHEMERAL_SEQUENTIAL)...
      Returns:
      this

    • withProtection

      ACLCreateModeStatBackgroundPathAndBytesable<String> withProtection()

      Hat-tip to https://github.com/sbridges for pointing this out

      It turns out there is an edge case that exists when creating sequential-ephemeral nodes. The creation can succeed on the server, but the server can crash before the created node name is returned to the client. However, the ZK session is still valid so the ephemeral node is not deleted. Thus, there is no way for the client to determine what node was created for them.

      Even without sequential-ephemeral, however, the create can succeed on the sever but the client (for various reasons) will not know it.

      Putting the create builder into protection mode works around this. The name of the node that is created is prefixed with a 40 characters string that is the concatenation of

      • "_c_"
      • Canonical text representation of a random generated UUID as produced by UUID.toString()
      • '-'
      If node creation fails the normal retry mechanism will occur. On the retry, the parent path is first searched for a node that has previous described prefix in it. If that node is found, it is assumed to be the lost node that was successfully created on the first try and is returned to the caller.

      Returns:
      this