• Home
• com.google.cloud
• google-cloud-spanner-pgadapter
• 0.42.3
• source code
• BootstrapMessage.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.spanner.pgadapter.wireprotocol.BootstrapMessage Maven / Gradle / Ivy

// Copyright 2020 Google LLC
//
// Licensed 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 com.google.cloud.spanner.pgadapter.wireprotocol;

import com.google.api.core.InternalApi;
import com.google.cloud.spanner.pgadapter.ConnectionHandler;
import com.google.cloud.spanner.pgadapter.session.SessionState;
import com.google.cloud.spanner.pgadapter.wireoutput.AuthenticationOkResponse;
import com.google.cloud.spanner.pgadapter.wireoutput.KeyDataResponse;
import com.google.cloud.spanner.pgadapter.wireoutput.NoticeResponse;
import com.google.cloud.spanner.pgadapter.wireoutput.ParameterStatusResponse;
import com.google.cloud.spanner.pgadapter.wireoutput.ReadyResponse;
import com.google.cloud.spanner.pgadapter.wireoutput.ReadyResponse.Status;
import java.io.DataOutputStream;
import java.nio.charset.StandardCharsets;
import java.time.ZoneId;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * This represents all messages which occur before {@link ControlMessage} type messages. Those
 * include encryption, admin (e.g.: cancellation) and start-up messages.
 */
@InternalApi
public abstract class BootstrapMessage extends WireMessage {
  public BootstrapMessage(ConnectionHandler connection, int length) {
    super(connection, length);
  }

  /**
   * Factory method to create the bootstrap message from their designated format. Note this is
   * backwards from control messages where identifier is first and length second.
   *
   * @param connection The connection handler object setup with the ability to send/receive.
   * @return The constructed wire message given the input message.
   * @throws Exception If construction or reading fails.
   */
  public static BootstrapMessage create(ConnectionHandler connection) throws Exception {
    int length = connection.getConnectionMetadata().getInputStream().readInt();
    int protocol = connection.getConnectionMetadata().getInputStream().readInt();
    switch (protocol) {
      case SSLMessage.IDENTIFIER:
        return new SSLMessage(connection);
      case GSSENCRequestMessage.IDENTIFIER:
        return new GSSENCRequestMessage(connection);
      case StartupMessage.IDENTIFIER:
        return new StartupMessage(connection, length);
      case CancelMessage.IDENTIFIER:
        return new CancelMessage(connection);
      default:
        throw new IllegalStateException("Unknown message");
    }
  }

  /**
   * Parses parameters specific to bootstrap messages. Those generally (unlike control parameters)
   * exclude metadata including length and are simple null (0) delimited.
   *
   * @param rawParameters The input string containing parameters (null delimited)
   * @return A KV map of the parameters
   */
  protected Map parseParameters(String rawParameters) {
    Map parameters = new HashMap<>();
    String[] paramArray = rawParameters.split(new String(new byte[] {(byte) 0}));
    for (int i = 0; i < paramArray.length; i = i + 2) {
      parameters.put(paramArray[i], paramArray[i + 1]);
    }
    return parameters;
  }

  /**
   * Parses the parameter keys from the given raw parameter string and returns these in the received
   * order. This can be used to detect the client that is connecting to PGAdapter.
   */
  protected List parseParameterKeys(String rawParameters) {
    List keys = new ArrayList<>();
    String[] paramArray = rawParameters.split(new String(new byte[] {(byte) 0}));
    for (int i = 0; i < paramArray.length; i = i + 2) {
      keys.add(paramArray[i]);
    }
    return keys;
  }

  /**
   * Expected PG start-up reply, including Auth approval, Key Data connection-specific info,
   * PGAdapter specific parameters, and a ready signal.
   *
   * @param output The data output stream to send results to.
   * @param connectionId The connection Id representing the current connection to send to client.
   * @param secret The secret apposite this connection
   * @throws Exception
   */
  public static void sendStartupMessage(
      DataOutputStream output,
      int connectionId,
      int secret,
      SessionState sessionState,
      Iterable startupNotices)
      throws Exception {
    new AuthenticationOkResponse(output).send(false);
    new KeyDataResponse(output, connectionId, secret).send(false);
    new ParameterStatusResponse(
            output,
            "server_version".getBytes(StandardCharsets.UTF_8),
            sessionState.get(null, "server_version").getSetting().getBytes(StandardCharsets.UTF_8))
        .send(false);
    new ParameterStatusResponse(
            output,
            "application_name".getBytes(StandardCharsets.UTF_8),
            "PGAdapter".getBytes(StandardCharsets.UTF_8))
        .send(false);
    new ParameterStatusResponse(
            output,
            "is_superuser".getBytes(StandardCharsets.UTF_8),
            "false".getBytes(StandardCharsets.UTF_8))
        .send(false);
    new ParameterStatusResponse(
            output,
            "session_authorization".getBytes(StandardCharsets.UTF_8),
            "PGAdapter".getBytes(StandardCharsets.UTF_8))
        .send(false);
    new ParameterStatusResponse(
            output,
            "integer_datetimes".getBytes(StandardCharsets.UTF_8),
            "on".getBytes(StandardCharsets.UTF_8))
        .send(false);
    new ParameterStatusResponse(
            output,
            "server_encoding".getBytes(StandardCharsets.UTF_8),
            "UTF8".getBytes(StandardCharsets.UTF_8))
        .send(false);
    new ParameterStatusResponse(
            output,
            "client_encoding".getBytes(StandardCharsets.UTF_8),
            "UTF8".getBytes(StandardCharsets.UTF_8))
        .send(false);
    new ParameterStatusResponse(
            output,
            "DateStyle".getBytes(StandardCharsets.UTF_8),
            "ISO,YMD".getBytes(StandardCharsets.UTF_8))
        .send(false);
    new ParameterStatusResponse(
            output,
            "IntervalStyle".getBytes(StandardCharsets.UTF_8),
            "iso_8601".getBytes(StandardCharsets.UTF_8))
        .send(false);
    new ParameterStatusResponse(
            output,
            "standard_conforming_strings".getBytes(StandardCharsets.UTF_8),
            "on".getBytes(StandardCharsets.UTF_8))
        .send(false);
    new ParameterStatusResponse(
            output,
            "TimeZone".getBytes(StandardCharsets.UTF_8),
            ZoneId.systemDefault().getId().getBytes(StandardCharsets.UTF_8))
        .send(false);
    for (NoticeResponse noticeResponse : startupNotices) {
      noticeResponse.send(false);
    }
    new ReadyResponse(output, Status.IDLE).send();
  }
}