common/src/main/java/org/apache/abdera2/common/protocol/Transactional.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  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.  For additional information regarding
 * copyright in this work, please see the NOTICE file in the top level
 * directory of this distribution.
 */
package org.apache.abdera2.common.protocol;

/**
 * CollectionAdapter implementations can implement the Transactional interface in order to support start/end/compensate
 * behaviors. Providers will invoke the start/end methods before/after calling the appropriate CollectionAdapter methods
 * and will call compensate if an error occurs
 */
public interface Transactional {

    /**
     * Called by the provider before dispatching the request to the adapter
     */
    void start(RequestContext request);

    /**
     * Called by the provider after dispatching the request to the adapter
     */
    void end(RequestContext request, ResponseContext response);

    /**
     * Called by the provider when a processing error occurs
     */
    void compensate(RequestContext request, Throwable t);

}