3 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
5 * This program and the accompanying materials are made available under the
6 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * and is available at http://www.eclipse.org/legal/epl-v10.html
10 package org.opendaylight.controller.clustering.services_implementation.internal;
12 import java.io.PrintWriter;
13 import java.io.StringWriter;
14 import java.net.InetAddress;
15 import java.net.NetworkInterface;
16 import java.net.SocketException;
17 import java.net.UnknownHostException;
18 import java.util.ArrayList;
19 import java.util.EnumSet;
20 import java.util.Enumeration;
21 import java.util.HashSet;
22 import java.util.List;
23 import java.util.Properties;
25 import java.util.StringTokenizer;
26 import java.util.concurrent.ConcurrentMap;
28 import javax.transaction.HeuristicMixedException;
29 import javax.transaction.HeuristicRollbackException;
30 import javax.transaction.NotSupportedException;
31 import javax.transaction.RollbackException;
32 import javax.transaction.SystemException;
33 import javax.transaction.Transaction;
34 import javax.transaction.TransactionManager;
36 import org.infinispan.Cache;
37 import org.infinispan.configuration.cache.Configuration;
38 import org.infinispan.manager.DefaultCacheManager;
39 import org.infinispan.manager.EmbeddedCacheManager;
40 import org.infinispan.notifications.Listener;
41 import org.infinispan.notifications.cachemanagerlistener.annotation.ViewChanged;
42 import org.infinispan.notifications.cachemanagerlistener.event.ViewChangedEvent;
43 import org.infinispan.remoting.transport.Address;
44 import org.infinispan.remoting.transport.Transport;
45 import org.infinispan.remoting.transport.jgroups.JGroupsAddress;
46 import org.infinispan.remoting.transport.jgroups.JGroupsTransport;
47 import org.jgroups.Channel;
48 import org.jgroups.Event;
49 import org.jgroups.stack.GossipRouter;
50 import org.opendaylight.controller.clustering.services.CacheConfigException;
51 import org.opendaylight.controller.clustering.services.CacheExistException;
52 import org.opendaylight.controller.clustering.services.CacheListenerAddException;
53 import org.opendaylight.controller.clustering.services.IClusterServices;
54 import org.opendaylight.controller.clustering.services.IGetUpdates;
55 import org.opendaylight.controller.clustering.services.IListenRoleChange;
56 import org.opendaylight.controller.clustering.services.ListenRoleChangeAddException;
57 import org.slf4j.Logger;
58 import org.slf4j.LoggerFactory;
60 public class ClusterManager implements IClusterServices {
61 protected static final Logger logger = LoggerFactory
62 .getLogger(ClusterManager.class);
63 private DefaultCacheManager cm;
64 GossipRouter gossiper;
65 private HashSet roleChangeListeners;
66 private ViewChangedListener cacheManagerListener;
68 private static String loopbackAddress = "127.0.0.1";
71 * Start a JGroups GossipRouter if we are a supernode. The
72 * GosispRouter is nothing more than a simple
73 * rendevouz-pointer. All the nodes that wants to join the cluster
74 * will come to any of the rendevouz point and they introduce the
75 * nodes to all the others. Once the meet and greet phase if over,
76 * the nodes will open a full-mesh with the remaining n-1 nodes,
77 * so even if the GossipRouter goes down nothing is lost.
78 * NOTE: This function has the side effect to set some of the
79 * JGROUPS configurations, this because in this function already
80 * we try to retrieve some of the network capabilities of the
81 * device and so it's better not to do that again
84 * @return GossipRouter
86 private GossipRouter startGossiper() {
87 boolean amIGossipRouter = false;
88 Integer gossipRouterPortDefault = 12001;
89 Integer gossipRouterPort = gossipRouterPortDefault;
90 InetAddress gossipRouterAddress = null;
91 String supernodes_list = System.getProperty("supernodes",
93 StringBuffer sanitized_supernodes_list = new StringBuffer();
94 List<InetAddress> myAddresses = new ArrayList<InetAddress>();
96 StringTokenizer supernodes = new StringTokenizer(supernodes_list, ":");
97 if (supernodes.hasMoreTokens()) {
98 // Populate the list of my addresses
100 Enumeration e = NetworkInterface.getNetworkInterfaces();
101 while (e.hasMoreElements()) {
102 NetworkInterface n = (NetworkInterface) e.nextElement();
103 Enumeration ee = n.getInetAddresses();
104 while (ee.hasMoreElements()) {
105 InetAddress i = (InetAddress) ee.nextElement();
109 } catch (SocketException se) {
110 logger.error("Cannot get the list of network interfaces");
114 while (supernodes.hasMoreTokens()) {
115 String curr_supernode = supernodes.nextToken();
116 logger.debug("Examining supernode " + curr_supernode);
117 StringTokenizer host_port = new StringTokenizer(curr_supernode,
121 Integer port_num = gossipRouterPortDefault;
122 if (host_port.countTokens() > 2) {
123 logger.error("Error parsing supernode " + curr_supernode
124 + " proceed to the next one");
127 host = host_port.nextToken();
128 InetAddress hostAddr;
130 hostAddr = InetAddress.getByName(host);
131 } catch (UnknownHostException ue) {
132 logger.error("Host not known");
135 if (host_port.hasMoreTokens()) {
136 port = host_port.nextToken();
138 port_num = Integer.valueOf(port);
139 } catch (NumberFormatException ne) {
141 .error("Supplied supernode gossiepr port is not recognized, using standard gossipport");
142 port_num = gossipRouterPortDefault;
144 if ((port_num > 65535) || (port_num < 0)) {
146 .error("Supplied supernode gossip port is outside a valid TCP port range");
147 port_num = gossipRouterPortDefault;
150 if (!amIGossipRouter) {
152 for (InetAddress myAddr : myAddresses) {
153 if (myAddr.equals(hostAddr)) {
154 amIGossipRouter = true;
155 gossipRouterAddress = hostAddr;
156 gossipRouterPort = port_num;
162 if (!sanitized_supernodes_list.toString().equals("")) {
163 sanitized_supernodes_list.append(",");
165 sanitized_supernodes_list.append(hostAddr.getHostAddress() + "["
169 if (amIGossipRouter) {
170 // Set the Jgroups binding interface to the one we got
171 // from the supernodes attribute
172 if (gossipRouterAddress != null) {
173 System.setProperty("jgroups.tcp.address", gossipRouterAddress
177 // Set the Jgroup binding interface to the one we are well
178 // known outside or else to the first with non-local
181 String myBind = InetAddress.getLocalHost().getHostAddress();
183 || InetAddress.getLocalHost().isLoopbackAddress()) {
184 for (InetAddress myAddr : myAddresses) {
185 if (myAddr.isLoopbackAddress()
186 || myAddr.isLinkLocalAddress()) {
187 logger.debug("Skipping local address "
188 + myAddr.getHostAddress());
191 // First non-local address
192 myBind = myAddr.getHostAddress();
193 logger.debug("First non-local address " + myBind);
198 String jgroupAddress = System
199 .getProperty("jgroups.tcp.address");
200 if (jgroupAddress == null) {
201 if (myBind != null) {
202 logger.debug("Set bind address to be " + myBind);
203 System.setProperty("jgroups.tcp.address", myBind);
206 .debug("Set bind address to be LOCALHOST=127.0.0.1");
207 System.setProperty("jgroups.tcp.address", "127.0.0.1");
210 logger.debug("jgroup.tcp.address already set to be "
213 } catch (UnknownHostException uhe) {
215 .error("Met UnknownHostException while trying to get binding address for jgroups");
219 // The supernodes list constitute also the tcpgossip initial
221 System.setProperty("jgroups.tcpgossip.initial_hosts",
222 sanitized_supernodes_list.toString());
223 logger.debug("jgroups.tcp.address set to "
224 + System.getProperty("jgroups.tcp.address"));
225 logger.debug("jgroups.tcpgossip.initial_hosts set to "
226 + System.getProperty("jgroups.tcpgossip.initial_hosts"));
227 GossipRouter res = null;
228 if (amIGossipRouter) {
229 logger.info("I'm a GossipRouter will listen on port "
231 res = new GossipRouter(gossipRouterPort);
236 public void start() {
237 this.gossiper = startGossiper();
238 if (this.gossiper != null) {
239 logger.debug("Trying to start Gossiper");
241 this.gossiper.start();
242 logger.info("Started GossipRouter");
243 } catch (Exception e) {
244 logger.error("GossipRouter didn't start exception " + e
246 StringWriter sw = new StringWriter();
247 logger.error("Stack Trace that raised the exception");
248 e.printStackTrace(new PrintWriter(sw));
249 logger.error(sw.toString());
252 logger.info("Starting the ClusterManager");
254 //FIXME keeps throwing FileNotFoundException
255 this.cm = new DefaultCacheManager("/config/infinispan-config.xml");
256 logger.debug("Allocated ClusterManager");
257 if (this.cm != null) {
259 this.cm.startCache();
260 logger.debug("Started the ClusterManager");
262 } catch (Exception ioe) {
263 StringWriter sw = new StringWriter();
264 logger.error("Cannot configure infinispan .. bailing out ");
265 logger.error("Stack Trace that raised th exception");
266 ioe.printStackTrace(new PrintWriter(sw));
267 logger.error(sw.toString());
271 logger.debug("Cache Manager has value " + this.cm);
275 logger.info("Stopping the ClusterManager");
276 if (this.cm != null) {
277 logger.info("Found a valid ClusterManager, now let it be stopped");
281 if (this.gossiper != null) {
282 this.gossiper.stop();
283 this.gossiper = null;
288 public ConcurrentMap<?, ?> createCache(String containerName,
289 String cacheName, Set<cacheMode> cMode) throws CacheExistException,
290 CacheConfigException {
291 EmbeddedCacheManager manager = this.cm;
293 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
294 if (manager == null) {
298 if (manager.cacheExists(realCacheName)) {
299 throw new CacheExistException();
302 // Sanity check to avoid contrasting parameters
303 if (cMode.containsAll(EnumSet.of(
304 IClusterServices.cacheMode.NON_TRANSACTIONAL,
305 IClusterServices.cacheMode.TRANSACTIONAL))) {
306 throw new CacheConfigException();
309 if (cMode.contains(IClusterServices.cacheMode.NON_TRANSACTIONAL)) {
310 c = manager.getCache(realCacheName);
312 } else if (cMode.contains(IClusterServices.cacheMode.TRANSACTIONAL)) {
313 Configuration rc = manager
314 .getCacheConfiguration("transactional-type");
315 manager.defineConfiguration(realCacheName, rc);
316 c = manager.getCache(realCacheName);
323 public ConcurrentMap<?, ?> getCache(String containerName, String cacheName) {
324 EmbeddedCacheManager manager = this.cm;
326 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
327 if (manager == null) {
331 if (manager.cacheExists(realCacheName)) {
332 c = manager.getCache(realCacheName);
339 public void destroyCache(String containerName, String cacheName) {
340 EmbeddedCacheManager manager = this.cm;
341 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
342 if (manager == null) {
345 if (manager.cacheExists(realCacheName)) {
346 manager.removeCache(realCacheName);
351 public boolean existCache(String containerName, String cacheName) {
352 EmbeddedCacheManager manager = this.cm;
353 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
354 if (manager == null) {
357 return manager.cacheExists(realCacheName);
361 public Set<String> getCacheList(String containerName) {
362 Set<String> perContainerCaches = new HashSet();
363 EmbeddedCacheManager manager = this.cm;
364 if (manager == null) {
367 for (String cacheName : manager.getCacheNames()) {
368 if (cacheName.startsWith("{" + containerName + "}_")) {
369 String[] res = cacheName.split("[{}]");
370 if (res.length >= 4 && res[1].equals(containerName)
371 && res[2].equals("_")) {
372 perContainerCaches.add(res[3]);
377 return (perContainerCaches);
381 public Properties getCacheProperties(String containerName, String cacheName) {
382 EmbeddedCacheManager manager = this.cm;
383 if (manager == null) {
386 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
387 if (!manager.cacheExists(realCacheName)) {
390 Configuration conf = manager.getCache(realCacheName).getAdvancedCache()
391 .getCacheConfiguration();
392 Properties p = new Properties();
393 p.setProperty(IClusterServices.cacheProps.TRANSACTION_PROP.toString(),
394 conf.transaction().toString());
395 p.setProperty(IClusterServices.cacheProps.CLUSTERING_PROP.toString(),
396 conf.clustering().toString());
397 p.setProperty(IClusterServices.cacheProps.LOCKING_PROP.toString(), conf
398 .locking().toString());
403 public void addListener(String containerName, String cacheName,
404 IGetUpdates<?, ?> u) throws CacheListenerAddException {
405 EmbeddedCacheManager manager = this.cm;
407 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
408 if (manager == null) {
412 if (!manager.cacheExists(realCacheName)) {
413 throw new CacheListenerAddException();
415 c = manager.getCache(realCacheName);
416 CacheListenerContainer cl = new CacheListenerContainer(u,
417 containerName, cacheName);
422 public Set<IGetUpdates<?, ?>> getListeners(String containerName,
424 EmbeddedCacheManager manager = this.cm;
426 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
427 if (manager == null) {
431 if (!manager.cacheExists(realCacheName)) {
434 c = manager.getCache(realCacheName);
436 Set<IGetUpdates<?, ?>> res = new HashSet();
437 Set<Object> listeners = c.getListeners();
438 for (Object listener : listeners) {
439 if (listener instanceof CacheListenerContainer) {
440 CacheListenerContainer cl = (CacheListenerContainer) listener;
441 res.add(cl.whichListener());
449 public void removeListener(String containerName, String cacheName,
450 IGetUpdates<?, ?> u) {
451 EmbeddedCacheManager manager = this.cm;
453 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
454 if (manager == null) {
458 if (!manager.cacheExists(realCacheName)) {
461 c = manager.getCache(realCacheName);
463 Set<Object> listeners = c.getListeners();
464 for (Object listener : listeners) {
465 if (listener instanceof CacheListenerContainer) {
466 CacheListenerContainer cl = (CacheListenerContainer) listener;
467 if (cl.whichListener() == u) {
468 c.removeListener(listener);
476 public void tbegin() throws NotSupportedException, SystemException {
477 EmbeddedCacheManager manager = this.cm;
478 if (manager == null) {
479 throw new IllegalStateException();
481 TransactionManager tm = manager.getCache("transactional-type")
482 .getAdvancedCache().getTransactionManager();
484 throw new IllegalStateException();
490 public void tcommit() throws RollbackException, HeuristicMixedException,
491 HeuristicRollbackException, java.lang.SecurityException,
492 java.lang.IllegalStateException, SystemException {
493 EmbeddedCacheManager manager = this.cm;
494 if (manager == null) {
495 throw new IllegalStateException();
497 TransactionManager tm = manager.getCache("transactional-type")
498 .getAdvancedCache().getTransactionManager();
500 throw new IllegalStateException();
506 public void trollback() throws java.lang.IllegalStateException,
507 java.lang.SecurityException, SystemException {
508 EmbeddedCacheManager manager = this.cm;
509 if (manager == null) {
510 throw new IllegalStateException();
512 TransactionManager tm = manager.getCache("transactional-type")
513 .getAdvancedCache().getTransactionManager();
515 throw new IllegalStateException();
521 public Transaction tgetTransaction() throws SystemException {
522 EmbeddedCacheManager manager = this.cm;
523 if (manager == null) {
524 throw new IllegalStateException();
526 TransactionManager tm = manager.getCache("transactional-type")
527 .getAdvancedCache().getTransactionManager();
531 return tm.getTransaction();
535 public boolean amIStandby() {
536 EmbeddedCacheManager manager = this.cm;
537 if (manager == null) {
538 // In case we cannot fetch the information, lets assume we
539 // are standby, so to have less responsability.
542 return (!manager.isCoordinator());
545 private InetAddress addressToInetAddress(Address a) {
546 EmbeddedCacheManager manager = this.cm;
547 if ((manager == null) || (a == null)) {
548 // In case we cannot fetch the information, lets assume we
549 // are standby, so to have less responsability.
552 Transport t = manager.getTransport();
553 if (t instanceof JGroupsTransport) {
554 JGroupsTransport jt = (JGroupsTransport) t;
555 Channel c = jt.getChannel();
556 if (a instanceof JGroupsAddress) {
557 JGroupsAddress ja = (JGroupsAddress) a;
558 org.jgroups.Address phys = (org.jgroups.Address) c
559 .down(new Event(Event.GET_PHYSICAL_ADDRESS, ja
560 .getJGroupsAddress()));
561 if (phys instanceof org.jgroups.stack.IpAddress) {
562 InetAddress bindAddress = ((org.jgroups.stack.IpAddress) phys)
571 public List<InetAddress> getClusteredControllers() {
572 EmbeddedCacheManager manager = this.cm;
573 if (manager == null) {
576 List<Address> controllers = manager.getMembers();
577 if ((controllers == null) || controllers.size() == 0)
580 List<InetAddress> clusteredControllers = new ArrayList<InetAddress>();
581 for (Address a : controllers) {
582 InetAddress inetAddress = addressToInetAddress(a);
583 if (inetAddress != null
584 && !inetAddress.getHostAddress().equals(loopbackAddress))
585 clusteredControllers.add(inetAddress);
587 return clusteredControllers;
590 public InetAddress getMyAddress() {
591 EmbeddedCacheManager manager = this.cm;
592 if (manager == null) {
595 return addressToInetAddress(manager.getAddress());
599 public InetAddress getActiveAddress() {
600 EmbeddedCacheManager manager = this.cm;
601 if (manager == null) {
602 // In case we cannot fetch the information, lets assume we
603 // are standby, so to have less responsability.
607 return addressToInetAddress(manager.getCoordinator());
611 public void listenRoleChange(IListenRoleChange i)
612 throws ListenRoleChangeAddException {
613 EmbeddedCacheManager manager = this.cm;
614 if (manager == null) {
615 // In case we cannot fetch the information, lets assume we
616 // are standby, so to have less responsability.
617 throw new ListenRoleChangeAddException();
620 if (this.roleChangeListeners == null) {
621 this.roleChangeListeners = new HashSet();
622 this.cacheManagerListener = new ViewChangedListener(
623 this.roleChangeListeners);
624 manager.addListener(this.cacheManagerListener);
627 if (this.roleChangeListeners != null) {
628 this.roleChangeListeners.add(i);
633 public void unlistenRoleChange(IListenRoleChange i) {
634 EmbeddedCacheManager manager = this.cm;
635 if (manager == null) {
636 // In case we cannot fetch the information, lets assume we
637 // are standby, so to have less responsability.
641 if (this.roleChangeListeners != null) {
642 this.roleChangeListeners.remove(i);
645 if ((this.roleChangeListeners != null && this.roleChangeListeners
647 && (this.cacheManagerListener != null)) {
648 manager.removeListener(this.cacheManagerListener);
649 this.cacheManagerListener = null;
650 this.roleChangeListeners = null;
655 public class ViewChangedListener {
656 Set<IListenRoleChange> roleListeners;
658 public ViewChangedListener(Set<IListenRoleChange> s) {
659 this.roleListeners = s;
663 public void viewChanged(ViewChangedEvent e) {
664 for (IListenRoleChange i : this.roleListeners) {
665 i.newActiveAvailable();