[CURATOR-351] Support for TTL Nodes #171
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.curator.framework.api; | ||
|
|
||
| public interface CreateBuilder2 extends CreateBuilderMain | ||
| { | ||
| /** | ||
| * Specify a TTL when mode is {@link org.apache.zookeeper.CreateMode#PERSISTENT_WITH_TTL} or | ||
| * {@link org.apache.zookeeper.CreateMode#PERSISTENT_SEQUENTIAL_WITH_TTL}. If | ||
| * the znode has not been modified within the given TTL, it will be deleted once it has no | ||
| * children. The TTL unit is milliseconds and must be greater than 0 and less than or equal to | ||
| * EphemeralType.MAX_TTL. | ||
| * | ||
| * @param ttl the ttl | ||
| * @return this for chaining | ||
| */ | ||
| CreateBuilderMain withTtl(long ttl); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.curator.framework.imps; | ||
|
|
||
| import org.apache.curator.framework.CuratorFramework; | ||
| import org.apache.curator.framework.CuratorFrameworkFactory; | ||
| import org.apache.curator.framework.api.BackgroundCallback; | ||
| import org.apache.curator.framework.api.CuratorEvent; | ||
| import org.apache.curator.retry.RetryOneTime; | ||
| import org.apache.curator.test.BaseClassForTests; | ||
| import org.apache.curator.test.Timing; | ||
| import org.apache.zookeeper.CreateMode; | ||
| import org.testng.Assert; | ||
| import org.testng.annotations.AfterMethod; | ||
| import org.testng.annotations.BeforeMethod; | ||
| import org.testng.annotations.Test; | ||
| import java.util.concurrent.CountDownLatch; | ||
|
|
||
| public class TestTtlNodes extends BaseClassForTests | ||
| { | ||
| @BeforeMethod | ||
| @Override | ||
| public void setup() throws Exception | ||
| { | ||
| System.setProperty("znode.container.checkIntervalMs", "1"); | ||
| super.setup(); | ||
| } | ||
|
|
||
| @AfterMethod | ||
| @Override | ||
| public void teardown() throws Exception | ||
| { | ||
| super.teardown(); | ||
| System.clearProperty("znode.container.checkIntervalMs"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testBasic() throws Exception | ||
| { | ||
| try ( CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), new RetryOneTime(1)) ) | ||
| { | ||
| client.start(); | ||
|
|
||
| client.create().withTtl(10).creatingParentsIfNeeded().withMode(CreateMode.PERSISTENT_WITH_TTL).forPath("/a/b/c"); | ||
| Thread.sleep(20); | ||
|
There was a problem hiding this comment. I assume that client should get a 'removed' event when the node times out and gets removed by ZK? If so, wouldn't it be less error prone to wait on a latch and checking that the node was deleted within 10 +- some fudge factor rather than just sleeping? There was a problem hiding this comment. I'll take a look at that. There was a problem hiding this comment. On reflection, I want to verify that the node is deleted within the TTL so the sleep seems appropriate to me. Right? There was a problem hiding this comment. You're probably right, my concern is that I don't know how quick ZK responds to these TTL expiry events. You've only got a 10ms window here for ZK to remove the node. Maybe that's enough. There was a problem hiding this comment. I know exactly how long because I wrote it :D Note at the top of the test class: |
||
| Assert.assertNull(client.checkExists().forPath("/a/b/c")); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testBasicInBackground() throws Exception | ||
| { | ||
| try ( CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), new RetryOneTime(1)) ) | ||
| { | ||
| client.start(); | ||
|
|
||
| final CountDownLatch latch = new CountDownLatch(1); | ||
| BackgroundCallback callback = new BackgroundCallback() | ||
| { | ||
| @Override | ||
| public void processResult(CuratorFramework client, CuratorEvent event) throws Exception | ||
| { | ||
| latch.countDown(); | ||
| } | ||
| }; | ||
| client.create().withTtl(10).creatingParentsIfNeeded().withMode(CreateMode.PERSISTENT_WITH_TTL).inBackground(callback).forPath("/a/b/c"); | ||
| Assert.assertTrue(new Timing().awaitLatch(latch)); | ||
| Thread.sleep(20); | ||
| Assert.assertNull(client.checkExists().forPath("/a/b/c")); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not extend
CreateBuilder2here? Less duplicate code/comments forwithTtlThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's because of
orSetData()There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right. That's not a problem.
public interface CreateBuilder extends CreateBuilder2 { CreateBuilder2 orSetData() }