java/com/google/gerrit/sshd/CommandMetaData.java

// Copyright (C) 2013 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 static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Annotation tagged on a concrete Command to describe what it is doing and whether it can be run on
 * slaves.
 */
@Target({ElementType.TYPE})
@Retention(RUNTIME)
public @interface CommandMetaData {
  enum Mode {
    MASTER,
    MASTER_OR_SLAVE;

    public boolean isSupported(boolean slaveMode) {
      return this == MASTER_OR_SLAVE || !slaveMode;
    }
  }

  String name();

  String description() default "";

  Mode runsAt() default Mode.MASTER;
}