geode-core/src/main/java/org/apache/geode/distributed/internal/locks/DLockBatch.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You 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 org.apache.geode.distributed.internal.locks;

import java.util.List;

import org.apache.geode.distributed.internal.membership.InternalDistributedMember;

/**
 * Collection of distributed locks to be processed as a batch.
 *
 */
public interface DLockBatch {

  /** Returns the originator (owner) of this batch of locks */
  InternalDistributedMember getOwner();

  /** Returns the identity object of the batch; like a hash map key */
  DLockBatchId getBatchId();

  /** Returns the list of TXRegionLockRequest instances */
  List getReqs();

  /**
   * Specifies the lock grantor id that granted this lock batch.
   *
   * @param lockGrantorId the lock grantor id that granted this lock batch
   */
  void grantedBy(LockGrantorId lockGrantorId);

}