src/main/java/org/onap/music/lockingservice/zookeeper/ProtocolSupport.java

   1 /*
   2  * ============LICENSE_START==========================================
   3  * org.onap.music
   4  * ===================================================================
   5  *  Copyright (c) 2017 AT&T Intellectual Property
   6  *  Modifications Copyright (C) 2018 IBM.
   7  * ===================================================================
   8  *  Licensed under the Apache License, Version 2.0 (the "License");
   9  *  you may not use this file except in compliance with the License.
  10  *  You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *  Unless required by applicable law or agreed to in writing, software
  15  *  distributed under the License is distributed on an "AS IS" BASIS,
  16  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  *  See the License for the specific language governing permissions and
  18  *  limitations under the License.
  19  *
  20  * ============LICENSE_END=============================================
  21  * ====================================================================
  22  */
  23
  24 package org.onap.music.lockingservice.zookeeper;
  25
  26 import org.apache.zookeeper.CreateMode;
  27 import org.apache.zookeeper.KeeperException;
  28 import org.apache.zookeeper.ZooDefs;
  29 import org.apache.zookeeper.ZooKeeper;
  30 import org.apache.zookeeper.data.ACL;
  31 import org.apache.zookeeper.data.Stat;
  32 import org.onap.music.eelf.logging.EELFLoggerDelegate;
  33 import org.onap.music.eelf.logging.format.AppMessages;
  34 import org.onap.music.eelf.logging.format.ErrorSeverity;
  35 import org.onap.music.eelf.logging.format.ErrorTypes;
  36 import org.onap.music.lockingservice.zookeeper.ZooKeeperOperation;
  37
  38 import java.util.List;
  39 import java.util.concurrent.atomic.AtomicBoolean;
  40
  41 /**
  42  * A base class for protocol implementations which provides a number of higher level helper methods
  43  * for working with ZooKeeper along with retrying synchronous operations if the connection to
  44  * ZooKeeper closes such as {@link #retryOperation(ZooKeeperOperation)}
  45  *
  46  */
  47 class ProtocolSupport {
  48     private EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(ProtocolSupport.class);
  49
  50     protected ZooKeeper zookeeper;
  51     private AtomicBoolean closed = new AtomicBoolean(false);
  52     private long retryDelay = 500L;
  53     private int retryCount = 10;
  54     private List<ACL> acl = ZooDefs.Ids.OPEN_ACL_UNSAFE;
  55
  56     /**
  57      * Closes this strategy and releases any ZooKeeper resources; but keeps the ZooKeeper instance
  58      * open
  59      */
  60     public void close() {
  61         if (closed.compareAndSet(false, true)) {
  62             doClose();
  63         }
  64     }
  65
  66     /**
  67      * return zookeeper client instance
  68      *
  69      * @return zookeeper client instance
  70      */
  71     public ZooKeeper getZookeeper() {
  72         return zookeeper;
  73     }
  74
  75     /**
  76      * return the acl its using
  77      *
  78      * @return the acl.
  79      */
  80     public List<ACL> getAcl() {
  81         return acl;
  82     }
  83
  84     /**
  85      * set the acl
  86      *
  87      * @param acl the acl to set to
  88      */
  89     public void setAcl(List<ACL> acl) {
  90         this.acl = acl;
  91     }
  92
  93     /**
  94      * get the retry delay in milliseconds
  95      *
  96      * @return the retry delay
  97      */
  98     public long getRetryDelay() {
  99         return retryDelay;
 100     }
 101
 102     /**
 103      * Sets the time waited between retry delays
 104      *
 105      * @param retryDelay the retry delay
 106      */
 107     public void setRetryDelay(long retryDelay) {
 108         this.retryDelay = retryDelay;
 109     }
 110
 111     /**
 112      * Allow derived classes to perform some custom closing operations to release resources
 113      */
 114     protected void doClose() {
 115         throw new UnsupportedOperationException();
 116     }
 117
 118
 119     /**
 120      * Perform the given operation, retrying if the connection fails
 121      *
 122      * @return object. it needs to be cast to the callee's expected return type.
 123      * @param operation FILL IN
 124      * @throws KeeperException FILL IN
 125      * @throws InterruptedException FILL IN
 126      */
 127     protected Object retryOperation(ZooKeeperOperation operation)
 128                     throws KeeperException, InterruptedException {
 129         KeeperException exception = null;
 130         for (int i = 0; i < retryCount; i++) {
 131             try {
 132                 return operation.execute();
 133             } catch (KeeperException.SessionExpiredException e) {
 134                 logger.error(EELFLoggerDelegate.errorLogger, e,AppMessages.SESSIONEXPIRED+" for: " + zookeeper + " so reconnecting due to: " + e, ErrorSeverity.ERROR, ErrorTypes.SESSIONEXPIRED);
 135                 throw e;
 136             } catch (KeeperException.ConnectionLossException e) {
 137                 if (exception == null) {
 138                     exception = e;
 139                 }
 140                 logger.error(EELFLoggerDelegate.errorLogger, e,AppMessages.CONNCECTIVITYERROR, ErrorSeverity.ERROR, ErrorTypes.SESSIONEXPIRED);
 141                 logger.error(EELFLoggerDelegate.errorLogger, e,"Attempt " + i + " failed with connection loss so attempting to reconnect: " + e);
 142
 143                 retryDelay(i);
 144             }
 145         }
 146         if(exception == null)
 147             {
 148               throw new NullPointerException();
 149             }
 150         else{
 151             throw exception;
 152             }
 153     }
 154
 155     /**
 156      * Ensures that the given path exists with no data, the current ACL and no flags
 157      *
 158      * @param path the lock path
 159      */
 160     protected void ensurePathExists(String path)  {
 161         ensureExists(path, null, acl, CreateMode.PERSISTENT);
 162     }
 163
 164     /**
 165      * Ensures that the given path exists with the given data, ACL and flags
 166      *
 167      * @param path the lock path
 168      * @param data the data
 169      * @param acl list of ACLs applying to the path
 170      * @param flags create mode flags
 171      */
 172     protected void ensureExists(final String path, final byte[] data, final List<ACL> acl,
 173                     final CreateMode flags)  {
 174         try {
 175             retryOperation(new ZooKeeperOperation() {
 176                 public boolean execute() throws KeeperException, InterruptedException {
 177                     Stat stat = zookeeper.exists(path, false);
 178                     if (stat != null) {
 179                         return true;
 180                     }
 181                     zookeeper.create(path, data, acl, flags);
 182                     return true;
 183                 }
 184             });
 185         } catch (KeeperException e) {
 186             logger.error(EELFLoggerDelegate.errorLogger, e.getMessage(),AppMessages.KEEPERERROR, ErrorSeverity.ERROR, ErrorTypes.LOCKINGERROR);
 187         } catch (InterruptedException e) {
 188             logger.error(EELFLoggerDelegate.errorLogger, e.getMessage(),AppMessages.EXECUTIONINTERRUPTED, ErrorSeverity.ERROR, ErrorTypes.LOCKINGERROR);
 189         }
 190     }
 191
 192     /**
 193      * Returns true if this protocol has been closed
 194      *
 195      * @return true if this protocol is closed
 196      */
 197     protected boolean isClosed() {
 198         return closed.get();
 199     }
 200
 201     /**
 202      * Performs a retry delay if this is not the first attempt
 203      *
 204      * @param attemptCount the number of the attempts performed so far
 205      */
 206     protected void retryDelay(int attemptCount) {
 207         if (attemptCount > 0) {
 208             try {
 209                 Thread.sleep(attemptCount * retryDelay);
 210             } catch (InterruptedException e) {
 211                 logger.error(EELFLoggerDelegate.errorLogger, e,AppMessages.EXECUTIONINTERRUPTED, ErrorSeverity.ERROR, ErrorTypes.GENERALSERVICEERROR);
 212                 logger.error(EELFLoggerDelegate.errorLogger, e,"Thread failed to sleep: " + e);
 213                 Thread.currentThread().interrupt();
 214             }
 215         }
 216     }
 217 }