1 /****************************************************************
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 ****************************************************************/
19
20 package org.apache.james.remotemanager;
21
22 import java.io.PrintWriter;
23
24 /**
25 * Commands JAMES through the remote management console.
26 */
27 public interface Command {
28
29 /**
30 * Gets the name of this command.
31 * @return command name, not null
32 */
33 public String getName();
34
35 /**
36 * Outputs useful information for the user of this command.
37 * @return user help, not null
38 */
39 public String help();
40
41 /**
42 * Executes this command.
43 * @param args raw arguments, not null
44 * @param out <code>PrintWriter</code> for user feedback
45 * @return true additional commands are expected, false otherwise. Note
46 */
47 public boolean execute(String args, final PrintWriter out);
48 }