com.google.gerrit.server.plugins.UniversalServerPluginProvider 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) 2014 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.plugins;

import com.google.common.flogger.FluentLogger;
import com.google.gerrit.extensions.registration.PluginName;
import com.google.gerrit.server.plugincontext.PluginSetContext;
import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.jgit.internal.storage.file.FileSnapshot;

@Singleton
class UniversalServerPluginProvider implements ServerPluginProvider {
  private static final FluentLogger logger = FluentLogger.forEnclosingClass();

  private final PluginSetContext serverPluginProviders;

  @Inject
  UniversalServerPluginProvider(PluginSetContext sf) {
    this.serverPluginProviders = sf;
  }

  @Override
  public ServerPlugin get(Path srcPath, FileSnapshot snapshot, PluginDescription pluginDescription)
      throws InvalidPluginException {
    return providerOf(srcPath).get(srcPath, snapshot, pluginDescription);
  }

  @Override
  public String getPluginName(Path srcPath) {
    return providerOf(srcPath).getPluginName(srcPath);
  }

  @Override
  public boolean handles(Path srcPath) {
    List providers = providersForHandlingPlugin(srcPath);
    switch (providers.size()) {
      case 1:
        return true;
      case 0:
        return false;
      default:
        throw new MultipleProvidersForPluginException(srcPath, providers);
    }
  }

  @Override
  public String getProviderPluginName() {
    return PluginName.GERRIT;
  }

  private ServerPluginProvider providerOf(Path srcPath) {
    List providers = providersForHandlingPlugin(srcPath);
    switch (providers.size()) {
      case 1:
        return providers.get(0);
      case 0:
        throw new IllegalArgumentException(
            "No ServerPluginProvider found/loaded to handle plugin file "
                + srcPath.toAbsolutePath());
      default:
        throw new MultipleProvidersForPluginException(srcPath, providers);
    }
  }

  private List providersForHandlingPlugin(Path srcPath) {
    List providers = new ArrayList<>();
    serverPluginProviders.runEach(
        serverPluginProvider -> {
          boolean handles = serverPluginProvider.handles(srcPath);
          logger.atFine().log(
              "File %s handled by %s ? => %s",
              srcPath, serverPluginProvider.getProviderPluginName(), handles);
          if (handles) {
            providers.add(serverPluginProvider);
          }
        });
    return providers;
  }
}