Skip to content

Commit

Permalink
Merge branch 'master' into CURATOR-426
Browse files Browse the repository at this point in the history
  • Loading branch information
randgalt committed Jul 21, 2017
2 parents 0906eb5 + afc206c commit 31d7f9a
Show file tree
Hide file tree
Showing 55 changed files with 1,391 additions and 357 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ public static boolean shouldRetry(int rc)
(rc == KeeperException.Code.OPERATIONTIMEOUT.intValue()) ||
(rc == KeeperException.Code.SESSIONMOVED.intValue()) ||
(rc == KeeperException.Code.SESSIONEXPIRED.intValue()) ||
(rc == KeeperException.Code.NEWCONFIGNOQUORUM.intValue());
(rc == -13); // KeeperException.Code.NEWCONFIGNOQUORUM.intValue()) - using hard coded value for ZK 3.4.x compatibility
}

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
/**
* 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.utils;

import org.apache.zookeeper.ZooKeeper;
import org.slf4j.LoggerFactory;

/**
* Utils to help with ZK 3.4.x compatibility
*/
public class Compatibility
{
private static final boolean hasZooKeeperAdmin;
static
{
boolean hasIt;
try
{
Class.forName("org.apache.zookeeper.admin.ZooKeeperAdmin");
hasIt = true;
}
catch ( ClassNotFoundException e )
{
hasIt = false;
LoggerFactory.getLogger(Compatibility.class).info("Running in ZooKeeper 3.4.x compatibility mode");
}
hasZooKeeperAdmin = hasIt;
}

/**
* Return true if the classpath ZooKeeper library is 3.4.x
*
* @return true/false
*/
public static boolean isZK34()
{
return !hasZooKeeperAdmin;
}

/**
* For ZooKeeper 3.5.x, use the supported <code>zooKeeper.getTestable().injectSessionExpiration()</code>.
* For ZooKeeper 3.4.x do the equivalent via reflection
*
* @param zooKeeper client
*/
public static void injectSessionExpiration(ZooKeeper zooKeeper)
{
if ( isZK34() )
{
InjectSessionExpiration.injectSessionExpiration(zooKeeper);
}
else
{
// LOL - this method was proposed by me (JZ) in 2013 for totally unrelated reasons
// it got added to ZK 3.5 and now does exactly what we need
// https://issues.apache.org/jira/browse/ZOOKEEPER-1730
zooKeeper.getTestable().injectSessionExpiration();
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
/**
* 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.utils;

import org.apache.zookeeper.ClientCnxn;
import org.apache.zookeeper.WatchedEvent;
import org.apache.zookeeper.Watcher;
import org.apache.zookeeper.ZooKeeper;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

// reflective version of zooKeeper.getTestable().injectSessionExpiration();
@SuppressWarnings("JavaReflectionMemberAccess")
public class InjectSessionExpiration
{
private static final Field cnxnField;
private static final Field stateField;
private static final Field eventThreadField;
private static final Field sendThreadField;
private static final Method queueEventMethod;
private static final Method queueEventOfDeathMethod;
private static final Method getClientCnxnSocketMethod;
private static final Method wakeupCnxnMethod;
static
{
Field localCnxnField;
Field localStateField;
Field localEventThreadField;
Field localSendThreadField;
Method localQueueEventMethod;
Method localEventOfDeathMethod;
Method localGetClientCnxnSocketMethod;
Method localWakeupCnxnMethod;
try
{
Class<?> eventThreadClass = Class.forName("org.apache.zookeeper.ClientCnxn$EventThread");
Class<?> sendThreadClass = Class.forName("org.apache.zookeeper.ClientCnxn$SendThread");
Class<?> clientCnxnSocketClass = Class.forName("org.apache.zookeeper.ClientCnxnSocket");

localCnxnField = ZooKeeper.class.getDeclaredField("cnxn");
localCnxnField.setAccessible(true);
localStateField = ClientCnxn.class.getDeclaredField("state");
localStateField.setAccessible(true);
localEventThreadField = ClientCnxn.class.getDeclaredField("eventThread");
localEventThreadField.setAccessible(true);
localSendThreadField = ClientCnxn.class.getDeclaredField("sendThread");
localSendThreadField.setAccessible(true);
localQueueEventMethod = eventThreadClass.getDeclaredMethod("queueEvent", WatchedEvent.class);
localQueueEventMethod.setAccessible(true);
localEventOfDeathMethod = eventThreadClass.getDeclaredMethod("queueEventOfDeath");
localEventOfDeathMethod.setAccessible(true);
localGetClientCnxnSocketMethod = sendThreadClass.getDeclaredMethod("getClientCnxnSocket");
localGetClientCnxnSocketMethod.setAccessible(true);
localWakeupCnxnMethod = clientCnxnSocketClass.getDeclaredMethod("wakeupCnxn");
localWakeupCnxnMethod.setAccessible(true);
}
catch ( ReflectiveOperationException e )
{
throw new RuntimeException("Could not access internal ZooKeeper fields", e);
}
cnxnField = localCnxnField;
stateField = localStateField;
eventThreadField = localEventThreadField;
sendThreadField = localSendThreadField;
queueEventMethod = localQueueEventMethod;
queueEventOfDeathMethod = localEventOfDeathMethod;
getClientCnxnSocketMethod = localGetClientCnxnSocketMethod;
wakeupCnxnMethod = localWakeupCnxnMethod;
}

public static void injectSessionExpiration(ZooKeeper zooKeeper)
{
try
{
WatchedEvent event = new WatchedEvent(Watcher.Event.EventType.None, Watcher.Event.KeeperState.Expired, null);

ClientCnxn clientCnxn = (ClientCnxn)cnxnField.get(zooKeeper);
Object eventThread = eventThreadField.get(clientCnxn);
queueEventMethod.invoke(eventThread, event);
queueEventOfDeathMethod.invoke(eventThread);
stateField.set(clientCnxn, ZooKeeper.States.CLOSED);
Object sendThread = sendThreadField.get(clientCnxn);
Object clientCnxnSocket = getClientCnxnSocketMethod.invoke(sendThread);
wakeupCnxnMethod.invoke(clientCnxnSocket);
}
catch ( ReflectiveOperationException e )
{
throw new RuntimeException("Could not inject session expiration using reflection", e);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import org.apache.curator.ensemble.fixed.FixedEnsembleProvider;
import org.apache.curator.retry.RetryOneTime;
import org.apache.curator.test.BaseClassForTests;
import org.apache.curator.test.KillSession;
import org.apache.curator.test.compatibility.KillSession2;
import org.apache.curator.test.Timing;
import org.apache.curator.utils.ZookeeperFactory;
import org.apache.zookeeper.CreateMode;
Expand Down Expand Up @@ -100,7 +100,7 @@ public Object call() throws Exception
// ignore
}

KillSession.kill(client.getZooKeeper(), server.getConnectString());
KillSession2.kill(client.getZooKeeper());

Assert.assertTrue(timing.awaitLatch(latch));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,8 @@

import org.apache.curator.retry.ExponentialBackoffRetry;
import org.apache.curator.test.BaseClassForTests;
import org.apache.curator.test.compatibility.KillSession2;
import org.apache.curator.utils.CloseableUtils;
import org.apache.curator.retry.RetryOneTime;
import org.apache.curator.test.KillSession;
import org.apache.curator.test.Timing;
import org.testng.Assert;
import org.testng.annotations.Test;
Expand Down Expand Up @@ -58,7 +57,7 @@ public Void call() throws Exception
if ( firstTime.compareAndSet(true, false) )
{
Assert.assertNull(client.getZooKeeper().exists("/foo/bar", false));
KillSession.kill(client.getZooKeeper(), server.getConnectString());
KillSession2.kill(client.getZooKeeper());
client.getZooKeeper();
client.blockUntilConnectedOrTimedOut();
}
Expand Down Expand Up @@ -132,7 +131,7 @@ public Void call() throws Exception
if ( firstTime.compareAndSet(true, false) )
{
Assert.assertNull(client.getZooKeeper().exists("/foo/bar", false));
KillSession.kill(client.getZooKeeper(), server.getConnectString());
KillSession2.kill(client.getZooKeeper());
client.getZooKeeper();
client.blockUntilConnectedOrTimedOut();
}
Expand Down Expand Up @@ -197,7 +196,7 @@ public void testBasic() throws Exception
public Void call() throws Exception
{
Assert.assertNull(client.getZooKeeper().exists("/foo/bar", false));
KillSession.kill(client.getZooKeeper(), server.getConnectString());
KillSession2.kill(client.getZooKeeper());

timing.sleepABit();

Expand Down Expand Up @@ -259,7 +258,7 @@ public Object call() throws Exception
public Void call() throws Exception
{
Assert.assertNull(client.getZooKeeper().exists("/foo/bar", false));
KillSession.kill(client.getZooKeeper(), server.getConnectString());
KillSession2.kill(client.getZooKeeper());

client.getZooKeeper();
client.blockUntilConnectedOrTimedOut();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -324,4 +324,11 @@ public interface CuratorFramework extends Closeable
* @return schema set
*/
SchemaSet getSchemaSet();

/**
* Return true if this instance is running in ZK 3.4.x compatibility mode
*
* @return true/false
*/
boolean isZk34CompatibilityMode();
}
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@
import org.apache.curator.framework.imps.DefaultACLProvider;
import org.apache.curator.framework.imps.GzipCompressionProvider;
import org.apache.curator.framework.schema.SchemaSet;
import org.apache.curator.framework.state.ConnectionState;
import org.apache.curator.framework.state.ConnectionStateErrorPolicy;
import org.apache.curator.framework.state.StandardConnectionStateErrorPolicy;
import org.apache.curator.framework.state.ConnectionState;
import org.apache.curator.utils.DefaultZookeeperFactory;
import org.apache.curator.utils.ZookeeperFactory;
import org.apache.zookeeper.CreateMode;
Expand All @@ -51,6 +51,8 @@
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.TimeUnit;

import static org.apache.curator.utils.Compatibility.isZK34;

/**
* Factory methods for creating framework-style clients
*/
Expand Down Expand Up @@ -145,6 +147,7 @@ public static class Builder
private ConnectionStateErrorPolicy connectionStateErrorPolicy = new StandardConnectionStateErrorPolicy();
private ConnectionHandlingPolicy connectionHandlingPolicy = Boolean.getBoolean("curator-use-classic-connection-handling") ? new ClassicConnectionHandlingPolicy() : new StandardConnectionHandlingPolicy();
private SchemaSet schemaSet = SchemaSet.getDefaultSchemaSet();
private boolean zk34CompatibilityMode = isZK34();

/**
* Apply the current values and build a new CuratorFramework
Expand Down Expand Up @@ -385,6 +388,20 @@ public Builder connectionStateErrorPolicy(ConnectionStateErrorPolicy connectionS
return this;
}

/**
* If mode is true, create a ZooKeeper 3.4.x compatible client. IMPORTANT: If the client
* library used is ZooKeeper 3.4.x <code>zk34CompatibilityMode</code> is enabled by default.
*
* @since 3.5.0
* @param mode true/false
* @return this
*/
public Builder zk34CompatibilityMode(boolean mode)
{
this.zk34CompatibilityMode = mode;
return this;
}

/**
* <p>
* Change the connection handling policy. The default policy is {@link StandardConnectionHandlingPolicy}.
Expand Down Expand Up @@ -515,6 +532,11 @@ public SchemaSet getSchemaSet()
return schemaSet;
}

public boolean isZk34CompatibilityMode()
{
return zk34CompatibilityMode;
}

@Deprecated
public String getAuthScheme()
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/**
* 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;

import org.apache.curator.utils.Compatibility;
import org.apache.zookeeper.CreateMode;

public class SafeIsTtlMode
{
private static class Internal
{
private static final Internal instance = new Internal();

public boolean isTtl(CreateMode mode)
{
return mode.isTTL();
}
}

public static boolean isTtl(CreateMode mode)
{
return !Compatibility.isZK34() && Internal.instance.isTtl(mode);
}

private SafeIsTtlMode()
{
}
}
Loading

0 comments on commit 31d7f9a

Please sign in to comment.