/*

 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package javax.sql;

import java.sql.SQLException;

import java.sql.ShardingKey;

/**

 * A builder created from a {@code XADataSource} object,

 * used to establish a connection to the database that the

 * {@code data source} object represents.  The connection

 * properties that were specified for the {@code data source} are used as the

 * default values by the {@code XAConnectionBuilder}.

 * <p>The following example illustrates the use of {@code XAConnectionBuilder}

 * to create a {@link XAConnection}:

 *

 * <pre>{@code

 *     DataSource ds = new MyDataSource();

 *     ShardingKey superShardingKey = ds.createShardingKeyBuilder()

 *                           .subkey("EASTERN_REGION", JDBCType.VARCHAR)

 *                           .build();

 *     ShardingKey shardingKey = ds.createShardingKeyBuilder()

 *                           .subkey("PITTSBURGH_BRANCH", JDBCType.VARCHAR)

 *                           .build();

 *     XAConnection con = ds.createXAConnectionBuilder()

 *                       .user("rafa")

 *                       .password("tennis")

 *                       .setShardingKey(shardingKey)

 *                       .setSuperShardingKey(superShardingKey)

 *                       .build();

 * }</pre>

 *

 * @since 1.9

 *

 */

public interface XAConnectionBuilder  {

    /**

     * Specifies the username to be used when creating a connection

     *

     * @param username the database user on whose behalf the connection is being

     * made

     * @return the same {@code XAConnectionBuilder} instance

     */

    XAConnectionBuilder user(String username);

    /**

     * Specifies the password to be used when creating a connection

     *

     * @param password the password to use for this connection. May be {@code null}

     * @return the same {@code XAConnectionBuilder} instance

     */

    XAConnectionBuilder password(String password);

    /**

     * Specifies a {@code shardingKey} to be used when creating a connection

     *

     * @param shardingKey the ShardingKey. May be {@code null}

     * @return the same {@code XAConnectionBuilder} instance

     * @see java.sql.ShardingKey

     * @see java.sql.ShardingKeyBuilder

     */

    XAConnectionBuilder shardingKey(ShardingKey shardingKey);

    /**

     * Specifies a {@code superShardingKey} to be used when creating a connection

     *

     * @param superShardingKey the SuperShardingKey. May be {@code null}

     * @return the same {@code XAConnectionBuilder} instance

     * @see java.sql.ShardingKey

     * @see java.sql.ShardingKeyBuilder

     */

    XAConnectionBuilder superShardingKey(ShardingKey superShardingKey);

    /**

     * Returns an instance of the object defined by this builder.

     *

     * @return The built object

     * @throws java.sql.SQLException If an error occurs building the object

     */

    XAConnection build() throws SQLException;

}