com.google.gerrit.server.extensions.events.CustomKeyedValuesEdited 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
The newest version!
// Copyright (C) 2023 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.extensions.events;

import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.flogger.FluentLogger;
import com.google.gerrit.exceptions.StorageException;
import com.google.gerrit.extensions.api.changes.NotifyHandling;
import com.google.gerrit.extensions.common.AccountInfo;
import com.google.gerrit.extensions.common.ChangeInfo;
import com.google.gerrit.extensions.events.CustomKeyedValuesEditedListener;
import com.google.gerrit.server.account.AccountState;
import com.google.gerrit.server.plugincontext.PluginSetContext;
import com.google.gerrit.server.query.change.ChangeData;
import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.time.Instant;

/** Helper class to fire an event when the hashtags of a change has been edited. */
@Singleton
public class CustomKeyedValuesEdited {
  private static final FluentLogger logger = FluentLogger.forEnclosingClass();

  private final PluginSetContext listeners;
  private final EventUtil util;

  @Inject
  public CustomKeyedValuesEdited(
      PluginSetContext listeners, EventUtil util) {
    this.listeners = listeners;
    this.util = util;
  }

  public void fire(
      ChangeData changeData,
      AccountState editor,
      ImmutableMap customKeyedValues,
      ImmutableMap added,
      ImmutableSet removed,
      Instant when) {
    if (listeners.isEmpty()) {
      return;
    }
    try {
      Event event =
          new Event(
              util.changeInfo(changeData),
              util.accountInfo(editor),
              customKeyedValues,
              added,
              removed,
              when);
      listeners.runEach(l -> l.onCustomKeyedValuesEdited(event));
    } catch (StorageException e) {
      logger.atSevere().withCause(e).log("Couldn't fire event");
    }
  }

  /** Event to be fired when the custom keyed values of a change has been edited. */
  private static class Event extends AbstractChangeEvent
      implements CustomKeyedValuesEditedListener.Event {

    private ImmutableMap updated;
    private ImmutableMap added;
    private ImmutableSet removed;

    Event(
        ChangeInfo change,
        AccountInfo editor,
        ImmutableMap updated,
        ImmutableMap added,
        ImmutableSet removed,
        Instant when) {
      super(change, editor, when, NotifyHandling.ALL);
      this.updated = updated;
      this.added = added;
      this.removed = removed;
    }

    @Override
    public ImmutableMap getCustomKeyedValues() {
      return updated;
    }

    @Override
    public ImmutableMap getAddedCustomKeyedValues() {
      return added;
    }

    @Override
    public ImmutableSet getRemovedCustomKeys() {
      return removed;
    }
  }
}