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
11 * @file IClusterServicesCommon.java
13 * @brief : Set of services an application will expect from the
14 * clustering services provider. This interface is going to be the
15 * base for per-container and Global services and so the container
16 * parameter is omitted but who uses knows about it
18 * Contract between the applications and the clustering service
19 * providers. Common version
22 package org.opendaylight.controller.clustering.services;
24 import java.net.InetAddress;
25 import java.util.List;
26 import java.util.Properties;
28 import java.util.concurrent.ConcurrentMap;
30 import javax.transaction.HeuristicMixedException;
31 import javax.transaction.HeuristicRollbackException;
32 import javax.transaction.NotSupportedException;
33 import javax.transaction.RollbackException;
34 import javax.transaction.SystemException;
35 import javax.transaction.Transaction;
38 * This WILL NOT BE USED DIRECTLY, but VIA SUBCLASS
40 * Set of services and application will expect from the clustering services
41 * provider. This interface is going to be the base for per-container and Global
42 * services and so the container parameter is omitted but who uses knows about
46 public interface IClusterServicesCommon {
48 * Method that will create a new named cache. The data
49 * structure if already present will cause an exception to be
50 * thrown to the caller.
52 * @param cacheName Name of the ConcurrentHashMap to create
53 * @param cMode Mode of the cache that need to be retrieved. This
54 * is a set such that more than one property can be provided, of
55 * course contrasting requirements will not be accepted and in
56 * that case an exception is thrown
58 * @return ConcurrentHashMap to be used to modify the data structure
60 ConcurrentMap<?, ?> createCache(String cacheName,
61 Set<IClusterServices.cacheMode> cMode) throws CacheExistException,
65 * Method that will retrieve and return the handle to modify a
66 * data structire distributed via clustering services. The
67 * datastructure shall already have been created else a null
68 * reference will be returned.
70 * @param cacheName Name of the ConcurrentHashMap to retrieve
72 * @return ConcurrentHashMap to be used to modify the data structure
74 ConcurrentMap<?, ?> getCache(String cacheName);
77 * Destroy a cachename given cachename, if doesn't exist
78 * the function does nothing. If the datastructure exists, the
79 * whole cluster will destroy the instance
81 * @param cacheName Name of the ConcurrentHashMap to destroy
83 void destroyCache(String cacheName);
86 * Function to test the existance of a cache with a given name already
88 * @param cacheName Name of the ConcurrentHashMap to destroy
90 * @return true if exists already, false otherwise
92 boolean existCache(String cacheName);
95 * Return the list of all teh caches registered in the context of
99 * @return The set of names, expressed as strings
101 Set<String> getCacheList();
104 * Return a list of properties that caracterize the cache
106 * @param cacheName Name of the cache
108 * @return The list of properties related to the cache
110 Properties getCacheProperties(String cacheName);
113 * Begin a transaction covering with all the data structures/HW
114 * updates. One transaction per-thread can be opened at the
115 * most, that means if multiple thread are available, multiple
116 * transactions can be outstanding.
119 void tbegin() throws NotSupportedException, SystemException;
122 * Commit a transaction covering all the data structures/HW updates.
124 void tcommit() throws RollbackException, HeuristicMixedException,
125 HeuristicRollbackException, java.lang.SecurityException,
126 java.lang.IllegalStateException, SystemException;
129 * Rollback a transaction covering all the data structures/HW updates
131 void trollback() throws java.lang.IllegalStateException,
132 java.lang.SecurityException, SystemException;
135 * Return the javax.transaction.Transaction associated with this thread
138 * @return Return the current transaction associated with this thread
140 Transaction tgetTransaction() throws SystemException;
144 * Get the InetAddress of the coordinator controller in the cluster
146 * @return Address of the coordinator controller
148 InetAddress getCoordinatorAddress();
151 * Get the InetAddress of the all the controllers that make up this
154 * @return List of InetAddress'es of all the controllers
156 List<InetAddress> getClusteredControllers();
159 * Get the InetAddress of this Controller as seen by the Cluster Manager
161 * @return InetAddress of this Controller as seen by the Cluster Manager.
163 InetAddress getMyAddress();
166 * Function that is used to know if the node on which is called is
167 * the cluster coordinator. The API is useful in scenario where
168 * the same logic is not worthed to be replicated on multiple
169 * nodes in the cluster and one can cook it up for all the
170 * others. In this scenario running the logic on the coordinator
171 * make sense, this of course implies logics that are not heavy
172 * and don't need to be scaled out linearly with the size of the
175 * @return true if the node on which the API is called is the
176 * coordinator for the cluster
178 boolean amICoordinator();