com.google.gerrit.server.notedb.ChangeRevisionNote Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation
API for Gerrit Plugins
There is a newer version: 3.11.0-rc3
// Copyright (C) 2016 The Android Open Source Project
//
// 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.gerrit.server.notedb;

import static java.nio.charset.StandardCharsets.UTF_8;

import com.google.common.collect.ImmutableList;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.entities.Comment;
import com.google.gerrit.entities.HumanComment;
import com.google.gerrit.entities.SubmitRequirementResult;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.util.List;
import org.eclipse.jgit.errors.ConfigInvalidException;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.ObjectReader;
import org.eclipse.jgit.util.MutableInteger;

/** Implements the parsing of comment data, handling JSON decoding and push certificates. */
class ChangeRevisionNote extends RevisionNote {
  private final ChangeNoteJson noteJson;
  private final Comment.Status status;
  private String pushCert;

  /**
   * Submit requirement results stored in this revision note. If null, then no SRs were stored in
   * the revision note . Otherwise, there were stored SRs in this revision note. The list could be
   * empty, meaning that no SRs were configured for the project.
   */
  @Nullable private ImmutableList submitRequirementsResult;

  ChangeRevisionNote(
      ChangeNoteJson noteJson, ObjectReader reader, ObjectId noteId, Comment.Status status) {
    super(reader, noteId);
    this.noteJson = noteJson;
    this.status = status;
  }

  /**
   * Returns null if no submit requirements were stored in the revision note. Otherwise, this method
   * returns a list of submit requirements, which can probably be empty if there were no SRs
   * configured for the project at the time when the SRs were stored.
   */
  @Nullable
  public ImmutableList getSubmitRequirementsResult() {
    checkParsed();
    return submitRequirementsResult;
  }

  public String getPushCert() {
    checkParsed();
    return pushCert;
  }

  @Override
  protected List parse(byte[] raw, int offset)
      throws IOException, ConfigInvalidException {
    MutableInteger p = new MutableInteger();
    p.value = offset;

    ChangeRevisionNoteData data = parseJson(noteJson, raw, p.value);
    if (status == HumanComment.Status.PUBLISHED) {
      pushCert = data.pushCert;
    } else {
      pushCert = null;
    }
    this.submitRequirementsResult =
        data.submitRequirementResults == null
            ? null
            : ImmutableList.copyOf(data.submitRequirementResults);
    return data.comments;
  }

  private ChangeRevisionNoteData parseJson(ChangeNoteJson noteUtil, byte[] raw, int offset)
      throws IOException {
    try (InputStream is = new ByteArrayInputStream(raw, offset, raw.length - offset);
        Reader r = new InputStreamReader(is, UTF_8)) {
      return noteUtil.getGson().fromJson(r, ChangeRevisionNoteData.class);
    }
  }
}