/*@jsxRuntime automatic @jsxImportSource react*/
const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];
function _createMdxContent(props) {
  const _components = Object.assign({
    p: "p",
    a: "a",
    code: "code",
    ul: "ul",
    li: "li",
    em: "em",
    h2: "h2",
    pre: "pre",
    span: "span",
    h3: "h3"
  }, props.components), {Alert, Gist} = _components;
  if (!Alert) _missingMdxReference("Alert", true);
  if (!Gist) _missingMdxReference("Gist", true);
  return _jsxs(_Fragment, {
    children: [_jsxs(_components.p, {
      children: ["The all new ", _jsx(_components.a, {
        href: "http://vmp.fabric8.io",
        children: "fab­ric8 Vert.x Maven Plu­gin"
      }), " al­lows you to setup, pack­age, run, start, stop and re­de­ploy eas­ily with a very lit­tle con­fig­u­ra­tion re­sult­ing in a less ver­bose ", _jsx(_components.code, {
        children: "pom.xml"
      }), "."]
    }), "\n", _jsx(Alert, {
      info: true,
      children: _jsxs(_components.p, {
        children: ["The plug­in is de­vel­oped under the ", _jsx(_components.a, {
          href: "https://fabric8.io/",
          children: "fab­ric8"
        }), " um­brella."]
      })
    }), "\n", _jsxs(_components.p, {
      children: ["Tra­di­tion­ally Vert.x ap­pli­ca­tions using ", _jsx(_components.a, {
        href: "http://maven.apache.org",
        children: "Apache Maven"
      }), " need to have one or more of the fol­low­ing plu­g­ins:"]
    }), "\n", _jsxs(_components.ul, {
      children: ["\n", _jsxs(_components.li, {
        children: [_jsx(_components.a, {
          href: "https://maven.apache.org/plugins/maven-shade-plugin/",
          children: "Maven Shade Plu­gin"
        }), " - aids in pack­ag­ing a uber jar of Vert.x ap­pli­ca­tion with ad­di­tional con­fig­u­ra­tions to per­form SPI com­bin­ing, MAN­I­FEST.MF en­tries etc.,"]
      }), "\n", _jsxs(_components.li, {
        children: [_jsx(_components.a, {
          href: "http://www.mojohaus.org/exec-maven-plugin/",
          children: "Maven Exec Plu­gin"
        }), " - aids in start­ing the Vert.x ap­pli­ca­tion"]
      }), "\n", _jsxs(_components.li, {
        children: [_jsx(_components.a, {
          href: "https://maven.apache.org/plugins/maven-ant-plugin/",
          children: "Maven Ant Plu­gin"
        }), " - aids in stop­ping the run­ning Vert.x ap­pli­ca­tion"]
      }), "\n"]
    }), "\n", _jsxs(_components.p, {
      children: ["Though these are great plu­g­ins and do what is re­quired, but at the end of the day the de­vel­oper is left with a ver­bose ", _jsx(_components.code, {
        children: "pom.xml"
      }), " which might be­come harder to main­tain as the ap­pli­ca­tion or its con­fig­u­ra­tion grows. Even if we de­cide to go this way and use those plu­g­ins, there are some things which can’t done or done eas­ily:"]
    }), "\n", _jsxs(_components.ul, {
      children: ["\n", _jsxs(_components.li, {
        children: [_jsx(_components.code, {
          children: "run"
        }), " an ap­pli­ca­tion on fore­ground - which is a typ­i­cal way dur­ing de­vel­op­ment where the ap­pli­ca­tion starts in fore­ground of ", _jsx(_components.a, {
          href: "http://maven.apache.org",
          children: "Apache Maven"
        }), " build and killed au­to­mat­i­cally once we hit ", _jsx(_components.code, {
          children: "Ctrl + c"
        }), "(or ", _jsx(_components.code, {
          children: "CMD + c"
        }), " on Mac)"]
      }), "\n", _jsxs(_components.li, {
        children: [_jsx(_components.code, {
          children: "redeploy"
        }), " is one of the coolest fea­ture of Vert.x al­low­ing us to per­form hot de­ploy­ments. Still we can man­age to do this with IDE sup­port but not na­tively using ", _jsx(_components.a, {
          href: "http://maven.apache.org",
          children: "Apache Maven"
        }), " - typ­i­cal cases where we dis­able ", _jsx(_components.em, {
          children: "Au­to­matic Builds"
        }), " via IDE"]
      }), "\n", _jsxs(_components.li, {
        children: [_jsx(_components.code, {
          children: "setup"
        }), " Vert.x ap­pli­ca­tions with sen­si­ble de­faults and re­quired Vert.x de­pen­den­cies e.g. vertx-​core"]
      }), "\n"]
    }), "\n", _jsxs(_components.p, {
      children: ["In this first blog of fab­ric8 Vert.x Maven Plu­gin se­ries we will help you to get started with this new ", _jsx(_components.a, {
        href: "http://vmp.fabric8.io",
        children: "fab­ric8 Vert.x Maven Plu­gin"
      }), ", high­light­ing how this plug­in helps al­le­vi­at­ing the afore­men­tioned pain points with a less ver­bose ", _jsx(_components.code, {
        children: "pom.xml"
      }), "."]
    }), "\n", _jsxs(_components.p, {
      children: ["The ", _jsx(_components.a, {
        href: "http://maven.apache.org",
        children: "Apache Maven"
      }), " plug­in source code is avail­able at ", _jsx(_components.a, {
        href: "https://github.com/fabric8io/vertx-maven-plugin",
        children: "github"
      }), " with ", _jsx(_components.a, {
        href: "http://maven.apache.org",
        children: "Apache Maven"
      }), " plug­in doc­u­men­ta­tion avail­able at ", _jsx(_components.a, {
        href: "http://vmp.fabric8.io",
        children: "fab­ric8 Vert.x Maven Plu­gin"
      })]
    }), "\n", _jsxs(_components.p, {
      children: ["The source code of the ex­am­ples used in this blog are avail­able at ", _jsx(_components.a, {
        href: "https://github.com/kameshsampath/vmp-blog",
        children: "github"
      })]
    }), "\n", _jsxs(_components.h2, {
      id: "lets-set-it-up",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#lets-set-it-up"
      }), "Let’s set it up"]
    }), "\n", _jsxs(_components.p, {
      children: ["Its very easy to setup and get started. Let’s say you have a project called ", _jsx(_components.em, {
        children: "vmp-​blog"
      }), " with the fol­low­ing con­tent as part of your ", _jsx(_components.code, {
        children: "pom.xml"
      })]
    }), "\n", _jsx(Gist, {
      url: "https://gist.github.com/kameshsampath/0e0cfc90ea3cb9d69553ee9901dfd796"
    }), "\n", _jsx(_components.p, {
      children: "from the project di­rec­tory just run the fol­low­ing com­mand:"
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "hljs language-bash",
        children: "mvn io.fabric8:vertx-maven-plugin:1.0.0:setup\n"
      })
    }), "\n", _jsxs(_components.p, {
      children: ["On suc­cess­ful ex­e­cu­tion of the above com­mand the project’s ", _jsx(_components.code, {
        children: "pom.xml"
      }), " will be up­dated:"]
    }), "\n", _jsx(Gist, {
      url: "https://gist.github.com/kameshsampath/3c2e96d98f1e16d0f7a0501c05ce0d12"
    }), "\n", _jsx(_components.p, {
      children: "The com­mand did the fol­low­ing for you on the project:"
    }), "\n", _jsxs(_components.ul, {
      children: ["\n", _jsxs(_components.li, {
        children: ["added cou­ple of prop­er­ties", "\n", _jsxs(_components.ul, {
          children: ["\n", _jsxs(_components.li, {
            children: [_jsx(_components.code, {
              children: "fabric8.vertx.plugin.version"
            }), " - the lat­est fab­ric8 vert.x maven plug­in ver­sion"]
          }), "\n", _jsxs(_components.li, {
            children: [_jsx(_components.code, {
              children: "vertx.version"
            }), " - the lat­est Vert.x frame­work ver­sion"]
          }), "\n"]
        }), "\n"]
      }), "\n", _jsxs(_components.li, {
        children: ["added the Vert.x de­pen­dency BOM and vertx-​core de­pen­dency cor­re­spond­ing to ", _jsx(_components.code, {
          children: "vertx.version"
        })]
      }), "\n", _jsxs(_components.li, {
        children: ["added ", _jsx(_components.code, {
          children: "vertx-maven-plugin"
        }), " with a sin­gle ex­e­cu­tion for goals ", _jsx(_components.a, {
          href: "https://vmp.fabric8.io/#vertx:initalize",
          children: "ini­tial­ize"
        }), " and ", _jsx(_components.a, {
          href: "https://vmp.fabric8.io/#vertx:package",
          children: "pack­age"
        })]
      }), "\n"]
    }), "\n", _jsxs(_components.p, {
      children: ["The source code cre­ated by this step is avail­able ", _jsx(_components.a, {
        href: "https://github.com/kameshsampath/vmp-blog/tree/setup",
        children: "here"
      })]
    }), "\n", _jsxs(_components.p, {
      children: ["Et voilà, you are now all set to go with your Vert.x ap­pli­ca­tion build­ing with ", _jsx(_components.a, {
        href: "http://maven.apache.org",
        children: "Apache Maven"
      }), "!!"]
    }), "\n", _jsxs(_components.h2, {
      id: "lets-package-it",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#lets-package-it"
      }), "Let’s package it"]
    }), "\n", _jsxs(_components.p, {
      children: ["Now that we have set up our project to use ", _jsx(_components.code, {
        children: "vertx-maven-plugin"
      }), ", lets add a sim­ple ver­ti­cle and pack­age the Vert.x ap­pli­ca­tion as typ­i­cal ", _jsx(_components.em, {
        children: "uber"
      }), " jar (in the Vert.x world we call them ", _jsx(_components.em, {
        children: "fat"
      }), " jars).  The source code of this sec­tion is avail­able ", _jsx(_components.a, {
        href: "https://github.com/kameshsampath/vmp-blog/tree/package",
        children: "here"
      }), "."]
    }), "\n", _jsxs(_components.p, {
      children: ["To make ", _jsx(_components.code, {
        children: "package"
      }), " work cor­rectly we need to add prop­erty called ", _jsx(_components.code, {
        children: "vertx.verticle"
      }), ", which will be used by the vertx-​maven-plugin to set the ", _jsx(_components.code, {
        children: "Main-Verticle:"
      }), " at­tribute of the ", _jsx(_components.code, {
        children: "MANIFEST.MF"
      }), ".  Please refer to the doc­u­men­ta­tion of  ", _jsx(_components.a, {
        href: "https://vmp.fabric8.io/#vertx:package",
        children: "pack­age"
      }), " for other pos­si­ble con­fig­u­ra­tions.  There is also a ", _jsx(_components.a, {
        href: "https://vmp.fabric8.io/#vertx:examples",
        children: "ex­am­ples"
      }), " sec­tion of the vertx-​maven-plugin which pro­vides var­i­ous sam­ples snip­pets."]
    }), "\n", _jsxs(_components.p, {
      children: ["The up­dated ", _jsx(_components.code, {
        children: "pom.xml"
      }), " with the added prop­erty ", _jsx(_components.code, {
        children: "vertx-maven-plugin"
      }), " is shown below:"]
    }), "\n", _jsx(Alert, {
      info: true,
      children: _jsx(_components.p, {
        children: "Only up­dated sec­tion is shown below, rest of the pom.xml is same as above"
      })
    }), "\n", _jsx(Gist, {
      url: "https://gist.github.com/kameshsampath/24a1ed6a377b118f06af2c4b4ddf0ca0"
    }), "\n", _jsxs(_components.p, {
      children: ["To pack­age the Vert.x ap­pli­ca­tion, run the fol­low­ing ", _jsx(_components.a, {
        href: "http://maven.apache.org",
        children: "Apache Maven"
      }), " com­mand from the project di­rec­tory:"]
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "hljs language-bash",
        children: "mvn clean package\n"
      })
    }), "\n", _jsxs(_components.p, {
      children: ["On suc­cess­ful run of the above com­mand you should see the file with name ", _jsx(_components.code, {
        children: "${project.finalName}.jar"
      }), " cre­ated in the ", _jsx(_components.code, {
        children: "${project.build.directory}"
      }), ", you could now do the fol­low­ing to start and run the Vert.x ap­pli­ca­tion."]
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-bash",
        children: ["java -jar ", _jsx(_components.span, {
          className: "hljs-variable",
          children: "${project.build.directory}"
        }), "/", _jsx(_components.span, {
          className: "hljs-variable",
          children: "${project.finalName}"
        }), ".jar\n"]
      })
    }), "\n", _jsxs(_components.p, {
      children: ["The gen­er­ated ", _jsx(_components.code, {
        children: "MANIFEST.MF"
      }), " file is as shown below:"]
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "hljs language-text",
        children: "Main-Class                               io.vertx.core.Launcher\nMain-Verticle                            io.fabric8.blog.MainVerticle\nManifest-Version                         1.0\n"
      })
    }), "\n", _jsxs(_components.p, {
      children: ["The source code up to now is avail­able in ", _jsx(_components.a, {
        href: "https://github.com/kameshsampath/vmp-blog/tree/package",
        children: "here"
      })]
    }), "\n", _jsxs(_components.h3, {
      id: "spi-combination",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#spi-combination"
      }), "SPI Combination"]
    }), "\n", _jsxs(_components.p, {
      children: ["The ", _jsx(_components.code, {
        children: "package"
      }), " goal by de­fault does a SPI com­bi­na­tion, lets say you have a ser­vice file called ", _jsx(_components.code, {
        children: "com.fasterxml.jackson.core.JsonFactory"
      }), " in ", _jsx(_components.code, {
        children: "${project.basedir}/src/main/resources/META-INF/services"
      }), " with con­tents:"]
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "hljs language-text",
        children: "foo.bar.baz.MyImpl\n${combine}\n"
      })
    }), "\n", _jsxs(_components.p, {
      children: ["Dur­ing pack­ag­ing, if the ", _jsx(_components.a, {
        href: "http://vmp.fabric8.io",
        children: "fab­ric8 Vert.x Maven Plu­gin"
      }), " finds an­other ", _jsx(_components.code, {
        children: "com.fasterxml.jackson.core.JsonFactory"
      }), " ser­vice de­f­i­n­i­tion file within the project de­pen­den­cies with con­tent ", _jsx(_components.em, {
        children: "foo.bar.baz2.My­Impl2"
      }), ", then it merges the con­tent into ", _jsx(_components.code, {
        children: "com.fasterxml.jackson.core.JsonFactory"
      }), " of ", _jsx(_components.code, {
        children: "${project.basedir}/src/main/resources/META-INF/services"
      }), ", re­sult­ing in the fol­low­ing con­tent:"]
    }), "\n", _jsx(_components.pre, {
      children: _jsx(_components.code, {
        className: "hljs language-text",
        children: "foo.bar.baz.MyImpl\nfoo.bar.baz2.MyImpl2\n"
      })
    }), "\n", _jsxs(_components.p, {
      children: ["The po­si­tion of ", _jsx(_components.code, {
        children: "${combine}"
      }), " con­trols the or­der­ing of the merge, since we added ", _jsx(_components.code, {
        children: "${combine}"
      }), " below ", _jsx(_components.em, {
        children: "foo.bar.baz.My­Impl"
      }), " all other SPI de­f­i­n­i­tions will be ap­pended below ", _jsx(_components.em, {
        children: "foo.bar.baz.My­Impl"
      })]
    }), "\n", _jsxs(_components.h2, {
      id: "whats-next-",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#whats-next-"
      }), "What’s next ?"]
    }), "\n", _jsxs(_components.p, {
      children: ["It’s good to have the jar pack­aged and run using ", _jsx(_components.code, {
        children: "java -jar uber-jar"
      }), ", but when doing typ­i­cal de­vel­op­ment you don’t  want to do fre­quent ", _jsx(_components.a, {
        href: "http://maven.apache.org",
        children: "Apache Maven"
      }), " pack­ag­ing and wish to see your changes au­to­mat­i­cally re­de­ployed."]
    }), "\n", _jsxs(_components.p, {
      children: ["Don’t worry!!! As part of ", _jsx(_components.a, {
        href: "http://vmp.fabric8.io",
        children: "fab­ric8 Vert.x Maven Plu­gin"
      }), " we have added the in­cre­men­tal builder to ", _jsx(_components.a, {
        href: "http://maven.apache.org",
        children: "Apache Maven"
      }), " build, which will watch for your source and re­source changes to per­form au­to­matic re-​build and del­e­gate the re­de­ploy­ment to Vert.x."]
    }), "\n", _jsxs(_components.p, {
      children: ["Run, re­de­ploy and other fea­tures of the ", _jsx(_components.a, {
        href: "http://vmp.fabric8.io",
        children: "fab­ric8 Vert.x Maven Plu­gin"
      }), " will be ex­plored in de­tail in the next part of this se­ries, until then have fun with ", _jsx(_components.a, {
        href: "http://vmp.fabric8.io",
        children: "fab­ric8 Vert.x Maven Plu­gin"
      }), "!!"]
    })]
  });
}
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

Getting started with new fabric8 Vert.x Maven Plugin

Next post

Internet of Things - Reactive and Asynchronous with Vert.x

Previous post

OAuth2 got easy

Blog

Getting started with new fabric8 Vert.x Maven Plugin

Next post

Internet of Things - Reactive and Asynchronous with Vert.x

Previous post

OAuth2 got easy

Related posts

My first Vert.x 3 Application

Unit and Integration Tests

Vert.x featuring Continuous Delivery with Jenkins and Ansible