org.springframework.transaction.compensating.CompensatingTransactionOperationManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-ldap

Spring LDAP is a Java library for simplifying LDAP operations, based on the pattern of Spring's JdbcTemplate. The framework relieves the user of common chores, such as looking up and closing contexts, looping through results, encoding/decoding values and filters, and more. The LdapTemplate class encapsulates all the plumbing work involved in traditional LDAP programming, such as creating a DirContext, looping through NamingEnumerations, handling exceptions and cleaning up resources. This leaves the programmer to handle the important stuff - where to find data (DNs and Filters) and what do do with it (map to and from domain objects, bind, modify, unbind, etc.), in the same way that JdbcTemplate relieves the programmer of all but the actual SQL and how the data maps to the domain model. In addition to this, Spring LDAP provides transaction support, a pooling library, exception translation from NamingExceptions to a mirrored unchecked Exception hierarchy, as well as several utilities for working with filters, LDAP paths and Attributes.

There is a newer version: 1.3.1.RELEASE

Show newest version

/*
 * Copyright 2005-2007 the original author or authors.
 *
 * 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 org.springframework.transaction.compensating;

/**
 * A CompensatingTransactionOperationManager implementation records and performs
 * operations that are to be performed within a compensating transaction. It
 * keeps track of compensating actions necessary for rolling back each
 * individual operation.
 * 
 * @author Mattias Arthursson
 * @since 1.2
 */
public interface CompensatingTransactionOperationManager {
    /**
     * Indicates that the supplied operation (method name) is to be performed.
     * This method is responsible for recording the current state (prior to the
     * operation), performing the operation, and storing the necessary
     * information to roll back or commit the performed operation.
     * 
     * @param resource
     *            the target resource to perform the operation on.
     * @param operation
     *            The method to be invoked.
     * @param args
     *            Arguments supplied to the method.
     */
    public void performOperation(Object resource, String operation,
            Object[] args);

    /**
     * Rollback all recorded operations by performing each of the recorded
     * rollback operations.
     */
    public void rollback();

    /**
     * Commit all recorded operations. In many cases this means doing nothing,
     * but in some cases some temporary data will need to be removed.
     */
    public void commit();
}