io.vertx.oracleclient.OracleConnection Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2022 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
* which is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
*/
package io.vertx.oracleclient;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.Vertx;
import io.vertx.oracleclient.impl.OracleConnectionImpl;
import io.vertx.sqlclient.PreparedStatement;
import io.vertx.sqlclient.SqlConnection;
import java.util.Objects;
import static io.vertx.oracleclient.OracleConnectOptions.fromUri;
/**
* A connection to Oracle Database.
*/
@VertxGen
public interface OracleConnection extends SqlConnection {
/**
* Create a connection to Oracle with the given {@code connectOptions}.
*
* @param vertx the vertx instance
* @param connectOptions the options for the connection
* @param handler the handler called with the connection or the failure
*/
static void connect(Vertx vertx, OracleConnectOptions connectOptions, Handler> handler) {
Objects.requireNonNull(handler);
OracleConnectionImpl.connect(vertx, connectOptions).onComplete(handler);
}
/**
* Like {@link #connect(Vertx, OracleConnectOptions, Handler)} but returns a {@code Future} of the asynchronous result
*/
static Future connect(Vertx vertx, OracleConnectOptions connectOptions) {
return OracleConnectionImpl.connect(vertx, connectOptions);
}
/**
* Like {@link #connect(Vertx, OracleConnectOptions, Handler)} with options built from {@code connectionUri}.
*/
static void connect(Vertx vertx, String connectionUri, Handler> handler) {
connect(vertx, fromUri(connectionUri), handler);
}
/**
* Like {@link #connect(Vertx, String, Handler)} but returns a {@code Future} of the asynchronous result
*/
static Future connect(Vertx vertx, String connectionUri) {
return connect(vertx, fromUri(connectionUri));
}
/**
* {@inheritDoc}
*/
@Fluent
@Override
OracleConnection prepare(String s, Handler> handler);
/**
* {@inheritDoc}
*/
@Fluent
@Override
OracleConnection exceptionHandler(Handler handler);
/**
* {@inheritDoc}
*/
@Fluent
@Override
OracleConnection closeHandler(Handler handler);
/**
* Cast a {@link SqlConnection} to {@link OracleConnection}.
*
* This is mostly useful for Vert.x generated APIs like RxJava/Mutiny.
*
* @param sqlConnection the connection to cast
* @return a {@link OracleConnection instance}
*/
static OracleConnection cast(SqlConnection sqlConnection) {
return (OracleConnection) sqlConnection;
}
}