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<IListenRoleChange> 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<NetworkInterface> e = NetworkInterface.getNetworkInterfaces();
101 while (e.hasMoreElements()) {
102 NetworkInterface n = (NetworkInterface) e.nextElement();
103 Enumeration<InetAddress> 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 {} 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 Stack Trace",
248 logger.info("Starting the ClusterManager");
250 //FIXME keeps throwing FileNotFoundException
251 this.cm = new DefaultCacheManager("config/infinispan-config.xml");
252 logger.debug("Allocated ClusterManager");
253 if (this.cm != null) {
255 this.cm.startCache();
256 logger.debug("Started the ClusterManager");
258 } catch (Exception ioe) {
259 logger.error("Cannot configure infinispan .. bailing out ");
260 logger.error("Stack Trace that raised th exception");
261 logger.error("",ioe);
265 logger.debug("Cache Manager has value {}", this.cm);
269 logger.info("Stopping the ClusterManager");
270 if (this.cm != null) {
271 logger.info("Found a valid ClusterManager, now let it be stopped");
275 if (this.gossiper != null) {
276 this.gossiper.stop();
277 this.gossiper = null;
282 public ConcurrentMap<?, ?> createCache(String containerName,
283 String cacheName, Set<cacheMode> cMode) throws CacheExistException,
284 CacheConfigException {
285 EmbeddedCacheManager manager = this.cm;
286 Cache<Object,Object> c;
287 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
288 if (manager == null) {
292 if (manager.cacheExists(realCacheName)) {
293 throw new CacheExistException();
296 // Sanity check to avoid contrasting parameters
297 if (cMode.containsAll(EnumSet.of(
298 IClusterServices.cacheMode.NON_TRANSACTIONAL,
299 IClusterServices.cacheMode.TRANSACTIONAL))) {
300 throw new CacheConfigException();
303 if (cMode.contains(IClusterServices.cacheMode.NON_TRANSACTIONAL)) {
304 c = manager.getCache(realCacheName);
306 } else if (cMode.contains(IClusterServices.cacheMode.TRANSACTIONAL)) {
307 Configuration rc = manager
308 .getCacheConfiguration("transactional-type");
309 manager.defineConfiguration(realCacheName, rc);
310 c = manager.getCache(realCacheName);
317 public ConcurrentMap<?, ?> getCache(String containerName, String cacheName) {
318 EmbeddedCacheManager manager = this.cm;
319 Cache<Object,Object> c;
320 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
321 if (manager == null) {
325 if (manager.cacheExists(realCacheName)) {
326 c = manager.getCache(realCacheName);
333 public void destroyCache(String containerName, String cacheName) {
334 EmbeddedCacheManager manager = this.cm;
335 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
336 if (manager == null) {
339 if (manager.cacheExists(realCacheName)) {
340 manager.removeCache(realCacheName);
345 public boolean existCache(String containerName, String cacheName) {
346 EmbeddedCacheManager manager = this.cm;
347 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
348 if (manager == null) {
351 return manager.cacheExists(realCacheName);
355 public Set<String> getCacheList(String containerName) {
356 Set<String> perContainerCaches = new HashSet<String>();
357 EmbeddedCacheManager manager = this.cm;
358 if (manager == null) {
361 for (String cacheName : manager.getCacheNames()) {
362 if (cacheName.startsWith("{" + containerName + "}_")) {
363 String[] res = cacheName.split("[{}]");
364 if (res.length >= 4 && res[1].equals(containerName)
365 && res[2].equals("_")) {
366 perContainerCaches.add(res[3]);
371 return (perContainerCaches);
375 public Properties getCacheProperties(String containerName, String cacheName) {
376 EmbeddedCacheManager manager = this.cm;
377 if (manager == null) {
380 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
381 if (!manager.cacheExists(realCacheName)) {
384 Configuration conf = manager.getCache(realCacheName).getAdvancedCache()
385 .getCacheConfiguration();
386 Properties p = new Properties();
387 p.setProperty(IClusterServices.cacheProps.TRANSACTION_PROP.toString(),
388 conf.transaction().toString());
389 p.setProperty(IClusterServices.cacheProps.CLUSTERING_PROP.toString(),
390 conf.clustering().toString());
391 p.setProperty(IClusterServices.cacheProps.LOCKING_PROP.toString(), conf
392 .locking().toString());
397 public void addListener(String containerName, String cacheName,
398 IGetUpdates<?, ?> u) throws CacheListenerAddException {
399 EmbeddedCacheManager manager = this.cm;
400 Cache<Object,Object> c;
401 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
402 if (manager == null) {
406 if (!manager.cacheExists(realCacheName)) {
407 throw new CacheListenerAddException();
409 c = manager.getCache(realCacheName);
410 CacheListenerContainer cl = new CacheListenerContainer(u,
411 containerName, cacheName);
416 public Set<IGetUpdates<?, ?>> getListeners(String containerName,
418 EmbeddedCacheManager manager = this.cm;
419 Cache<Object,Object> c;
420 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
421 if (manager == null) {
425 if (!manager.cacheExists(realCacheName)) {
428 c = manager.getCache(realCacheName);
430 Set<IGetUpdates<?, ?>> res = new HashSet<IGetUpdates<?, ?>>();
431 Set<Object> listeners = c.getListeners();
432 for (Object listener : listeners) {
433 if (listener instanceof CacheListenerContainer) {
434 CacheListenerContainer cl = (CacheListenerContainer) listener;
435 res.add(cl.whichListener());
443 public void removeListener(String containerName, String cacheName,
444 IGetUpdates<?, ?> u) {
445 EmbeddedCacheManager manager = this.cm;
446 Cache<Object,Object> c;
447 String realCacheName = "{" + containerName + "}_{" + cacheName + "}";
448 if (manager == null) {
452 if (!manager.cacheExists(realCacheName)) {
455 c = manager.getCache(realCacheName);
457 Set<Object> listeners = c.getListeners();
458 for (Object listener : listeners) {
459 if (listener instanceof CacheListenerContainer) {
460 CacheListenerContainer cl = (CacheListenerContainer) listener;
461 if (cl.whichListener() == u) {
462 c.removeListener(listener);
470 public void tbegin() throws NotSupportedException, SystemException {
471 EmbeddedCacheManager manager = this.cm;
472 if (manager == null) {
473 throw new IllegalStateException();
475 TransactionManager tm = manager.getCache("transactional-type")
476 .getAdvancedCache().getTransactionManager();
478 throw new IllegalStateException();
484 public void tcommit() throws RollbackException, HeuristicMixedException,
485 HeuristicRollbackException, java.lang.SecurityException,
486 java.lang.IllegalStateException, SystemException {
487 EmbeddedCacheManager manager = this.cm;
488 if (manager == null) {
489 throw new IllegalStateException();
491 TransactionManager tm = manager.getCache("transactional-type")
492 .getAdvancedCache().getTransactionManager();
494 throw new IllegalStateException();
500 public void trollback() throws java.lang.IllegalStateException,
501 java.lang.SecurityException, SystemException {
502 EmbeddedCacheManager manager = this.cm;
503 if (manager == null) {
504 throw new IllegalStateException();
506 TransactionManager tm = manager.getCache("transactional-type")
507 .getAdvancedCache().getTransactionManager();
509 throw new IllegalStateException();
515 public Transaction tgetTransaction() throws SystemException {
516 EmbeddedCacheManager manager = this.cm;
517 if (manager == null) {
518 throw new IllegalStateException();
520 TransactionManager tm = manager.getCache("transactional-type")
521 .getAdvancedCache().getTransactionManager();
525 return tm.getTransaction();
529 public boolean amIStandby() {
530 EmbeddedCacheManager manager = this.cm;
531 if (manager == null) {
532 // In case we cannot fetch the information, lets assume we
533 // are standby, so to have less responsibility.
536 return (!manager.isCoordinator());
539 private InetAddress addressToInetAddress(Address a) {
540 EmbeddedCacheManager manager = this.cm;
541 if ((manager == null) || (a == null)) {
542 // In case we cannot fetch the information, lets assume we
543 // are standby, so to have less responsibility.
546 Transport t = manager.getTransport();
547 if (t instanceof JGroupsTransport) {
548 JGroupsTransport jt = (JGroupsTransport) t;
549 Channel c = jt.getChannel();
550 if (a instanceof JGroupsAddress) {
551 JGroupsAddress ja = (JGroupsAddress) a;
552 org.jgroups.Address phys = (org.jgroups.Address) c
553 .down(new Event(Event.GET_PHYSICAL_ADDRESS, ja
554 .getJGroupsAddress()));
555 if (phys instanceof org.jgroups.stack.IpAddress) {
556 InetAddress bindAddress = ((org.jgroups.stack.IpAddress) phys)
565 public List<InetAddress> getClusteredControllers() {
566 EmbeddedCacheManager manager = this.cm;
567 if (manager == null) {
570 List<Address> controllers = manager.getMembers();
571 if ((controllers == null) || controllers.size() == 0)
574 List<InetAddress> clusteredControllers = new ArrayList<InetAddress>();
575 for (Address a : controllers) {
576 InetAddress inetAddress = addressToInetAddress(a);
577 if (inetAddress != null
578 && !inetAddress.getHostAddress().equals(loopbackAddress))
579 clusteredControllers.add(inetAddress);
581 return clusteredControllers;
584 public InetAddress getMyAddress() {
585 EmbeddedCacheManager manager = this.cm;
586 if (manager == null) {
589 return addressToInetAddress(manager.getAddress());
593 public InetAddress getActiveAddress() {
594 EmbeddedCacheManager manager = this.cm;
595 if (manager == null) {
596 // In case we cannot fetch the information, lets assume we
597 // are standby, so to have less responsibility.
601 return addressToInetAddress(manager.getCoordinator());
605 public void listenRoleChange(IListenRoleChange i)
606 throws ListenRoleChangeAddException {
607 EmbeddedCacheManager manager = this.cm;
608 if (manager == null) {
609 // In case we cannot fetch the information, lets assume we
610 // are standby, so to have less responsibility.
611 throw new ListenRoleChangeAddException();
614 if (this.roleChangeListeners == null) {
615 this.roleChangeListeners = new HashSet<IListenRoleChange>();
616 this.cacheManagerListener = new ViewChangedListener(
617 this.roleChangeListeners);
618 manager.addListener(this.cacheManagerListener);
621 if (this.roleChangeListeners != null) {
622 this.roleChangeListeners.add(i);
627 public void unlistenRoleChange(IListenRoleChange i) {
628 EmbeddedCacheManager manager = this.cm;
629 if (manager == null) {
630 // In case we cannot fetch the information, lets assume we
631 // are standby, so to have less responsibility.
635 if (this.roleChangeListeners != null) {
636 this.roleChangeListeners.remove(i);
639 if ((this.roleChangeListeners != null && this.roleChangeListeners
641 && (this.cacheManagerListener != null)) {
642 manager.removeListener(this.cacheManagerListener);
643 this.cacheManagerListener = null;
644 this.roleChangeListeners = null;
649 public class ViewChangedListener {
650 Set<IListenRoleChange> roleListeners;
652 public ViewChangedListener(Set<IListenRoleChange> s) {
653 this.roleListeners = s;
657 public void viewChanged(ViewChangedEvent e) {
658 for (IListenRoleChange i : this.roleListeners) {
659 i.newActiveAvailable();