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