com.google.gerrit.sshd.PluginCommandModule Maven / Gradle / Ivy

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.10.0-rc4

// Copyright (C) 2012 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.sshd;

import com.google.common.base.Preconditions;
import com.google.gerrit.extensions.annotations.PluginName;
import com.google.inject.Inject;
import com.google.inject.binder.LinkedBindingBuilder;
import org.apache.sshd.server.Command;

public abstract class PluginCommandModule extends CommandModule {
  private CommandName command;

  @Inject
  void setPluginName(@PluginName String name) {
    this.command = Commands.named(name);
  }

  @Override
  protected final void configure() {
    Preconditions.checkState(command != null, "@PluginName must be provided");
    bind(Commands.key(command)).toProvider(new DispatchCommandProvider(command));
    configureCommands();
  }

  protected abstract void configureCommands();

  @Override
  protected LinkedBindingBuilder command(String subCmd) {
    return bind(Commands.key(command, subCmd));
  }

  protected void command(Class clazz) {
    command(command, clazz);
  }

  protected void alias(final String name, Class clazz) {
    alias(command, name, clazz);
  }
}