code: /*
   * Copyright © 2014-2017 EntIT Software LLC, a Micro Focus company (L.P.)
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   *
   *     http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package io.cloudslang.worker.execution.services;
  
  import java.util.Map;
  
  /**
   * User: stoneo
   * Date: 19/08/2014
   * Time: 17:22
   */
  public interface SessionDataHandler {
  
      /**
       * This method should be called by a scheduler, in order to clean session data if expired
       */
      public void sessionTimeOutScheduler();
  
      /**
       * Retrieved the map of global sessions execution data object
       * Also updates the timestamp (touch mechanism) of the session data for the use of the expiration mechanism
       * @param executionId
       * @return the map of execution session data object
       */
      public Map<String, Object> getGlobalSessionsExecutionData(Long executionId);
  
      /**
       * Retrieved the map of execution session data object
       * Also updates the timestamp (touch mechanism) of the session data for the use of the expiration mechanism
       * @param executionId
       * @param branchId
       * @return the map of execution session data object
       */
      public Map<String, Object> getSessionsExecutionData(Long executionId, Long branchId);
  
      /**
       * Set the session data of the execution as active so that no timeout can occur
       * Should be used before executing an action, so that there will be no timeout in the middle of executing an action
       * @param executionId
       */
      void setGlobalSessionDataActive(Long executionId);
  
      /**
       * Set the session data of the execution as inactive
       * Should be used after executing an action, so that timeout might occur if needed
       * @param executionId
       */
      void setGlobalSessionDataInactive(Long executionId);
  
      /**
       * Set the session data of the execution as active so that no timeout can occur
       * Should be used before executing an action, so that there will be no timeout in the middle of executing an action
       * @param executionId
       * @param branchId
       */
      void setSessionDataActive(Long executionId, Long branchId);
  
      /**
       * Set the session data of the execution as inactive
       * Should be used after executing an action, so that timeout might occur if needed
       * @param executionId
       * @param branchId
       */
      void setSessionDataInactive(Long executionId, Long branchId);
  }
  