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