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.collections.*;
019import org.apache.juneau.cp.*;
020import org.apache.juneau.microservice.*;
021
022/**
023 * Implements the 'restart' console command to gracefully shut down and restart the microservice.
024 *
025 * <h5 class='section'>See Also:</h5><ul>
026 *    <li class='link'><a class="doclink" href="../../../../../index.html#juneau-microservice-core">juneau-microservice-core</a>
027 * </ul>
028 */
029public class HelpCommand extends ConsoleCommand {
030
031   private final Messages mb = Messages.of(HelpCommand.class, "Messages");
032
033   @Override /* ConsoleCommand */
034   public String getName() {
035      return "help";
036   }
037
038   @Override /* ConsoleCommand */
039   public String getSynopsis() {
040      return "help [command]";
041   }
042
043   @Override /* ConsoleCommand */
044   public String getInfo() {
045      return mb.getString("info");
046   }
047
048   @Override /* ConsoleCommand */
049   public String getDescription() {
050      return mb.getString("description");
051   }
052
053   @Override /* ConsoleCommand */
054   public String getExamples() {
055      return mb.getString("examples");
056   }
057
058   @Override /* ConsoleCommand */
059   public boolean execute(Scanner in, PrintWriter out, Args args) throws Exception {
060      Map<String,ConsoleCommand> commands = Microservice.getInstance().getConsoleCommands();
061      if (args.size() == 1) {
062         out.println(mb.getString("ListOfAvailableCommands"));
063         commands.forEach((k,v) -> out.append("\t").append(v.getName()).append(" -- ").append(indent(v.getInfo())).println());
064         out.println();
065      } else {
066         ConsoleCommand cc = commands.get(args.getArg(1));
067         if (cc == null) {
068            out.println(mb.getString("CommandNotFound"));
069         } else {
070            String
071               info = cc.getInfo(),
072               synopsis = cc.getSynopsis(),
073               description = cc.getDescription(),
074               examples = cc.getExamples();
075
076            out.append(mb.getString("NAME")).append("\n\t").append(cc.getName()).append(info == null ? "" : " -- " + indent(info)).println();
077
078            if (synopsis != null)
079               out.append('\n').append(mb.getString("SYNOPSIS")).append("\n\t").append(indent(synopsis)).println();
080
081            if (description != null)
082               out.append('\n').append(mb.getString("DESCRIPTION")).append("\n\t").append(indent(description)).println();
083
084            if (examples != null)
085               out.append('\n').append(mb.getString("EXAMPLES")).append("\n\t").append(indent(examples)).println();
086         }
087      }
088      return false;
089   }
090
091   private String indent(String in) {
092      if (in == null)
093         return "";
094      return in.replaceAll("\n", "\n\t");
095   }
096}