Skip to content

Commit 8a83588

Browse files
clebertsuconicclebertsuconic
committed
ARTEMIS-5852 Leader/Follower pattern on acceptors
I'm adding a LeaderManager to the broker, that will use DistributedLock to determine the node that will be the lead. You can associate the leaderManager with acceptors and an acceptor serving only clients would then be activated in only one of the brokers.
1 parent a9ee1c7 commit 8a83588

38 files changed

Lines changed: 2661 additions & 118 deletions

File tree

‎artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/TransportConfiguration.java‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ public class TransportConfiguration implements Serializable {
5151

5252
private String name;
5353

54+
private String leaderManager;
55+
5456
private String factoryClassName = "null";
5557

5658
private Map<String, Object> params;
@@ -413,6 +415,15 @@ public void decode(final ActiveMQBuffer buffer) {
413415
}
414416
}
415417

418+
public String getLeaderManager() {
419+
return leaderManager;
420+
}
421+
422+
public TransportConfiguration setLeaderManager(String leaderManager) {
423+
this.leaderManager = leaderManager;
424+
return this;
425+
}
426+
416427
private static String replaceWildcardChars(final String str) {
417428
return str.replace('.', '-');
418429
}

‎artemis-lockmanager/artemis-lockmanager-api/src/main/java/org/apache/activemq/artemis/lockmanager/DistributedLock.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ public interface DistributedLock extends AutoCloseable {
2424

2525
String getLockId();
2626

27+
// TODO: A better name for this method would be isLockValid
2728
boolean isHeldByCaller() throws UnavailableStateException;
2829

2930
boolean tryLock() throws UnavailableStateException, InterruptedException;

‎artemis-lockmanager/artemis-lockmanager-api/src/main/java/org/apache/activemq/artemis/lockmanager/DistributedLockManager.java‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,14 @@
2121
import java.util.concurrent.TimeUnit;
2222
import java.util.concurrent.TimeoutException;
2323

24-
import org.apache.activemq.artemis.utils.ClassloadingUtil;
25-
2624
public interface DistributedLockManager extends AutoCloseable {
2725

2826
static DistributedLockManager newInstanceOf(String className, Map<String, String> properties) throws Exception {
29-
return (DistributedLockManager) ClassloadingUtil.getInstanceForParamsWithTypeCheck(className,
30-
DistributedLockManager.class,
31-
DistributedLockManager.class.getClassLoader(),
32-
new Class[]{Map.class},
33-
properties);
27+
DistributedLockManagerFactory factory = Registry.getInstance().getFactoryWithClassName(className);
28+
if (factory == null) {
29+
throw new IllegalArgumentException(className + " not found");
30+
}
31+
return factory.build(properties);
3432
}
3533

3634
@FunctionalInterface

artemis-lockmanager/artemis-lockmanager-ri/src/main/java/org/apache/activemq/artemis/quorum/zookeeper/CuratorDistributedPrimitiveManager.java renamed to artemis-lockmanager/artemis-lockmanager-api/src/main/java/org/apache/activemq/artemis/lockmanager/DistributedLockManagerFactory.java

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,30 @@
1414
* See the License for the specific language governing permissions and
1515
* limitations under the License.
1616
*/
17-
package org.apache.activemq.artemis.quorum.zookeeper;
17+
18+
package org.apache.activemq.artemis.lockmanager;
1819

1920
import java.util.Map;
21+
import java.util.Set;
2022

21-
import org.apache.activemq.artemis.lockmanager.zookeeper.CuratorDistributedLockManager;
23+
public interface DistributedLockManagerFactory {
24+
DistributedLockManager build(Map<String, String> properties);
2225

23-
/**
24-
* This is for backwards compatibility
25-
*/
26-
@Deprecated(forRemoval = true)
27-
public class CuratorDistributedPrimitiveManager extends CuratorDistributedLockManager {
28-
public CuratorDistributedPrimitiveManager(Map<String, String> config) {
29-
super(config);
26+
String getName();
27+
28+
String getImplName();
29+
30+
default Map<String, String> validateParameters(Map<String, String> config) {
31+
config.forEach((parameterName, ignore) -> validateParameter(parameterName));
32+
return config;
33+
}
34+
35+
Set<String> getValidParametersList();
36+
37+
default void validateParameter(String parameterName) {
38+
Set<String> validList = getValidParametersList();
39+
if (!validList.contains(parameterName)) {
40+
throw new IllegalArgumentException("Invalid parameter '" + parameterName + "'. Accepted parameters: " + String.join(", ", validList));
41+
}
3042
}
3143
}

‎artemis-lockmanager/artemis-lockmanager-api/src/main/java/org/apache/activemq/artemis/lockmanager/Registry.java‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one or more
3+
* contributor license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright ownership.
5+
* The ASF licenses this file to You under the Apache License, Version 2.0
6+
* (the "License"); you may not use this file except in compliance with
7+
* the License. You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
package org.apache.activemq.artemis.lockmanager;
19+
20+
import java.util.HashMap;
21+
import java.util.ServiceLoader;
22+
23+
public class Registry {
24+
25+
private final HashMap<String, DistributedLockManagerFactory> factories = new HashMap<>();
26+
private final HashMap<String, DistributedLockManagerFactory> factoriesWithImpl = new HashMap<>();
27+
28+
private volatile boolean serviceLoaded = false;
29+
30+
private static final Registry INSTANCE = new Registry();
31+
32+
private Registry() {
33+
}
34+
35+
public static Registry getInstance() {
36+
return INSTANCE;
37+
}
38+
39+
public synchronized void register(DistributedLockManagerFactory factory) {
40+
factories.put(factory.getName(), factory);
41+
factoriesWithImpl.put(factory.getImplName(), factory);
42+
}
43+
44+
public synchronized void unregisterWithType(String type) {
45+
unregister(factories.get(type));
46+
}
47+
48+
public synchronized void unregisterWithClassName(String name) {
49+
unregister(factoriesWithImpl.get(name));
50+
}
51+
52+
private void unregister(DistributedLockManagerFactory factory) {
53+
if (factory != null) {
54+
factories.remove(factory.getName());
55+
factoriesWithImpl.remove(factory.getImplName());
56+
}
57+
}
58+
59+
public synchronized DistributedLockManagerFactory getFactoryWithClassName(String className) {
60+
checkService();
61+
DistributedLockManagerFactory factory = factoriesWithImpl.get(className);
62+
if (factory == null) {
63+
throw new IllegalArgumentException("factory " + className + " not found");
64+
}
65+
return factory;
66+
}
67+
68+
public synchronized DistributedLockManagerFactory getFactory(String name) {
69+
checkService();
70+
return factories.get(name);
71+
}
72+
73+
public synchronized void checkService() {
74+
if (serviceLoaded) {
75+
return;
76+
}
77+
ServiceLoader<DistributedLockManagerFactory> services = ServiceLoader.load(DistributedLockManagerFactory.class);
78+
services.forEach(this::register);
79+
serviceLoaded = true;
80+
}
81+
82+
}

‎artemis-lockmanager/artemis-lockmanager-ri/src/main/java/org/apache/activemq/artemis/lockmanager/file/FileBasedLockManager.java‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,7 @@ public class FileBasedLockManager implements DistributedLockManager {
4141
private final Map<String, FileDistributedLock> locks;
4242
private boolean started;
4343

44-
public FileBasedLockManager(Map<String, String> args) {
45-
this(new File(args.get("locks-folder")));
46-
}
47-
48-
public FileBasedLockManager(File locksFolder) {
44+
FileBasedLockManager(File locksFolder) {
4945
Objects.requireNonNull(locksFolder);
5046
if (!locksFolder.exists()) {
5147
throw new IllegalStateException(locksFolder + " is supposed to already exists");

‎artemis-lockmanager/artemis-lockmanager-ri/src/main/java/org/apache/activemq/artemis/lockmanager/file/FileBasedLockManagerFactory.java‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one or more
3+
* contributor license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright ownership.
5+
* The ASF licenses this file to You under the Apache License, Version 2.0
6+
* (the "License"); you may not use this file except in compliance with
7+
* the License. You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
package org.apache.activemq.artemis.lockmanager.file;
19+
20+
import java.io.File;
21+
import java.util.Map;
22+
import java.util.Set;
23+
24+
import org.apache.activemq.artemis.lockmanager.DistributedLockManager;
25+
import org.apache.activemq.artemis.lockmanager.DistributedLockManagerFactory;
26+
27+
public class FileBasedLockManagerFactory implements DistributedLockManagerFactory {
28+
29+
private static final String LOCK_FOLDER = "locks-folder";
30+
31+
private static final Set<String> VALID_PARAMS = Set.of(LOCK_FOLDER);
32+
33+
@Override
34+
public String getName() {
35+
return "file";
36+
}
37+
38+
@Override
39+
public DistributedLockManager build(Map<String, String> config) {
40+
config = validateParameters(config);
41+
String folder = config.get(LOCK_FOLDER);
42+
if (folder == null) {
43+
throw new IllegalArgumentException("folder not passed as a parameter");
44+
}
45+
return new FileBasedLockManager(new File(folder));
46+
}
47+
48+
@Override
49+
public Set<String> getValidParametersList() {
50+
return VALID_PARAMS;
51+
}
52+
53+
@Override
54+
public String getImplName() {
55+
return FileBasedLockManager.class.getName();
56+
}
57+
}

‎artemis-lockmanager/artemis-lockmanager-ri/src/main/java/org/apache/activemq/artemis/lockmanager/file/FileDistributedLock.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public boolean isHeldByCaller() {
6565
}
6666

6767
@Override
68-
public boolean tryLock() {
68+
public synchronized boolean tryLock() {
6969
checkNotClosed();
7070
final FileLock fileLock = this.fileLock;
7171
if (fileLock != null) {
@@ -88,7 +88,7 @@ public boolean tryLock() {
8888
}
8989

9090
@Override
91-
public void unlock() {
91+
public synchronized void unlock() {
9292
checkNotClosed();
9393
final FileLock fileLock = this.fileLock;
9494
if (fileLock != null) {

‎artemis-lockmanager/artemis-lockmanager-ri/src/main/java/org/apache/activemq/artemis/lockmanager/zookeeper/CuratorDistributedLockManager.java‎

Lines changed: 1 addition & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,10 @@
2020
import java.util.List;
2121
import java.util.Map;
2222
import java.util.Objects;
23-
import java.util.Set;
2423
import java.util.concurrent.CopyOnWriteArrayList;
2524
import java.util.concurrent.ExecutionException;
2625
import java.util.concurrent.TimeUnit;
2726
import java.util.function.Function;
28-
import java.util.stream.Collectors;
29-
import java.util.stream.Stream;
3027

3128
import org.apache.activemq.artemis.lockmanager.DistributedLock;
3229
import org.apache.activemq.artemis.lockmanager.DistributedLockManager;
@@ -42,7 +39,6 @@
4239
import org.apache.curator.utils.DebugUtils;
4340

4441
import static java.util.Objects.requireNonNull;
45-
import static java.util.stream.Collectors.joining;
4642

4743
public class CuratorDistributedLockManager implements DistributedLockManager, ConnectionStateListener {
4844

@@ -97,41 +93,6 @@ public int hashCode() {
9793
}
9894
}
9995

100-
private static final String CONNECT_STRING_PARAM = "connect-string";
101-
private static final String NAMESPACE_PARAM = "namespace";
102-
private static final String SESSION_MS_PARAM = "session-ms";
103-
private static final String SESSION_PERCENT_PARAM = "session-percent";
104-
private static final String CONNECTION_MS_PARAM = "connection-ms";
105-
private static final String RETRIES_PARAM = "retries";
106-
private static final String RETRIES_MS_PARAM = "retries-ms";
107-
private static final Set<String> VALID_PARAMS = Stream.of(
108-
CONNECT_STRING_PARAM,
109-
NAMESPACE_PARAM,
110-
SESSION_MS_PARAM,
111-
SESSION_PERCENT_PARAM,
112-
CONNECTION_MS_PARAM,
113-
RETRIES_PARAM,
114-
RETRIES_MS_PARAM).collect(Collectors.toSet());
115-
private static final String VALID_PARAMS_ON_ERROR = VALID_PARAMS.stream().collect(joining(","));
116-
// It's 9 times the default ZK tick time ie 2000 ms
117-
private static final String DEFAULT_SESSION_TIMEOUT_MS = Integer.toString(18_000);
118-
private static final String DEFAULT_CONNECTION_TIMEOUT_MS = Integer.toString(8_000);
119-
private static final String DEFAULT_RETRIES = Integer.toString(1);
120-
private static final String DEFAULT_RETRIES_MS = Integer.toString(1000);
121-
// why 1/3 of the session? https://cwiki.apache.org/confluence/display/CURATOR/TN14
122-
private static final String DEFAULT_SESSION_PERCENT = Integer.toString(33);
123-
124-
private static Map<String, String> validateParameters(Map<String, String> config) {
125-
config.forEach((parameterName, ignore) -> validateParameter(parameterName));
126-
return config;
127-
}
128-
129-
private static void validateParameter(String parameterName) {
130-
if (!VALID_PARAMS.contains(parameterName)) {
131-
throw new IllegalArgumentException("non existent parameter " + parameterName + ": accepted list is " + VALID_PARAMS_ON_ERROR);
132-
}
133-
}
134-
13596
private CuratorFramework client;
13697
private final Map<PrimitiveId, CuratorDistributedPrimitive> primitives;
13798
private List<UnavailableManagerListener> listeners;
@@ -146,21 +107,7 @@ private static void validateParameter(String parameterName) {
146107
}
147108
}
148109

149-
public CuratorDistributedLockManager(Map<String, String> config) {
150-
this(validateParameters(config), true);
151-
}
152-
153-
private CuratorDistributedLockManager(Map<String, String> config, boolean ignore) {
154-
this(config.get(CONNECT_STRING_PARAM),
155-
config.get(NAMESPACE_PARAM),
156-
Integer.parseInt(config.getOrDefault(SESSION_MS_PARAM, DEFAULT_SESSION_TIMEOUT_MS)),
157-
Integer.parseInt(config.getOrDefault(SESSION_PERCENT_PARAM, DEFAULT_SESSION_PERCENT)),
158-
Integer.parseInt(config.getOrDefault(CONNECTION_MS_PARAM, DEFAULT_CONNECTION_TIMEOUT_MS)),
159-
Integer.parseInt(config.getOrDefault(RETRIES_PARAM, DEFAULT_RETRIES)),
160-
Integer.parseInt(config.getOrDefault(RETRIES_MS_PARAM, DEFAULT_RETRIES_MS)));
161-
}
162-
163-
private CuratorDistributedLockManager(String connectString,
110+
CuratorDistributedLockManager(String connectString,
164111
String namespace,
165112
int sessionMs,
166113
int sessionPercent,

0 commit comments

Comments
 (0)