Line data    Source code

       1             : // Copyright (C) 2013 The Android Open Source Project
       2             : //
       3             : // Licensed under the Apache License, Version 2.0 (the "License");
       4             : // you may not use this file except in compliance with the License.
       5             : // You may obtain a copy of the License at
       6             : //
       7             : // http://www.apache.org/licenses/LICENSE-2.0
       8             : //
       9             : // Unless required by applicable law or agreed to in writing, software
      10             : // distributed under the License is distributed on an "AS IS" BASIS,
      11             : // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      12             : // See the License for the specific language governing permissions and
      13             : // limitations under the License.
      14             : 
      15             : package com.google.gerrit.sshd;
      16             : 
      17             : import static java.lang.annotation.RetentionPolicy.RUNTIME;
      18             : 
      19             : import java.lang.annotation.ElementType;
      20             : import java.lang.annotation.Retention;
      21             : import java.lang.annotation.Target;
      22             : 
      23             : /**
      24             :  * Annotation tagged on a concrete Command to describe what it is doing and whether it can be run on
      25             :  * slaves.
      26             :  */
      27             : @Target({ElementType.TYPE})
      28             : @Retention(RUNTIME)
      29             : public @interface CommandMetaData {
      30          17 :   enum Mode {
      31          17 :     MASTER,
      32          17 :     MASTER_OR_SLAVE;
      33             : 
      34             :     public boolean isSupported(boolean slaveMode) {
      35          17 :       return this == MASTER_OR_SLAVE || !slaveMode;
      36             :     }
      37             :   }
      38             : 
      39             :   String name();
      40             : 
      41             :   String description() default "";
      42             : 
      43             :   Mode runsAt() default Mode.MASTER;
      44             : }