CancelFlightInfoRequest.java

/*
 * 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.io.IOException;
import java.net.URISyntaxException;
import java.nio.ByteBuffer;
import java.util.Objects;
import org.apache.arrow.flight.impl.Flight;

/** A request to cancel a FlightInfo. */
public class CancelFlightInfoRequest {
  private final FlightInfo info;

  public CancelFlightInfoRequest(FlightInfo info) {
    this.info = Objects.requireNonNull(info);
  }

  CancelFlightInfoRequest(Flight.CancelFlightInfoRequest proto) throws URISyntaxException {
    this(new FlightInfo(proto.getInfo()));
  }

  public FlightInfo getInfo() {
    return info;
  }

  Flight.CancelFlightInfoRequest toProtocol() {
    Flight.CancelFlightInfoRequest.Builder b = Flight.CancelFlightInfoRequest.newBuilder();
    b.setInfo(info.toProtocol());
    return b.build();
  }

  /**
   * Get the serialized form of this protocol message.
   *
   * <p>Intended to help interoperability by allowing non-Flight services to still return Flight
   * types.
   */
  public ByteBuffer serialize() {
    return ByteBuffer.wrap(toProtocol().toByteArray());
  }

  /**
   * Parse the serialized form of this protocol message.
   *
   * <p>Intended to help interoperability by allowing Flight clients to obtain stream info from
   * non-Flight services.
   *
   * @param serialized The serialized form of the message, as returned by {@link #serialize()}.
   * @return The deserialized message.
   * @throws IOException if the serialized form is invalid.
   */
  public static CancelFlightInfoRequest deserialize(ByteBuffer serialized)
      throws IOException, URISyntaxException {
    return new CancelFlightInfoRequest(Flight.CancelFlightInfoRequest.parseFrom(serialized));
  }
}