net.sf.ehcache.transaction.SoftLockManager Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ehcache-core Show documentation
Show all versions of ehcache-core Show documentation
This is the ehcache core module. Pair it with other modules for added functionality.
/**
* Copyright Terracotta, Inc.
*
* 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 net.sf.ehcache.transaction;
import net.sf.ehcache.Element;
import net.sf.ehcache.store.Store;
import net.sf.ehcache.transaction.local.LocalTransactionContext;
import java.util.Set;
/**
* A factory for {@link SoftLock}s
*
* @author Ludovic Orban
*/
public interface SoftLockManager {
/**
* Create a new soft lock ID and associated soft lock if necessary.
*
* @param transactionID the transaction ID under which the soft lock will operate
* @param key the key of the Element this soft lock is protecting
* @param newElement the new Element
* @param oldElement the actual Element
* @param pinned true if the actual Element is pinned
* @return the soft lock ID
*/
SoftLockID createSoftLockID(TransactionID transactionID, Object key, Element newElement, Element oldElement, boolean pinned);
/**
* Clear a soft lock
* @param softLock the lock to clear
*/
void clearSoftLock(SoftLock softLock);
/**
* Find a previously created and still existing soft lock
* @param softLockId the soft lock's ID
* @return the soft lock
*/
SoftLock findSoftLockById(SoftLockID softLockId);
/**
* Get a Set of keys protected by soft locks which must not be visible to a transaction context
* according to the isolation level.
* @param transactionContext the transaction context
* @return a Set of keys invisible to the context
*/
Set
© 2015 - 2024 Weber Informatics LLC | Privacy Policy