com.datastax.driver.core.Responses Maven / Gradle / Ivy

Go to download
/*
 * Copyright DataStax, Inc.
 *
 * This software can be used solely with DataStax Enterprise. Please consult the license at
 * http://www.datastax.com/terms/datastax-dse-driver-license-terms
 */
package com.datastax.driver.core;

import static com.datastax.driver.core.SchemaElement.AGGREGATE;
import static com.datastax.driver.core.SchemaElement.FUNCTION;
import static com.datastax.driver.core.SchemaElement.KEYSPACE;
import static com.datastax.driver.core.SchemaElement.TABLE;

import com.datastax.driver.core.Responses.Result.Rows.Metadata;
import com.datastax.driver.core.exceptions.AlreadyExistsException;
import com.datastax.driver.core.exceptions.AuthenticationException;
import com.datastax.driver.core.exceptions.BootstrappingException;
import com.datastax.driver.core.exceptions.ClientWriteException;
import com.datastax.driver.core.exceptions.DriverException;
import com.datastax.driver.core.exceptions.DriverInternalError;
import com.datastax.driver.core.exceptions.FunctionExecutionException;
import com.datastax.driver.core.exceptions.InvalidConfigurationInQueryException;
import com.datastax.driver.core.exceptions.InvalidQueryException;
import com.datastax.driver.core.exceptions.OverloadedException;
import com.datastax.driver.core.exceptions.ProtocolError;
import com.datastax.driver.core.exceptions.ReadFailureException;
import com.datastax.driver.core.exceptions.ReadTimeoutException;
import com.datastax.driver.core.exceptions.ServerError;
import com.datastax.driver.core.exceptions.SyntaxError;
import com.datastax.driver.core.exceptions.TruncateException;
import com.datastax.driver.core.exceptions.UnauthorizedException;
import com.datastax.driver.core.exceptions.UnavailableException;
import com.datastax.driver.core.exceptions.UnpreparedException;
import com.datastax.driver.core.exceptions.WriteFailureException;
import com.datastax.driver.core.exceptions.WriteTimeoutException;
import com.datastax.driver.core.utils.Bytes;
import io.netty.buffer.ByteBuf;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.nio.ByteBuffer;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Collections;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.Set;

class Responses {

  private Responses() {}

  static class Error extends Message.Response {

    static final Message.Decoder decoder =
        new Message.Decoder() {
          @Override
          public Error decode(ByteBuf body, ProtocolVersion version, CodecRegistry codecRegistry) {
            ExceptionCode code = ExceptionCode.fromValue(body.readInt());
            String msg = CBUtil.readString(body);
            Object infos = null;
            ConsistencyLevel clt;
            int received, blockFor;
            switch (code) {
              case UNAVAILABLE:
                ConsistencyLevel clu = CBUtil.readConsistencyLevel(body);
                int required = body.readInt();
                int alive = body.readInt();
                infos = new UnavailableException(clu, required, alive);
                break;
              case WRITE_TIMEOUT:
              case READ_TIMEOUT:
                clt = CBUtil.readConsistencyLevel(body);
                received = body.readInt();
                blockFor = body.readInt();
                if (code == ExceptionCode.WRITE_TIMEOUT) {
                  WriteType writeType = Enum.valueOf(WriteType.class, CBUtil.readString(body));
                  infos = new WriteTimeoutException(clt, writeType, received, blockFor);
                } else {
                  byte dataPresent = body.readByte();
                  infos = new ReadTimeoutException(clt, received, blockFor, dataPresent != 0);
                }
                break;
              case WRITE_FAILURE:
              case READ_FAILURE:
                clt = CBUtil.readConsistencyLevel(body);
                received = body.readInt();
                blockFor = body.readInt();
                int failures = body.readInt();
                Map failuresMap;
                if (version.compareTo(ProtocolVersion.V5) < 0) {
                  failuresMap = Collections.emptyMap();
                } else {
                  failuresMap = new HashMap();
                  for (int i = 0; i < failures; i++) {
                    InetAddress address = CBUtil.readInetWithoutPort(body);
                    int reasonCode = body.readUnsignedShort();
                    failuresMap.put(address, reasonCode);
                  }
                }
                if (code == ExceptionCode.WRITE_FAILURE) {
                  WriteType writeType = Enum.valueOf(WriteType.class, CBUtil.readString(body));
                  infos =
                      new WriteFailureException(
                          clt, writeType, received, blockFor, failures, failuresMap);
                } else {
                  byte dataPresent = body.readByte();
                  infos =
                      new ReadFailureException(
                          clt, received, blockFor, failures, failuresMap, dataPresent != 0);
                }
                break;
              case UNPREPARED:
                infos = MD5Digest.wrap(CBUtil.readBytes(body));
                break;
              case ALREADY_EXISTS:
                String ksName = CBUtil.readString(body);
                String cfName = CBUtil.readString(body);
                infos = new AlreadyExistsException(ksName, cfName);
                break;
              case CLIENT_WRITE_FAILURE:
                infos = new ClientWriteException(msg);
                break;
            }
            return new Error(version, code, msg, infos);
          }
        };

    final ProtocolVersion serverProtocolVersion;
    final ExceptionCode code;
    final String message;
    final Object infos; // can be null

    private Error(
        ProtocolVersion serverProtocolVersion, ExceptionCode code, String message, Object infos) {
      super(Message.Response.Type.ERROR);
      this.serverProtocolVersion = serverProtocolVersion;
      this.code = code;
      this.message = message;
      this.infos = infos;
    }

    DriverException asException(InetSocketAddress host) {
      switch (code) {
        case SERVER_ERROR:
          return new ServerError(host, message);
        case PROTOCOL_ERROR:
          return new ProtocolError(host, message);
        case BAD_CREDENTIALS:
          return new AuthenticationException(host, message);
        case UNAVAILABLE:
          return ((UnavailableException) infos).copy(host); // We copy to have a nice stack trace
        case OVERLOADED:
          return new OverloadedException(host, message);
        case IS_BOOTSTRAPPING:
          return new BootstrappingException(host, message);
        case TRUNCATE_ERROR:
          return new TruncateException(host, message);
        case WRITE_TIMEOUT:
          return ((WriteTimeoutException) infos).copy(host);
        case READ_TIMEOUT:
          return ((ReadTimeoutException) infos).copy(host);
        case WRITE_FAILURE:
          return ((WriteFailureException) infos).copy(host);
        case READ_FAILURE:
          return ((ReadFailureException) infos).copy(host);
        case FUNCTION_FAILURE:
          return new FunctionExecutionException(host, message);
        case SYNTAX_ERROR:
          return new SyntaxError(host, message);
        case UNAUTHORIZED:
          return new UnauthorizedException(host, message);
        case INVALID:
          return new InvalidQueryException(host, message);
        case CONFIG_ERROR:
          return new InvalidConfigurationInQueryException(host, message);
        case ALREADY_EXISTS:
          return ((AlreadyExistsException) infos).copy(host);
        case UNPREPARED:
          return new UnpreparedException(host, message);
        case CLIENT_WRITE_FAILURE:
          return ((ClientWriteException) infos).copy();
        default:
          return new DriverInternalError(
              String.format(
                  "Unknown protocol error code %s returned by %s. The error message was: %s",
                  code, host, message));
      }
    }

    @Override
    public String toString() {
      return "ERROR " + code + ": " + message;
    }
  }

  static class Ready extends Message.Response {

    static final Message.Decoder decoder =
        new Message.Decoder() {
          @Override
          public Ready decode(ByteBuf body, ProtocolVersion version, CodecRegistry codecRegistry) {
            // TODO: Would it be cool to return a singleton? Check we don't need to
            // set the streamId or something
            return new Ready();
          }
        };

    Ready() {
      super(Message.Response.Type.READY);
    }

    @Override
    public String toString() {
      return "READY";
    }
  }

  static class Authenticate extends Message.Response {

    static final Message.Decoder decoder =
        new Message.Decoder() {
          @Override
          public Authenticate decode(
              ByteBuf body, ProtocolVersion version, CodecRegistry codecRegistry) {
            String authenticator = CBUtil.readString(body);
            return new Authenticate(authenticator);
          }
        };

    final String authenticator;

    Authenticate(String authenticator) {
      super(Message.Response.Type.AUTHENTICATE);
      this.authenticator = authenticator;
    }

    @Override
    public String toString() {
      return "AUTHENTICATE " + authenticator;
    }
  }

  static class Supported extends Message.Response {

    static final Message.Decoder decoder =
        new Message.Decoder() {
          @Override
          public Supported decode(
              ByteBuf body, ProtocolVersion version, CodecRegistry codecRegistry) {
            return new Supported(CBUtil.readStringToStringListMap(body));
          }
        };

    final Map> supported;
    final Set supportedCompressions =
        EnumSet.noneOf(ProtocolOptions.Compression.class);

    Supported(Map> supported) {
      super(Message.Response.Type.SUPPORTED);
      this.supported = supported;

      parseCompressions();
    }

    private void parseCompressions() {
      List compList = supported.get(Requests.Startup.COMPRESSION_OPTION);
      if (compList == null) return;

      for (String compStr : compList) {
        ProtocolOptions.Compression compr = ProtocolOptions.Compression.fromString(compStr);
        if (compr != null) supportedCompressions.add(compr);
      }
    }

    @Override
    public String toString() {
      return "SUPPORTED " + supported;
    }
  }

  abstract static class Result extends Message.Response {

    static final Message.Decoder decoder =
        new Message.Decoder() {
          @Override
          public Result decode(ByteBuf body, ProtocolVersion version, CodecRegistry codecRegistry) {
            Kind kind = Kind.fromId(body.readInt());
            return kind.subDecoder.decode(body, version, codecRegistry);
          }
        };

    enum Kind {
      VOID(1, Void.subcodec),
      ROWS(2, Rows.subcodec),
      SET_KEYSPACE(3, SetKeyspace.subcodec),
      PREPARED(4, Prepared.subcodec),
      SCHEMA_CHANGE(5, SchemaChange.subcodec);

      private final int id;
      final Message.Decoder subDecoder;

      private static final Kind[] ids;

      static {
        int maxId = -1;
        for (Kind k : Kind.values()) maxId = Math.max(maxId, k.id);
        ids = new Kind[maxId + 1];
        for (Kind k : Kind.values()) {
          if (ids[k.id] != null) throw new IllegalStateException("Duplicate kind id");
          ids[k.id] = k;
        }
      }

      Kind(int id, Message.Decoder subDecoder) {
        this.id = id;
        this.subDecoder = subDecoder;
      }

      static Kind fromId(int id) {
        Kind k = ids[id];
        if (k == null)
          throw new DriverInternalError(String.format("Unknown kind id %d in RESULT message", id));
        return k;
      }
    }

    final Kind kind;

    protected Result(Kind kind) {
      super(Message.Response.Type.RESULT);
      this.kind = kind;
    }

    static class Void extends Result {
      // Even though we have no specific information here, don't make a
      // singleton since as each message it has in fact a streamid and connection.
      Void() {
        super(Kind.VOID);
      }

      static final Message.Decoder subcodec =
          new Message.Decoder() {
            @Override
            public Result decode(
                ByteBuf body, ProtocolVersion version, CodecRegistry codecRegistry) {
              return new Void();
            }
          };

      @Override
      public String toString() {
        return "EMPTY RESULT";
      }
    }

    static class SetKeyspace extends Result {
      final String keyspace;

      private SetKeyspace(String keyspace) {
        super(Kind.SET_KEYSPACE);
        this.keyspace = keyspace;
      }

      static final Message.Decoder subcodec =
          new Message.Decoder() {
            @Override
            public Result decode(
                ByteBuf body, ProtocolVersion version, CodecRegistry codecRegistry) {
              return new SetKeyspace(CBUtil.readString(body));
            }
          };

      @Override
      public String toString() {
        return "RESULT set keyspace " + keyspace;
      }
    }

    static class Rows extends Result {

      static class Metadata {

        private enum Flag {
          // public flags
          GLOBAL_TABLES_SPEC(0),
          HAS_MORE_PAGES(1),
          NO_METADATA(2),
          METADATA_CHANGED(3),

          // private flags
          CONTINUOUS_PAGING(30),
          LAST_CONTINUOUS_PAGE(31);

          /** The position of the bit that must be set to one to indicate a flag is set */
          private final int pos;

          Flag(int pos) {
            this.pos = pos;
          }

          static EnumSet deserialize(int flags) {
            EnumSet set = EnumSet.noneOf(Flag.class);
            Flag[] values = Flag.values();
            for (Flag value : values) {
              if ((flags & (1 << value.pos)) != 0) set.add(value);
            }
            return set;
          }

          static int serialize(EnumSet flags) {
            int i = 0;
            for (Flag flag : flags) i |= 1 << flag.pos;
            return i;
          }
        }

        static final Metadata EMPTY = new Metadata(null, 0, null, null, null, null);

        final int columnCount;
        final ColumnDefinitions columns; // Can be null if no metadata was asked by the query
        final ByteBuffer pagingState;
        final int[] pkIndices;
        final ContinuousPagingMetadata continuousPage;
        final MD5Digest
            metadataId; // only present if the flag METADATA_CHANGED is set (ROWS response only)

        private Metadata(
            MD5Digest metadataId,
            int columnCount,
            ColumnDefinitions columns,
            ByteBuffer pagingState,
            int[] pkIndices,
            ContinuousPagingMetadata continuousPage) {
          this.metadataId = metadataId;
          this.columnCount = columnCount;
          this.columns = columns;
          this.pagingState = pagingState;
          this.pkIndices = pkIndices;
          this.continuousPage = continuousPage;
        }

        static Metadata decode(
            ByteBuf body, ProtocolVersion protocolVersion, CodecRegistry codecRegistry) {
          return decode(body, false, protocolVersion, codecRegistry);
        }

        static Metadata decode(
            ByteBuf body,
            boolean withPkIndices,
            ProtocolVersion protocolVersion,
            CodecRegistry codecRegistry) {

          // flags & column count
          EnumSet flags = Flag.deserialize(body.readInt());
          int columnCount = body.readInt();

          ByteBuffer state = null;
          if (flags.contains(Flag.HAS_MORE_PAGES)) state = CBUtil.readValue(body);

          MD5Digest resultMetadataId = null;
          if (flags.contains(Flag.METADATA_CHANGED)) {
            assert ProtocolFeature.PREPARED_METADATA_CHANGES.isSupportedBy(protocolVersion)
                : "METADATA_CHANGED flag is not supported in protocol version " + protocolVersion;
            assert !flags.contains(Flag.NO_METADATA)
                : "METADATA_CHANGED and NO_METADATA are mutually exclusive flags";
            resultMetadataId = MD5Digest.wrap(CBUtil.readBytes(body));
          }

          int[] pkIndices = null;
          int pkCount;
          if (withPkIndices && (pkCount = body.readInt()) > 0) {
            pkIndices = new int[pkCount];
            for (int i = 0; i < pkCount; i++) pkIndices[i] = (int) body.readShort();
          }

          ContinuousPagingMetadata optimizedPage =
              flags.contains(Flag.CONTINUOUS_PAGING)
                  ? new ContinuousPagingMetadata(
                      body.readInt(), flags.contains(Flag.LAST_CONTINUOUS_PAGE))
                  : null;

          if (flags.contains(Flag.NO_METADATA))
            return new Metadata(
                resultMetadataId, columnCount, null, state, pkIndices, optimizedPage);

          boolean globalTablesSpec = flags.contains(Flag.GLOBAL_TABLES_SPEC);

          String globalKsName = null;
          String globalCfName = null;
          if (globalTablesSpec) {
            globalKsName = CBUtil.readString(body);
            globalCfName = CBUtil.readString(body);
          }

          // metadata (names/types)
          ColumnDefinitions.Definition[] defs = new ColumnDefinitions.Definition[columnCount];
          for (int i = 0; i < columnCount; i++) {
            String ksName = globalTablesSpec ? globalKsName : CBUtil.readString(body);
            String cfName = globalTablesSpec ? globalCfName : CBUtil.readString(body);
            String name = CBUtil.readString(body);
            DataType type = DataType.decode(body, protocolVersion, codecRegistry);
            defs[i] = new ColumnDefinitions.Definition(ksName, cfName, name, type);
          }

          return new Metadata(
              resultMetadataId,
              columnCount,
              new ColumnDefinitions(defs, codecRegistry),
              state,
              pkIndices,
              optimizedPage);
        }

        @Override
        public String toString() {
          StringBuilder sb = new StringBuilder();

          if (columns == null) {
            sb.append('[').append(columnCount).append(" columns]");
          } else {
            for (ColumnDefinitions.Definition column : columns) {
              sb.append('[').append(column.getName());
              sb.append(" (").append(column.getType()).append(")]");
            }
          }
          if (pagingState != null) sb.append(" (to be continued)");
          return sb.toString();
        }
      }

      static final Message.Decoder subcodec =
          new Message.Decoder() {
            @Override
            public Result decode(
                ByteBuf body, ProtocolVersion version, CodecRegistry codecRegistry) {

              Metadata metadata = Metadata.decode(body, version, codecRegistry);

              int rowCount = body.readInt();
              int columnCount = metadata.columnCount;

              Queue> data = new ArrayDeque>(rowCount);
              for (int i = 0; i < rowCount; i++) {
                List row = new ArrayList(columnCount);
                for (int j = 0; j < columnCount; j++) row.add(CBUtil.readValue(body));
                data.add(row);
              }

              return new Rows(metadata, data, version);
            }
          };

      final Metadata metadata;
      final Queue> data;
      private final ProtocolVersion version;

      private volatile Queue> rows;

      private Rows(Metadata metadata, Queue> data, ProtocolVersion version) {
        super(Kind.ROWS);
        this.metadata = metadata;
        this.data = data;
        this.version = version;
      }

      @Override
      public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("ROWS ").append(metadata).append('\n');
        int rowNumber = 0;
        for (List row : data) {
          if (++rowNumber > 5) {
            break;
          }
          for (int i = 0; i < row.size(); i++) {
            ByteBuffer v = row.get(i);
            if (v == null) {
              sb.append(" | null");
            } else {
              sb.append(" | ");
              if (metadata.columns != null) {
                DataType dataType = metadata.columns.getType(i);
                sb.append(dataType);
                sb.append(" ");
                TypeCodec