org.camunda.bpm.engine.impl.db.entitymanager.OptimisticLockingListener Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
* under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright
* ownership. Camunda licenses this file to you under the Apache License,
* Version 2.0; 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.camunda.bpm.engine.impl.db.entitymanager;
import org.camunda.bpm.engine.impl.db.DbEntity;
import org.camunda.bpm.engine.impl.db.entitymanager.operation.DbOperation;
import org.camunda.bpm.engine.impl.db.entitymanager.operation.DbOperationType;
/**
* Allows registering a listener which is notified when an
* {@link DbOperationType#UPDATE} or {@link DbOperationType#DELETE}
* could not be performed.
*
* @author Daniel Meyer
*
*/
public interface OptimisticLockingListener {
/**
* The type of the entity for which this listener should be notified.
* If the implementation returns 'null', the listener is notified for all
* entity types.
*
* @return the entity type for which the listener should be notified.
*/
Class getEntityType();
/**
* Signifies that an operation failed due to optimistic locking.
*
* @param operation the failed operation.
* @return {@link OptimisticLockingResult} that instructs the caller how to handle
* the result of the failed operation.
*/
OptimisticLockingResult failedOperation(DbOperation operation);
}