/*@jsxRuntime automatic @jsxImportSource react*/
const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];
function _createMdxContent(props) {
  const _components = Object.assign({
    p: "p",
    em: "em",
    h2: "h2",
    a: "a",
    pre: "pre",
    code: "code",
    span: "span"
  }, props.components), {Link} = _components;
  if (!Link) _missingMdxReference("Link", true);
  return _jsxs(_Fragment, {
    children: [_jsxs(_components.p, {
      children: ["Vert.x Shell pro­vides an ex­ten­si­ble com­mand line for Vert.x, ac­ces­si­ble via SSH, Tel­net or a nice Web in­ter­face. Vert.x Shell comes out of the box with plenty of com­mands for Vert.x which makes it very handy for doing sim­ple man­age­ment op­er­a­tions like de­ploy­ing a Ver­ti­cle or get­ting the list of de­ployed Ver­ti­cles. One power fea­ture of Vert.x Shell is its ex­ten­si­bil­ity: one can eas­ily aug­ment Vert.x Shell with its own com­mands. Let’s build an ", _jsx(_components.em, {
        children: "http-​client"
      }), " in JavaScript!"]
    }), "\n", _jsxs(_components.h2, {
      id: "booting-the-shell",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#booting-the-shell"
      }), "Booting the Shell"]
    }), "\n", _jsxs(_components.p, {
      children: ["Vert.x Shell can be started in a cou­ple of lines de­pend­ing on the con­nec­tors you con­fig­ure. The doc­u­men­ta­tion pro­vides sev­eral ex­am­ples show­ing the ", _jsx(Link, {
        href: "/docs/vertx-shell/js/#_programmatic_service",
        passHref: true,
        children: _jsx(_components.a, {
          href: "",
          children: "Shell Ser­vice con­fig­u­ra­tion"
        })
      }), ". For test­ing our com­mand, we will use the Tel­net pro­to­col be­cause it is easy to con­fig­ure and use, so we just need to copy the cor­re­spond­ing sec­tion in ", _jsx(_components.em, {
        children: "vertx-​http-client.js"
      }), ":"]
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-javascript",
        children: [_jsx(_components.span, {
          className: "hljs-keyword",
          children: "var"
        }), " ", _jsx(_components.span, {
          className: "hljs-title class_",
          children: "ShellService"
        }), " = ", _jsx(_components.span, {
          className: "hljs-built_in",
          children: "require"
        }), "(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"vertx-shell-js/shell_service\""
        }), ");\n", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "var"
        }), " service = ", _jsx(_components.span, {
          className: "hljs-title class_",
          children: "ShellService"
        }), ".", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "create"
        }), "(vertx, {\n  ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"telnetOptions\""
        }), " : {\n    ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"host\""
        }), " : ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"localhost\""
        }), ",\n    ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"port\""
        }), " : ", _jsx(_components.span, {
          className: "hljs-number",
          children: "4000"
        }), "\n  }\n});\nservice.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "start"
        }), "();\n"]
      })
    }), "\n", _jsx(_components.p, {
      children: "We can run it:"
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "hljs language-text",
        children: "Juliens-MacBook-Pro:java julien$ vertx run vertx-http-client.js\nSucceeded in deploying verticle\n"
      })
    }), "\n", _jsx(_components.p, {
      children: "And con­nect to the shell:"
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "hljs language-text",
        children: "Juliens-MacBook-Pro:~ julien$ telnet localhost 4000\nTrying ::1...\ntelnet: connect to address ::1: Connection refused\nTrying 127.0.0.1...\nConnected to localhost.\nEscape character is '^]'.\n__      __ ______  _____  _______  __   __\n\\ \\    / /|  ____||  _  \\|__   __| \\ \\ / /\n \\ \\  / / | |____ | :_) |   | |     \\   /\n  \\ \\/ /  |  ____||   __/   | |      > /\n   \\  /   | |____ | |\\ \\    | |     / //\\\n    \\/    |______||_| \\_\\   |_| o  /_/ \\_\\\n\n\n%\n"
      })
    }), "\n", _jsxs(_components.p, {
      children: ["You can now al­ready use the shell, the ", _jsx(_components.em, {
        children: "help"
      }), " com­mand lists the avail­able com­mands."]
    }), "\n", _jsxs(_components.h2, {
      id: "creating-a-command",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#creating-a-command"
      }), "Creating a command"]
    }), "\n", _jsx(_components.p, {
      children: "For the sake of sim­plic­ity we will write a sin­gle script that starts the Shell ser­vice and de­ploys our com­mand. In the real world you would prob­a­bly have the com­mand in one file and the de­ploy­ment in an­other."
    }), "\n", _jsxs(_components.p, {
      children: ["The ", _jsx(Link, {
        href: "/docs/vertx-shell/js/#_extending_vert_x_shell",
        passHref: true,
        children: _jsx(_components.a, {
          href: "",
          children: "doc­u­men­ta­tion"
        })
      }), " ex­plains how to add a new com­mand to Vert.x shell, we can just copy this sec­tion and ap­pend it to the ", _jsx(_components.em, {
        children: "vertx-​http-client.js"
      }), " script:"]
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-javascript",
        children: [_jsx(_components.span, {
          className: "hljs-keyword",
          children: "var"
        }), " ", _jsx(_components.span, {
          className: "hljs-title class_",
          children: "CommandBuilder"
        }), " = ", _jsx(_components.span, {
          className: "hljs-built_in",
          children: "require"
        }), "(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"vertx-shell-js/command_builder\""
        }), ");\n", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "var"
        }), " ", _jsx(_components.span, {
          className: "hljs-title class_",
          children: "CommandRegistry"
        }), " = ", _jsx(_components.span, {
          className: "hljs-built_in",
          children: "require"
        }), "(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"vertx-shell-js/command_registry\""
        }), ");\n\n", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "var"
        }), " builder = ", _jsx(_components.span, {
          className: "hljs-title class_",
          children: "CommandBuilder"
        }), ".", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "command"
        }), "(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"http-client\""
        }), ");\nbuilder.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "processHandler"
        }), "(", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "function"
        }), " (", _jsx(_components.span, {
          className: "hljs-params",
          children: "process"
        }), ") {\n\n  ", _jsx(_components.span, {
          className: "hljs-comment",
          children: "// Write a message to the console"
        }), "\n  process.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "write"
        }), "(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"Implement the client\\n\""
        }), ");\n\n  ", _jsx(_components.span, {
          className: "hljs-comment",
          children: "// End the process"
        }), "\n  process.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "end"
        }), "();\n});\n\n", _jsx(_components.span, {
          className: "hljs-comment",
          children: "// Register the command"
        }), "\n", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "var"
        }), " registry = ", _jsx(_components.span, {
          className: "hljs-title class_",
          children: "CommandRegistry"
        }), ".", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "getShared"
        }), "(vertx);\nregistry.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "registerCommand"
        }), "(builder.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "build"
        }), "(vertx));\n"]
      })
    }), "\n", _jsx(_components.p, {
      children: "Now you can use the com­mand just to see it in ac­tion:"
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "hljs language-bash",
        children: "% http-client\nImplement the client\n%\n"
      })
    }), "\n", _jsxs(_components.h2, {
      id: "checking-arguments",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#checking-arguments"
      }), "Checking arguments"]
    }), "\n", _jsxs(_components.p, {
      children: ["The ", _jsx(_components.em, {
        children: "http-​client"
      }), " re­quires an ", _jsx(_components.code, {
        children: "url"
      }), " ar­gu­ment, an ar­gu­ment check is per­formed at the be­gin­ning of the process han­dler:"]
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-javascript",
        children: [_jsx(_components.span, {
          className: "hljs-comment",
          children: "// Check the url argument"
        }), "\n", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "if"
        }), " (process.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "args"
        }), "().", _jsx(_components.span, {
          className: "hljs-property",
          children: "length"
        }), " < ", _jsx(_components.span, {
          className: "hljs-number",
          children: "1"
        }), ") {\n  process.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "write"
        }), "(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"Missing URL\\n\""
        }), ").", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "end"
        }), "();\n  ", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "return"
        }), ";\n}\n", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "var"
        }), " url = process.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "args"
        }), "()[", _jsx(_components.span, {
          className: "hljs-number",
          children: "0"
        }), "];\n"]
      })
    }), "\n", _jsxs(_components.h2, {
      id: "implementing-the-command",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#implementing-the-command"
      }), "Implementing the command"]
    }), "\n", _jsx(_components.p, {
      children: "The final step of this tu­to­r­ial is the ac­tual im­ple­men­ta­tion of the client logic based on Vert.x Http­Client:"
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-javascript",
        children: [_jsx(_components.span, {
          className: "hljs-comment",
          children: "// Create the client request"
        }), "\n", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "var"
        }), " request = client.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "getAbs"
        }), "(url, ", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "function"
        }), "(", _jsx(_components.span, {
          className: "hljs-params",
          children: "response"
        }), ") {\n\n  ", _jsx(_components.span, {
          className: "hljs-comment",
          children: "// Print the response in the shell console"
        }), "\n  response.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "handler"
        }), "(", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "function"
        }), "(", _jsx(_components.span, {
          className: "hljs-params",
          children: "buffer"
        }), ") {\n    process.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "write"
        }), "(buffer.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "toString"
        }), "(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"UTF-8\""
        }), "));\n  });\n\n  ", _jsx(_components.span, {
          className: "hljs-comment",
          children: "// End the command when the response ends"
        }), "\n  response.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "endHandler"
        }), "(", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "function"
        }), "(", _jsx(_components.span, {
          className: "hljs-params"
        }), ") {\n    process.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "end"
        }), "();\n  });\n});\n\n", _jsx(_components.span, {
          className: "hljs-comment",
          children: "// Set a request handler to end the command with error"
        }), "\nrequest.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "exceptionHandler"
        }), "(", _jsx(_components.span, {
          className: "hljs-keyword",
          children: "function"
        }), "(", _jsx(_components.span, {
          className: "hljs-params",
          children: "err"
        }), ") {\n  process.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "write"
        }), "(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"Error: \""
        }), " + err.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "getMessage"
        }), "());\n  process.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "end"
        }), "();\n});\n\n", _jsx(_components.span, {
          className: "hljs-comment",
          children: "// End the http request"
        }), "\nrequest.", _jsx(_components.span, {
          className: "hljs-title function_",
          children: "end"
        }), "();\n"]
      })
    }), "\n", _jsx(_components.p, {
      children: "And we can test the com­mand in the shell:"
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-bash",
        children: ["% http-client http://vertx.io\nhttp-client http://vertx.io\n<!DOCTYPE html><html lang=en><", _jsx(_components.span, {
          className: "hljs-built_in",
          children: "head"
        }), "><title>Vert.x</title>...\n...\n/javascripts/sticky_header.js></script></body></html>%\n"]
      })
    }), "\n", _jsxs(_components.h2, {
      id: "finally",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#finally"
      }), "Finally"]
    }), "\n", _jsxs(_components.p, {
      children: ["We have seen how easy it is to ex­tend Vert.x with a shell and cre­ate an ", _jsx(_components.em, {
        children: "http-​client"
      }), " cus­tom com­mand, you can get the full source code ", _jsx(_components.a, {
        href: "https://gist.github.com/vietj/51ff223bfb7cfcbc97ce",
        children: "here"
      }), "."]
    }), "\n", _jsx(_components.p, {
      children: "Our com­mand is very sim­ple, it only im­ple­ments the very min­i­mum, in fu­ture posts we will im­prove the com­mand with sup­port with more HTTP meth­ods, SSL sup­port or header sup­port with the the Vert.x CLI API."
    })]
  });
}
function MDXContent(props = {}) {
  const {wrapper: MDXLayout} = props.components || ({});
  return MDXLayout ? _jsx(MDXLayout, Object.assign({}, props, {
    children: _jsx(_createMdxContent, props)
  })) : _createMdxContent(props);
}
return {
  default: MDXContent
};
function _missingMdxReference(id, component) {
  throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it.");
}


Blog

Intro to Vert.x Shell

Next post

Vert.x 3.2.1 is released!

Previous post

Using Hamcrest Matchers with Vert.x Unit

Blog

Intro to Vert.x Shell

Next post

Vert.x 3.2.1 is released!

Previous post

Using Hamcrest Matchers with Vert.x Unit

Related posts

Unit and Integration Tests

Building services and APIs with AMQP 1.0

Combine vert.x and mongo to build a giant