com.google.gerrit.server.account.VersionedAccountQueries 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.12.0
// Copyright (C) 2015 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.account;

import static java.util.stream.Collectors.joining;

import com.google.common.base.Strings;
import com.google.common.flogger.FluentLogger;
import com.google.gerrit.entities.BranchNameKey;
import com.google.gerrit.server.git.ValidationError;
import com.google.gerrit.server.git.meta.VersionedMetaData;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.jgit.errors.ConfigInvalidException;
import org.eclipse.jgit.lib.CommitBuilder;

/**
 * Named Queries for user accounts.
 *
 * Users can define aliases for change queries. These are stored as versioned account data and
 * (de)serialized with this class.
 */
public class VersionedAccountQueries extends VersionedMetaData {
  private static final FluentLogger logger = FluentLogger.forEnclosingClass();

  public static VersionedAccountQueries forBranch(BranchNameKey branch) {
    return new VersionedAccountQueries(branch.branch());
  }

  private final String ref;
  private QueryList queryList;

  private VersionedAccountQueries(String ref) {
    this.ref = ref;
  }

  @Override
  protected String getRefName() {
    return ref;
  }

  public QueryList getQueryList() {
    return queryList;
  }

  public void setQueryList(String text) throws IOException, ConfigInvalidException {
    List errors = new ArrayList<>();
    QueryList newQueryList = QueryList.parse(text, error -> errors.add(error));
    if (!errors.isEmpty()) {
      String messages = errors.stream().map(ValidationError::getMessage).collect(joining(", "));
      throw new ConfigInvalidException("Invalid named queries: " + messages);
    }
    queryList = newQueryList;
  }

  @Override
  protected void onLoad() throws IOException, ConfigInvalidException {
    logger.atFine().log("Loading named queries from ref %s", ref);
    queryList =
        QueryList.parse(
            readUTF8(QueryList.FILE_NAME),
            error ->
                logger.atSevere().log(
                    "Error parsing file %s: %s", QueryList.FILE_NAME, error.getMessage()));
  }

  @Override
  protected boolean onSave(CommitBuilder commit) throws IOException, ConfigInvalidException {
    if (Strings.isNullOrEmpty(commit.getMessage())) {
      commit.setMessage("Updated named queries\n");
    }
    saveUTF8(QueryList.FILE_NAME, queryList.asText());
    return true;
  }
}