src/main/java/org/onap/music/lockingservice/MusicLockingService.java

   1 /*
   2  * ============LICENSE_START========================================== org.onap.music
   3  * =================================================================== Copyright (c) 2017 AT&T
   4  * Intellectual Property ===================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
   6  * in compliance with the License. You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software distributed under the License
  11  * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
  12  * or implied. See the License for the specific language governing permissions and limitations under
  13  * the License.
  14  *
  15  * ============LICENSE_END=============================================
  16  * ====================================================================
  17  */
  18 package org.onap.music.lockingservice;
  19
  20
  21 import java.io.IOException;
  22 import java.util.StringTokenizer;
  23 import java.util.concurrent.CountDownLatch;
  24
  25 import org.apache.zookeeper.KeeperException;
  26 import org.apache.zookeeper.WatchedEvent;
  27 import org.apache.zookeeper.Watcher;
  28 import org.apache.zookeeper.Watcher.Event.KeeperState;
  29 import org.apache.zookeeper.ZooKeeper;
  30 import org.onap.music.eelf.logging.EELFLoggerDelegate;
  31 import org.onap.music.eelf.logging.format.AppMessages;
  32 import org.onap.music.eelf.logging.format.ErrorSeverity;
  33 import org.onap.music.eelf.logging.format.ErrorTypes;
  34 import org.onap.music.exceptions.MusicLockingException;
  35 import org.onap.music.exceptions.MusicServiceException;
  36 import org.onap.music.main.CachingUtil;
  37 import org.onap.music.main.MusicUtil;
  38
  39
  40 public class MusicLockingService implements Watcher {
  41
  42
  43     private static final int SESSION_TIMEOUT = 180000;
  44     ZkStatelessLockService zkLockHandle = null;
  45     private CountDownLatch connectedSignal = new CountDownLatch(1);
  46     private static EELFLoggerDelegate logger =
  47                     EELFLoggerDelegate.getLogger(MusicLockingService.class);
  48
  49     public MusicLockingService() throws MusicServiceException {
  50         try {
  51             ZooKeeper zk = new ZooKeeper(MusicUtil.getMyZkHost(), SESSION_TIMEOUT, this);
  52             connectedSignal.await();
  53             zkLockHandle = new ZkStatelessLockService(zk);
  54         } catch (IOException e) {
  55             logger.error("Error", e);
  56             logger.error(EELFLoggerDelegate.errorLogger, e.getMessage(),AppMessages.IOERROR, ErrorSeverity.ERROR, ErrorTypes.CONNECTIONERROR);
  57             throw new MusicServiceException("IO Error has occured" + e.getMessage());
  58         } catch (InterruptedException e) {
  59             logger.error("Error", e);
  60                 logger.error(EELFLoggerDelegate.errorLogger, e.getMessage(),AppMessages.EXECUTIONINTERRUPTED, ErrorSeverity.ERROR, ErrorTypes.LOCKINGERROR);
  61             throw new MusicServiceException("Exception Occured " + e.getMessage());
  62         }
  63     }
  64
  65     public MusicLockingService(String lockServer) {
  66         try {
  67             ZooKeeper zk = new ZooKeeper(lockServer, SESSION_TIMEOUT, this);
  68             connectedSignal.await();
  69             zkLockHandle = new ZkStatelessLockService(zk);
  70         } catch (IOException e) {
  71             logger.error("Error", e);
  72             logger.error(EELFLoggerDelegate.errorLogger, e.getMessage(),AppMessages.IOERROR, ErrorSeverity.ERROR, ErrorTypes.CONNECTIONERROR);
  73         }catch( InterruptedException e) {
  74             logger.error("Error", e);
  75             logger.error(EELFLoggerDelegate.errorLogger, e.getMessage(),AppMessages.EXECUTIONINTERRUPTED, ErrorSeverity.ERROR, ErrorTypes.LOCKINGERROR);
  76         }catch(Exception e) {
  77             logger.error("Error", e);
  78             logger.error(EELFLoggerDelegate.errorLogger, e.getMessage(),AppMessages.UNKNOWNERROR, ErrorSeverity.ERROR, ErrorTypes.LOCKINGERROR);
  79         }
  80     }
  81
  82     public ZkStatelessLockService getzkLockHandle() {
  83         return zkLockHandle;
  84     }
  85
  86     public void createLockaIfItDoesNotExist(String lockName) {
  87         if (!zkLockHandle.checkIfLockExists(lockName)) {
  88             String lockHolder = null;
  89             MusicLockState ml = new MusicLockState(MusicLockState.LockStatus.UNLOCKED, lockHolder);
  90             byte[] data = ml.serialize();
  91             zkLockHandle.createLock(lockName, data);
  92         }
  93     }
  94
  95     public void setLockState(String lockName, MusicLockState mls) {
  96         byte[] data = mls.serialize();
  97         zkLockHandle.setNodeData(lockName, data);
  98     }
  99
 100     public MusicLockState getLockState(String lockName) throws MusicLockingException {
 101
 102         byte[] data = null;
 103         try{
 104                 data = zkLockHandle.getNodeData(lockName);
 105         }catch (Exception ex){
 106             logger.error("Error", ex);
 107                 logger.error(EELFLoggerDelegate.errorLogger, ex.getMessage(),AppMessages.UNKNOWNERROR, ErrorSeverity.ERROR, ErrorTypes.LOCKINGERROR);
 108         }
 109         if(data !=null)
 110         return MusicLockState.deSerialize(data);
 111         else {
 112                 logger.error(EELFLoggerDelegate.errorLogger,"",AppMessages.INVALIDLOCK, ErrorSeverity.ERROR, ErrorTypes.LOCKINGERROR);
 113                 throw new  MusicLockingException("Invalid lock or acquire failed");
 114         }
 115     }
 116
 117     public String createLockId(String lockName) {
 118         String lockIdWithSlash = zkLockHandle.createLockId(lockName);
 119         return lockIdWithSlash.replace('/', '$');
 120     }
 121
 122     public boolean isMyTurn(String lockIdWithDollar) {
 123         String lockId = lockIdWithDollar.replace('$', '/');
 124         StringTokenizer st = new StringTokenizer(lockId);
 125         String lockName = "/" + st.nextToken("/");
 126         try {
 127             return zkLockHandle.lock(lockName, lockId);
 128         } catch (KeeperException e) {
 129             logger.error("Error", e);
 130                 logger.error(EELFLoggerDelegate.errorLogger, e.getMessage(),AppMessages.LOCKINGERROR, ErrorSeverity.ERROR, ErrorTypes.LOCKINGERROR);
 131         }catch( InterruptedException e) {
 132             logger.error("Error", e);
 133                 logger.error(EELFLoggerDelegate.errorLogger, e.getMessage(),AppMessages.EXECUTIONINTERRUPTED, ErrorSeverity.ERROR, ErrorTypes.LOCKINGERROR);
 134                 }catch(Exception e) {
 135             logger.error("Error", e);
 136                         logger.error(EELFLoggerDelegate.errorLogger, e.getMessage(),AppMessages.UNKNOWNERROR, ErrorSeverity.ERROR, ErrorTypes.LOCKINGERROR);
 137                 }
 138         return false;
 139     }
 140
 141     public void unlockAndDeleteId(String lockIdWithDollar) throws KeeperException.NoNodeException {
 142         String lockId = lockIdWithDollar.replace('$', '/');
 143         zkLockHandle.unlock(lockId);
 144         CachingUtil.deleteKeysFromDB("'"+lockId+"'");
 145     }
 146
 147     public void deleteLock(String lockName) throws MusicLockingException {
 148         if(lockIdExists(lockName))
 149                 zkLockHandle.deleteLock(lockName);
 150         else{
 151                 throw new MusicLockingException("Lock does not exist.Please check the lock: " + lockName + " and try again");
 152         }
 153     }
 154
 155     public String whoseTurnIsIt(String lockName) {
 156         String lockHolder = zkLockHandle.currentLockHolder(lockName);
 157         return lockHolder.replace('/', '$');
 158
 159     }
 160
 161     public void process(WatchedEvent event) { // Watcher interface
 162         if (event.getState() == KeeperState.SyncConnected) {
 163             connectedSignal.countDown();
 164         }
 165     }
 166
 167
 168     public void close() {
 169         zkLockHandle.close();
 170     }
 171
 172         public boolean lockIdExists(String lockIdWithDollar) {
 173                 String lockId = lockIdWithDollar.replace('$', '/');
 174                 return zkLockHandle.checkIfLockExists(lockId);
 175         }
 176
 177 }