com.arjuna.ats.jta.recovery.XAResourceRecovery Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of narayana-jta Show documentation

Narayana: ArjunaJTA narayana-jta (jta uber jar)

There is a newer version: 7.2.1.Final

/*
   Copyright The Narayana Authors
   SPDX-License-Identifier: Apache-2.0
 */



package com.arjuna.ats.jta.recovery;

import java.sql.SQLException;

import javax.transaction.xa.XAResource;

/**
 * To perform recovery on arbitrary XAResources we may need
 * to obtain new instances. Users can provide implementations
 * of this interface which we will use at recovery time to re-create
 * XAResources and from them perform recovery.
 *
 * @since JTS 3.3.
 */

public interface XAResourceRecovery
{

    /**
     * Get a resource to use for recovery purposes.
     *
     * @return a new XAResource.
     */

    public XAResource getXAResource () throws SQLException;

    /**
     * Initialise with all properties required to create the resource(s).
     *
     * @param p An arbitrary string from which initialization data
     * is obtained.
     *
     * @return true if initialization happened successfully,
     * false otherwise.
     */

    public boolean initialise (String p) throws SQLException;

    /**
     * Iterate through all of the resources this instance provides
     * access to.
     *
     * @return true if this instance can provide more
     * resources, false otherwise.
     */

    public boolean hasMoreResources ();

}