import quincy 17.2.0

[ceph.git] / ceph / src / arrow / java / flight / flight-core / src / main / java / org / apache / arrow / flight / CallStatus.java

diff --git a/ceph/src/arrow/java/flight/flight-core/src/main/java/org/apache/arrow/flight/CallStatus.java b/ceph/src/arrow/java/flight/flight-core/src/main/java/org/apache/arrow/flight/CallStatus.java
new file mode 100644 (file)
index 0000000..991d0ed
--- /dev/null
+++ b/ceph/src/arrow/java/flight/flight-core/src/main/java/org/apache/arrow/flight/CallStatus.java
@@ -0,0 +1,143 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.arrow.flight;
+
+import java.util.Objects;
+
+import org.apache.arrow.flight.FlightProducer.ServerStreamListener;
+import org.apache.arrow.flight.FlightProducer.StreamListener;
+
+/**
+ * The result of a Flight RPC, consisting of a status code with an optional description and/or exception that led
+ * to the status.
+ *
+ * <p>If raised or sent through {@link StreamListener#onError(Throwable)} or
+ * {@link ServerStreamListener#error(Throwable)}, the client call will raise the same error (a
+ * {@link FlightRuntimeException} with the same {@link FlightStatusCode} and description). The exception within, if
+ * present, will not be sent to the client.
+ */
+public class CallStatus {
+
+  private final FlightStatusCode code;
+  private final Throwable cause;
+  private final String description;
+  private final ErrorFlightMetadata metadata;
+
+  public static final CallStatus UNKNOWN = FlightStatusCode.UNKNOWN.toStatus();
+  public static final CallStatus INTERNAL = FlightStatusCode.INTERNAL.toStatus();
+  public static final CallStatus INVALID_ARGUMENT = FlightStatusCode.INVALID_ARGUMENT.toStatus();
+  public static final CallStatus TIMED_OUT = FlightStatusCode.TIMED_OUT.toStatus();
+  public static final CallStatus NOT_FOUND = FlightStatusCode.NOT_FOUND.toStatus();
+  public static final CallStatus ALREADY_EXISTS = FlightStatusCode.ALREADY_EXISTS.toStatus();
+  public static final CallStatus CANCELLED = FlightStatusCode.CANCELLED.toStatus();
+  public static final CallStatus UNAUTHENTICATED = FlightStatusCode.UNAUTHENTICATED.toStatus();
+  public static final CallStatus UNAUTHORIZED = FlightStatusCode.UNAUTHORIZED.toStatus();
+  public static final CallStatus UNIMPLEMENTED = FlightStatusCode.UNIMPLEMENTED.toStatus();
+  public static final CallStatus UNAVAILABLE = FlightStatusCode.UNAVAILABLE.toStatus();
+
+  /**
+   * Create a new status.
+   *
+   * @param code The status code.
+   * @param cause An exception that resulted in this status (or null).
+   * @param description A description of the status (or null).
+   */
+  public CallStatus(FlightStatusCode code, Throwable cause, String description, ErrorFlightMetadata metadata) {
+    this.code = Objects.requireNonNull(code);
+    this.cause = cause;
+    this.description = description == null ? "" : description;
+    this.metadata = metadata == null ? new ErrorFlightMetadata() : metadata;
+  }
+
+  /**
+   * Create a new status with no cause or description.
+   *
+   * @param code The status code.
+   */
+  public CallStatus(FlightStatusCode code) {
+    this(code, /* no cause */ null, /* no description */ null, /* no metadata */ null);
+  }
+
+  /**
+   * The status code describing the result of the RPC.
+   */
+  public FlightStatusCode code() {
+    return code;
+  }
+
+  /**
+   * The exception that led to this result. May be null.
+   */
+  public Throwable cause() {
+    return cause;
+  }
+
+  /**
+   * A description of the result.
+   */
+  public String description() {
+    return description;
+  }
+
+  /**
+   * Metadata associated with the exception.
+   *
+   * May be null.
+   */
+  public ErrorFlightMetadata metadata() {
+    return metadata;
+  }
+
+  /**
+   * Return a copy of this status with an error message.
+   */
+  public CallStatus withDescription(String message) {
+    return new CallStatus(code, cause, message, metadata);
+  }
+
+  /**
+   * Return a copy of this status with the given exception as the cause. This will not be sent over the wire.
+   */
+  public CallStatus withCause(Throwable t) {
+    return new CallStatus(code, t, description, metadata);
+  }
+
+  /**
+   * Return a copy of this status with associated exception metadata.
+   */
+  public CallStatus withMetadata(ErrorFlightMetadata metadata) {
+    return new CallStatus(code, cause, description, metadata);
+  }
+
+  /**
+   * Convert the status to an equivalent exception.
+   */
+  public FlightRuntimeException toRuntimeException() {
+    return new FlightRuntimeException(this);
+  }
+
+  @Override
+  public String toString() {
+    return "CallStatus{" +
+        "code=" + code +
+        ", cause=" + cause +
+        ", description='" + description +
+        "', metadata='" + metadata + '\'' +
+        '}';
+  }
+}