SubscriptionResponse.java

/*
 * Copyright ConsenSys AG.
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package org.hyperledger.besu.ethereum.api.jsonrpc.websocket.subscription.response;

import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.JsonRpcResult;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.Quantity;
import org.hyperledger.besu.ethereum.api.jsonrpc.websocket.subscription.Subscription;
import org.hyperledger.besu.ethereum.api.jsonrpc.websocket.subscription.logs.PrivateLogsSubscription;

import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

@JsonPropertyOrder({"jsonrpc", "method", "params"})
public class SubscriptionResponse {

  private static final String JSON_RPC_VERSION = "2.0";
  private static final String ETH_SUBSCRIPTION_METHOD = "eth_subscription";
  private static final String PRIV_SUBSCRIPTION_METHOD = "priv_subscription";

  private final String methodName;
  private final SubscriptionResponseResult params;

  public SubscriptionResponse(final Subscription subscription, final JsonRpcResult result) {
    if (subscription instanceof PrivateLogsSubscription) {
      final String privacyGroupId = ((PrivateLogsSubscription) subscription).getPrivacyGroupId();
      this.methodName = PRIV_SUBSCRIPTION_METHOD;
      this.params =
          new SubscriptionResponseResult(
              Quantity.create(subscription.getSubscriptionId()), result, privacyGroupId);
    } else {
      this.methodName = ETH_SUBSCRIPTION_METHOD;
      this.params =
          new SubscriptionResponseResult(Quantity.create(subscription.getSubscriptionId()), result);
    }
  }

  @JsonGetter("jsonrpc")
  public String getJsonrpc() {
    return JSON_RPC_VERSION;
  }

  @JsonGetter("method")
  public String getMethod() {
    return methodName;
  }

  @JsonGetter("params")
  public SubscriptionResponseResult getParams() {
    return params;
  }
}