-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
AdminCommand.java
127 lines (111 loc) · 3.99 KB
/
AdminCommand.java
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*
* Copyright (c) 2002-2017 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.commandline.admin;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.List;
import java.util.Set;
import java.util.function.Consumer;
import javax.annotation.Nonnull;
import org.neo4j.commandline.arguments.Arguments;
import org.neo4j.helpers.Service;
import org.neo4j.helpers.collection.Iterables;
/**
* To create a command for {@code neo4j-admin}:
* <ol>
* <li>implement {@code AdminCommand}</li>
* <li>create a concrete subclass of {@code AdminCommand.Provider} which instantiates the command</li>
* <li>register the {@code Provider} in {@code META-INF/services} as described
* <a href='https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html'>here</a></li>
* </ol>
*/
public interface AdminCommand
{
abstract class Provider extends Service
{
/**
* Create a new instance of a service implementation identified with the
* specified key(s).
*
* @param key the main key for identifying this service implementation
* @param altKeys alternative spellings of the identifier of this service
*/
protected Provider( String key, String... altKeys )
{
super( key, altKeys );
}
/**
* @return The command's name
*/
public String name()
{
return Iterables.last( getKeys() );
}
/**
* @return The arguments this command accepts.
*/
public abstract Arguments allArguments();
/**
*
* @return A list of possibly mutually-exclusive argument sets for this command.
*/
public List<Arguments> possibleArguments()
{
return Arrays.asList( allArguments() );
}
/**
* @return A single-line summary for the command. Should be 70 characters or less.
*/
public abstract String summary();
/**
* @return AdminCommandSection the command using the provider is grouped under
*/
@Nonnull
public abstract AdminCommandSection commandSection();
/**
* @return A description for the command's help text.
*/
public abstract String description();
public abstract AdminCommand create( Path homeDir, Path configDir, OutsideWorld outsideWorld );
public final void printSummary( Consumer<String> output )
{
output.accept( String.format( "%s", name() ) );
output.accept( " " + summary() );
}
}
interface Blocker
{
/**
* @param homeDir the home of the Neo4j installation.
* @param configDir the directory where configuration files can be found.
* @return A boolean representing whether or not this command should be blocked from running.
*/
boolean doesBlock( Path homeDir, Path configDir );
/**
* @return A list of the commands this blocker applies to.
*/
Set<String> commands();
/**
* @return An explanation of why a command was blocked. This will be shown to the user.
*/
String explanation();
}
void execute( String[] args ) throws IncorrectUsage, CommandFailed;
}