org.glassfish.hk2.xml.api.XmlHandleTransaction Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.hk2.xml.api;

import org.glassfish.hk2.api.MultiException;

/**
 * Represents a transaction that must eventually
 * be committed in order to release the write lock
 * on the beans in the XmlRootHandle
 * 
 * @author jwells
 *
 */
public interface XmlHandleTransaction {
    /**
     * Gets the root handle that started this transaction
     * 
     * @return The root handle that began the transaction
     */
    public XmlRootHandle getRootHandle();
    
    /**
     * Attempts to commit all the changes in this
     * transaction and will release the write lock
     * 
     * @throws MultiException if there was an error when committing
     * the transaction (normally because some validator or
     * PropertyVetoListener failed)
     */
    public void commit() throws MultiException;
    
    /**
     * Abandons this transaction and will release the write lock
     */
    public void abandon();

}