opendaylight/clustering/services/src/main/java/org/opendaylight/controller/clustering/services/IClusterServicesCommon.java

   1
   2 /*
   3  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   4  *
   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
   8  */
   9
  10 /**
  11  * @file   IClusterServicesCommon.java
  12  *
  13  * @brief  : Set of services and 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
  17  *
  18  * Contract between the applications and the clustering service
  19  * providers. Common version
  20  */
  21
  22 package org.opendaylight.controller.clustering.services;
  23
  24 import java.net.InetAddress;
  25 import java.util.List;
  26 import java.util.Properties;
  27 import java.util.Set;
  28 import java.util.concurrent.ConcurrentMap;
  29
  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;
  36
  37 /**
  38  * @deprecated for internal use
  39  * Set of services and application will expect from the
  40  * clustering services provider. This interface is going to be the
  41  * base for per-container and Global services and so the container
  42  * parameter is omitted but who uses knows about it
  43  *
  44  */
  45 public interface IClusterServicesCommon {
  46     /**
  47      * Method that will create a new named cache. The data
  48      * structure if already present will cause an exception to be
  49      * thrown to the caller.
  50      *
  51      * @param cacheName Name of the ConcurrentHashMap to create
  52      * @param cMode Mode of the cache that need to be retrieved. This
  53      * is a set such that more than one property can be provided, of
  54      * course contrasting requirements will not be accepted and in
  55      * that case an exception is thrown
  56      *
  57      * @return ConcurrentHashMap to be used to modify the data structure
  58      */
  59     ConcurrentMap<?, ?> createCache(String cacheName,
  60             Set<IClusterServices.cacheMode> cMode) throws CacheExistException,
  61             CacheConfigException;
  62
  63     /**
  64      * Method that will retrieve and return the handle to modify a
  65      * data structire distributed via clustering services. The
  66      * datastructure shall already have been created else a null
  67      * reference will be returned.
  68      *
  69      * @param cacheName Name of the ConcurrentHashMap to retrieve
  70      *
  71      * @return ConcurrentHashMap to be used to modify the data structure
  72      */
  73     ConcurrentMap<?, ?> getCache(String cacheName);
  74
  75     /**
  76      * Destroy a cachename given cachename, if doesn't exist
  77      * the function does nothing. If the datastructure exists, the
  78      * whole cluster will destroy the instance
  79      *
  80      * @param cacheName Name of the ConcurrentHashMap to destroy
  81      */
  82     void destroyCache(String cacheName);
  83
  84     /**
  85      * Function to test the existance of a cache with a given name already
  86      *
  87      * @param cacheName Name of the ConcurrentHashMap to destroy
  88      *
  89      * @return true if exists already, false otherwise
  90      */
  91     boolean existCache(String cacheName);
  92
  93     /**
  94      * Return the list of all teh caches registered in the context of
  95      * the called
  96      *
  97      *
  98      * @return The set of names, expressed as strings
  99      */
 100     Set<String> getCacheList();
 101
 102     /**
 103      * Return a list of properties that caracterize the cache
 104      *
 105      * @param cacheName Name of the cache
 106      *
 107      * @return The list of properties related to the cache
 108      */
 109     Properties getCacheProperties(String cacheName);
 110
 111     /**
 112      * Begin a transaction covering with all the data structures/HW
 113      * updates. One transaction per-thread can be opened at the
 114      * most, that means if multiple thread are available, multiple
 115      * transactions can be outstanding.
 116      *
 117      */
 118     void tbegin() throws NotSupportedException, SystemException;
 119
 120     /**
 121      * Commit a transaction covering all the data structures/HW updates.
 122      */
 123     void tcommit() throws RollbackException, HeuristicMixedException,
 124             HeuristicRollbackException, java.lang.SecurityException,
 125             java.lang.IllegalStateException, SystemException;
 126
 127     /**
 128      * Rollback a transaction covering all the data structures/HW updates
 129      */
 130     void trollback() throws java.lang.IllegalStateException,
 131             java.lang.SecurityException, SystemException;
 132
 133     /**
 134      * Return the javax.transaction.Transaction associated with this thread
 135      *
 136      *
 137      * @return Return the current transaction associated with this thread
 138      */
 139     Transaction tgetTransaction() throws SystemException;
 140
 141     /**
 142      *
 143      * Get the InetAddress of the coordinator controller in the cluster
 144      *
 145      * @return Address of the coordinator controller
 146      */
 147     InetAddress getCoordinatorAddress();
 148
 149     /**
 150      * Get the InetAddress of the all the controllers that make up this
 151      * Cluster
 152      *
 153      * @return List of InetAddress'es of all the controllers
 154      */
 155     List<InetAddress> getClusteredControllers();
 156
 157     /**
 158      * Get the InetAddress of this Controller as seen by the Cluster Manager
 159      *
 160      * @return InetAddress of this Controller as seen by the Cluster Manager.
 161      */
 162     InetAddress getMyAddress();
 163
 164     /**
 165      * Function that is used to know if the node on which is called is
 166      * the cluster coordinator. The API is useful in scenario where
 167      * the same logic is not worthed to be replicated on multiple
 168      * nodes in the cluster and one can cook it up for all the
 169      * others. In this scenario running the logic on the coordinator
 170      * make sense, this of course implies logics that are not heavy
 171      * and don't need to be scaled out linearly with the size of the
 172      * cluster.
 173      *
 174      * @return true if the node on which the API is called is the
 175      * coordinator for the cluster
 176      */
 177     boolean amICoordinator();
 178 }