001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.microservice.console;
014
015import java.io.*;
016import java.util.*;
017
018import org.apache.juneau.microservice.*;
019import org.apache.juneau.utils.*;
020
021/**
022 * Implements the 'restart' console command to gracefully shut down and restart the microservice.
023 */
024public class HelpCommand extends ConsoleCommand {
025
026   private final MessageBundle mb = MessageBundle.create(HelpCommand.class, "Messages");
027
028   @Override /* ConsoleCommand */
029   public String getName() {
030      return "help";
031   }
032
033   @Override /* ConsoleCommand */
034   public String getSynopsis() {
035      return "help [command]";
036   }
037
038   @Override /* ConsoleCommand */
039   public String getInfo() {
040      return mb.getString("info");
041   }
042
043   @Override /* ConsoleCommand */
044   public String getDescription() {
045      return mb.getString("description");
046   }
047
048   @Override /* ConsoleCommand */
049   public String getExamples() {
050      return mb.getString("examples");
051   }
052
053   @Override /* ConsoleCommand */
054   public boolean execute(Scanner in, PrintWriter out, Args args) throws Exception {
055      Map<String,ConsoleCommand> commands = Microservice.getInstance().getConsoleCommands();
056      if (args.size() == 1) {
057         out.println(mb.getString("ListOfAvailableCommands"));
058         for (ConsoleCommand cc : commands.values())
059            out.append("\t").append(cc.getName()).append(" -- ").append(indent(cc.getInfo())).println();
060         out.println();
061      } else {
062         ConsoleCommand cc = commands.get(args.getArg(1));
063         if (cc == null) {
064            out.println(mb.getString("CommandNotFound"));
065         } else {
066            String
067               info = cc.getInfo(),
068               synopsis = cc.getSynopsis(),
069               description = cc.getDescription(),
070               examples = cc.getExamples();
071
072            out.append(mb.getString("NAME")).append("\n\t").append(cc.getName()).append(info == null ? "" : " -- " + indent(info)).println();
073
074            if (synopsis != null)
075               out.append('\n').append(mb.getString("SYNOPSIS")).append("\n\t").append(indent(synopsis)).println();
076
077            if (description != null)
078               out.append('\n').append(mb.getString("DESCRIPTION")).append("\n\t").append(indent(description)).println();
079
080            if (examples != null)
081               out.append('\n').append(mb.getString("EXAMPLES")).append("\n\t").append(indent(examples)).println();
082         }
083      }
084      return false;
085   }
086
087   private String indent(String in) {
088      if (in == null)
089         return "";
090      return in.replaceAll("\n", "\n\t");
091   }
092}