blob: 7699bdd0ad0295f5adc1e9575beaba605b5238af (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
// Copyright (C) 2009 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.inject.AbstractModule;
import com.google.inject.binder.LinkedBindingBuilder;
import org.apache.sshd.server.Command;
/** Module to register commands in the SSH daemon. */
public abstract class CommandModule extends AbstractModule {
/**
* Configure a command to be invoked by name.
*
* @param name the name of the command the client will provide in order to
* call the command.
* @return a binding that must be bound to a non-singleton provider for a
* {@link Command} object.
*/
protected LinkedBindingBuilder<Command> command(final String name) {
return bind(Commands.key(name));
}
/**
* Configure a command to be invoked by name.
*
* @param name the name of the command the client will provide in order to
* call the command.
* @return a binding that must be bound to a non-singleton provider for a
* {@link Command} object.
*/
protected LinkedBindingBuilder<Command> command(final CommandName name) {
return bind(Commands.key(name));
}
/**
* Configure a command to be invoked by name.
*
*@param parent context of the parent command, that this command is a
* subcommand of.
* @param name the name of the command the client will provide in order to
* call the command.
* @return a binding that must be bound to a non-singleton provider for a
* {@link Command} object.
*/
protected LinkedBindingBuilder<Command> command(final CommandName parent,
final String name) {
return bind(Commands.key(parent, name));
}
/**
* Alias one command to another.
*
* @param from the new command name that when called will actually delegate to
* {@code to}'s implementation.
* @param to name of an already registered command that will perform the
* action when {@code from} is invoked by a client.
*/
protected void alias(final String from, final String to) {
bind(Commands.key(from)).to(Commands.key(to));
}
}
|
