EDBBeginCommitHook.java

/**
 * Licensed to the Austrian Association for Software Tool Integration (AASTI)
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. The AASTI 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.openengsb.core.edb.api.hooks;

import org.openengsb.core.edb.api.EDBCommit;
import org.openengsb.core.edb.api.EDBException;

/**
 * Defines the functions of the begin-commit hook for the EDB component. All services in the OSGi environment providing
 * this interface which are exported by any bundle, will be called when the EDB gets an EDBCommit to persist. It is the
 * first hook that is called in the commit procedure.
 * 
 * Normally this hook is used to check if the EDBCommit is valid (e.g. the authenticated user is allowed to do the
 * commit).
 */
public interface EDBBeginCommitHook {

    /**
     * This function is called when the EDB gets an EDBCommit object to persist and before the pre-commit hook is
     * called. If this method throws an EDBEexception, it is directly returned to the calling instance. Every other
     * exception gets caught, logged and ignored.
     */
    void onStartCommit(EDBCommit commit) throws EDBException;
}