| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Microservice.Builder (Apache Juneau 9.0.0)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Microservice.Builder (Apache Juneau 9.0.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/juneau/microservice/MicroserviceListener.html" title="interface in org.apache.juneau.microservice"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/juneau/microservice/Microservice.Builder.html" target="_top">Frames</a></li> |
| <li><a href="Microservice.Builder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.juneau.microservice</div> |
| <h2 title="Class Microservice.Builder" class="title">Class Microservice.Builder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.juneau.microservice.Microservice.Builder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/juneau/microservice/jetty/JettyMicroservice.Builder.html" title="class in org.apache.juneau.microservice.jetty">JettyMicroservice.Builder</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice">Microservice</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.html#line.143">Microservice.Builder</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Builder class.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#Builder--">Builder</a></span>()</code> |
| <div class="block">Constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#Builder-org.apache.juneau.microservice.Microservice.Builder-">Builder</a></span>(<a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> copyFrom)</code> |
| <div class="block">Copy constructor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#args-org.apache.juneau.collections.Args-">args</a></span>(<a href="../../../../org/apache/juneau/collections/Args.html" title="class in org.apache.juneau.collections">Args</a> args)</code> |
| <div class="block">Specifies the command-line arguments passed into the Java command.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#args-java.lang.String...-">args</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</code> |
| <div class="block">Specifies the command-line arguments passed into the Java command.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice">Microservice</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#build--">build</a></span>()</code> |
| <div class="block">Instantiate a new microservice using the settings defined on this builder.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#config-org.apache.juneau.config.Config-">config</a></span>(<a href="../../../../org/apache/juneau/config/Config.html" title="class in org.apache.juneau.config">Config</a> config)</code> |
| <div class="block">Specifies the config for initializing this microservice.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#configName-java.lang.String-">configName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> configName)</code> |
| <div class="block">Specifies the config name for initializing this microservice.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#configStore-org.apache.juneau.config.store.ConfigStore-">configStore</a></span>(<a href="../../../../org/apache/juneau/config/store/ConfigStore.html" title="class in org.apache.juneau.config.store">ConfigStore</a> configStore)</code> |
| <div class="block">Specifies the config store to use for storing and retrieving configurations.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#console-java.util.Scanner-java.io.PrintWriter-">console</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Scanner.html?is-external=true" title="class or interface in java.util">Scanner</a> consoleReader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> consoleWriter)</code> |
| <div class="block">Specifies the console input and output.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#consoleCommands-java.lang.Class...-">consoleCommands</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/juneau/microservice/console/ConsoleCommand.html" title="class in org.apache.juneau.microservice.console">ConsoleCommand</a>>... consoleCommands)</code> |
| <div class="block">Specifies console commands to make available on the Java console.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#consoleCommands-org.apache.juneau.microservice.console.ConsoleCommand...-">consoleCommands</a></span>(<a href="../../../../org/apache/juneau/microservice/console/ConsoleCommand.html" title="class in org.apache.juneau.microservice.console">ConsoleCommand</a>... consoleCommands)</code> |
| <div class="block">Specifies console commands to make available on the Java console.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#consoleEnabled-boolean-">consoleEnabled</a></span>(boolean consoleEnabled)</code> |
| <div class="block">Specifies that the Java console is enabled for this microservice.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#copy--">copy</a></span>()</code> |
| <div class="block">Creates a copy of this builder.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#listener-org.apache.juneau.microservice.MicroserviceListener-">listener</a></span>(<a href="../../../../org/apache/juneau/microservice/MicroserviceListener.html" title="interface in org.apache.juneau.microservice">MicroserviceListener</a> listener)</code> |
| <div class="block">Registers an event listener for this microservice.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#logConfig-org.apache.juneau.microservice.LogConfig-">logConfig</a></span>(<a href="../../../../org/apache/juneau/microservice/LogConfig.html" title="class in org.apache.juneau.microservice">LogConfig</a> logConfig)</code> |
| <div class="block">Specifies logging instructions for the microservice.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#logger-java.util.logging.Logger-">logger</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging">Logger</a> logger)</code> |
| <div class="block">Specifies the logger used by the microservice and returned by the <a href="../../../../org/apache/juneau/microservice/Microservice.html#getLogger--"><code>Microservice.getLogger()</code></a> method.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#manifest-java.lang.Object-">manifest</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Specifies the manifest file of the jar file this microservice is contained within.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#resolveFile-java.lang.String-">resolveFile</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</code> |
| <div class="block">Resolves the specified path.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#varBean-java.lang.Class-T-">varBean</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> c, |
| T value)</code> |
| <div class="block">Adds a bean for vars defined in the var resolver.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#vars-java.lang.Class...-">vars</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/juneau/svl/Var.html" title="class in org.apache.juneau.svl">Var</a>>... vars)</code> |
| <div class="block">Augments the set of variables defined in the configuration and var resolver.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#workingDir-java.io.File-">workingDir</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> workingDir)</code> |
| <div class="block">Specifies the directory to use to resolve the config file and other paths defined with the config file.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#workingDir-java.lang.String-">workingDir</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> workingDir)</code> |
| <div class="block">Specifies the directory to use to resolve the config file and other paths defined with the config file.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Builder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>protected <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.164">Builder</a>()</pre> |
| <div class="block">Constructor.</div> |
| </li> |
| </ul> |
| <a name="Builder-org.apache.juneau.microservice.Microservice.Builder-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>protected <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.171">Builder</a>(<a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> copyFrom)</pre> |
| <div class="block">Copy constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>copyFrom</code> - The builder to copy.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="copy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.190">copy</a>()</pre> |
| <div class="block">Creates a copy of this builder.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new copy of this builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice">Microservice</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.200">build</a>() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Instantiate a new microservice using the settings defined on this builder.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new microservice.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - Error occurred.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="args-org.apache.juneau.collections.Args-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>args</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.214">args</a>(<a href="../../../../org/apache/juneau/collections/Args.html" title="class in org.apache.juneau.collections">Args</a> args)</pre> |
| <div class="block">Specifies the command-line arguments passed into the Java command. |
| |
| <p> |
| This is required if you use <a href="../../../../org/apache/juneau/microservice/Microservice.html#getArgs--"><code>Microservice.getArgs()</code></a> or <c>$A</c> string variables.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - The command-line arguments passed into the Java command as a pre-parsed <a href="../../../../org/apache/juneau/collections/Args.html" title="class in org.apache.juneau.collections"><code>Args</code></a> object.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="args-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>args</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.229">args</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</pre> |
| <div class="block">Specifies the command-line arguments passed into the Java command. |
| |
| <p> |
| This is required if you use <a href="../../../../org/apache/juneau/microservice/Microservice.html#getArgs--"><code>Microservice.getArgs()</code></a> or <c>$A</c> string variables.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - The command-line arguments passed into the Java command as the raw command-line arguments.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="manifest-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>manifest</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.267">manifest</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Specifies the manifest file of the jar file this microservice is contained within. |
| |
| <p> |
| This is required if you use <a href="../../../../org/apache/juneau/microservice/Microservice.html#getManifest--"><code>Microservice.getManifest()</code></a>. |
| It's also used to locate initialization values such as <c>Main-Config</c>. |
| |
| <p> |
| If you do not specify the manifest file, we attempt to resolve it through the following methods: |
| <ol class='spaced-list'> |
| <li> |
| Looking on the file system for a file at <js>"META-INF/MANIFEST.MF"</js>. |
| This is primarily to allow for running microservices from within eclipse workspaces where the manifest file |
| is located in the project root. |
| <li> |
| Using the class loader for this class to find the file at the URL <js>"META-INF/MANIFEST.MF"</js>. |
| </ol></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - The manifest file of this microservice. |
| <br>Can be any of the following types: |
| <ul> |
| <li><a href="../../../../org/apache/juneau/utils/ManifestFile.html" title="class in org.apache.juneau.utils"><code>ManifestFile</code></a> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/util/jar/Manifest.html?is-external=true" title="class or interface in java.util.jar"><code>Manifest</code></a> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a> - Containing the raw contents of the manifest. Note that the input must end with a newline. |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a> - Containing the raw contents of the manifest. Note that the input must end with a newline. |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> - File containing the raw contents of the manifest. |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> - Path to file containing the raw contents of the manifest. |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang"><code>Class</code></a> - Finds and loads the manifest file of the jar file that the specified class is contained within. |
| </ul></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown by underlying stream.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="logger-java.util.logging.Logger-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logger</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.299">logger</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging">Logger</a> logger)</pre> |
| <div class="block">Specifies the logger used by the microservice and returned by the <a href="../../../../org/apache/juneau/microservice/Microservice.html#getLogger--"><code>Microservice.getLogger()</code></a> method. |
| |
| <p> |
| Calling this method overrides the default logging mechanism controlled by the <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#logConfig-org.apache.juneau.microservice.LogConfig-"><code>logConfig(LogConfig)</code></a> method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>logger</code> - The logger to use for logging microservice messages.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="logConfig-org.apache.juneau.microservice.LogConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>logConfig</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.316">logConfig</a>(<a href="../../../../org/apache/juneau/microservice/LogConfig.html" title="class in org.apache.juneau.microservice">LogConfig</a> logConfig)</pre> |
| <div class="block">Specifies logging instructions for the microservice. |
| |
| <p> |
| If not specified, the values are taken from the <js>"Logging"</js> section of the configuration. |
| |
| <p> |
| This method is ignored if <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#logger-java.util.logging.Logger-"><code>logger(Logger)</code></a> is used to set the microservice logger.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>logConfig</code> - The log configuration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="config-org.apache.juneau.config.Config-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>config</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.330">config</a>(<a href="../../../../org/apache/juneau/config/Config.html" title="class in org.apache.juneau.config">Config</a> config)</pre> |
| <div class="block">Specifies the config for initializing this microservice. |
| |
| <p> |
| Calling this method overrides the default configuration controlled by the <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#configName-java.lang.String-"><code>configName(String)</code></a> and <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#configStore-org.apache.juneau.config.store.ConfigStore-"><code>configStore(ConfigStore)</code></a> methods.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - The configuration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="configName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configName</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.364">configName</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> configName)</pre> |
| <div class="block">Specifies the config name for initializing this microservice. |
| |
| <p> |
| If you do not specify the config file location, we attempt to resolve it through the following methods: |
| <ol class='spaced-list'> |
| <li> |
| Resolve file first in working directory, then in classpath, using the following names: |
| <ul> |
| <li> |
| The <js>"configFile"</js> argument in the command line arguments passed in through the constructor. |
| <li> |
| The value of the <c>Main-Config</c> entry in the manifest file. |
| <li> |
| A config file in the same location and with the same name as the executable jar file. |
| (e.g. <js>"java -jar myjar.jar"</js> will look for <js>"myjar.cfg"</js>). |
| </ul> |
| <li> |
| Resolve any <js>"*.cfg"</js> file that can be found in the working directory. |
| <li> |
| Resolve any of the following files in the classpath: <js>"juneau.cfg"</js>, <js>"system.cfg"</js> |
| </ol> |
| |
| <p> |
| If no configuration file is found, and empty in-memory configuration is used.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configName</code> - The configuration name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="configStore-org.apache.juneau.config.store.ConfigStore-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configStore</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.378">configStore</a>(<a href="../../../../org/apache/juneau/config/store/ConfigStore.html" title="class in org.apache.juneau.config.store">ConfigStore</a> configStore)</pre> |
| <div class="block">Specifies the config store to use for storing and retrieving configurations. |
| |
| <p> |
| By default, we use a <a href="../../../../org/apache/juneau/config/store/FileStore.html" title="class in org.apache.juneau.config.store"><code>FileStore</code></a> store for configuration files.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configStore</code> - The configuration name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="consoleEnabled-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>consoleEnabled</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.393">consoleEnabled</a>(boolean consoleEnabled)</pre> |
| <div class="block">Specifies that the Java console is enabled for this microservice. |
| |
| <p> |
| If not specified, this value is taken from the <js>"Console/enabled"</js> configuration setting. |
| If not specified in the configuration, defaults to <jk>false</jk>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consoleEnabled</code> - <jk>true</jk> if the Java console is enabled for this microservice.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="consoleCommands-java.lang.Class...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>consoleCommands</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.415">consoleCommands</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/juneau/microservice/console/ConsoleCommand.html" title="class in org.apache.juneau.microservice.console">ConsoleCommand</a>>... consoleCommands) |
| throws <a href="../../../../org/apache/juneau/ExecutableException.html" title="class in org.apache.juneau">ExecutableException</a></pre> |
| <div class="block">Specifies console commands to make available on the Java console. |
| |
| <p> |
| Note that these are ignored if the console is not enabled via <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#consoleEnabled-boolean-"><code>consoleEnabled(boolean)</code></a>. |
| |
| <p> |
| This list augments the commands defined via the <js>"Console/commands"</js> configuration setting. |
| |
| <p> |
| This method can only be used on console commands with no-arg constructors.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consoleCommands</code> - The list of console commands to append to the list of available commands.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/juneau/ExecutableException.html" title="class in org.apache.juneau">ExecutableException</a></code> - Exception occurred on invoked constructor/method/field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="consoleCommands-org.apache.juneau.microservice.console.ConsoleCommand...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>consoleCommands</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.437">consoleCommands</a>(<a href="../../../../org/apache/juneau/microservice/console/ConsoleCommand.html" title="class in org.apache.juneau.microservice.console">ConsoleCommand</a>... consoleCommands)</pre> |
| <div class="block">Specifies console commands to make available on the Java console. |
| |
| <p> |
| Note that these are ignored if the console is not enabled via <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#consoleEnabled-boolean-"><code>consoleEnabled(boolean)</code></a>. |
| |
| <p> |
| This list augments the commands defined via the <js>"Console/commands"</js> configuration setting.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consoleCommands</code> - The list of console commands to append to the list of available commands.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="console-java.util.Scanner-java.io.PrintWriter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>console</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.456">console</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Scanner.html?is-external=true" title="class or interface in java.util">Scanner</a> consoleReader, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> consoleWriter)</pre> |
| <div class="block">Specifies the console input and output. |
| |
| <p> |
| If not specified, uses the console returned by <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#console--" title="class or interface in java.lang"><code>System.console()</code></a>. |
| If that is not available, uses <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#in" title="class or interface in java.lang"><code>System.in</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#out" title="class or interface in java.lang"><code>System.out</code></a>. |
| |
| <p> |
| Note that these are ignored if the console is not enabled via <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html#consoleEnabled-boolean-"><code>consoleEnabled(boolean)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consoleReader</code> - The console input.</dd> |
| <dd><code>consoleWriter</code> - The console output.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="vars-java.lang.Class...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>vars</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.473">vars</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/juneau/svl/Var.html" title="class in org.apache.juneau.svl">Var</a>>... vars)</pre> |
| <div class="block">Augments the set of variables defined in the configuration and var resolver. |
| |
| <p> |
| This calls <a href="../../../../org/apache/juneau/svl/VarResolver.Builder.html#vars-java.lang.Class...-"><code>VarResolver.Builder.vars(Class[])</code></a> on the var resolver used to construct the configuration |
| object returned by <a href="../../../../org/apache/juneau/microservice/Microservice.html#getConfig--"><code>Microservice.getConfig()</code></a> and the var resolver returned by <a href="../../../../org/apache/juneau/microservice/Microservice.html#getVarResolver--"><code>Microservice.getVarResolver()</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>vars</code> - The set of variables to append to the var resolver builder.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="varBean-java.lang.Class-java.lang.Object-"> |
| <!-- --> |
| </a><a name="varBean-java.lang.Class-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>varBean</h4> |
| <pre>public <T> <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.490">varBean</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> c, |
| T value)</pre> |
| <div class="block">Adds a bean for vars defined in the var resolver. |
| |
| <p> |
| This calls <a href="../../../../org/apache/juneau/svl/VarResolver.Builder.html#bean-java.lang.Class-T-"><code>VarResolver.Builder.bean(Class,Object)</code></a> on the var resolver used to construct the configuration |
| object returned by <a href="../../../../org/apache/juneau/microservice/Microservice.html#getConfig--"><code>Microservice.getConfig()</code></a> and the var resolver returned by <a href="../../../../org/apache/juneau/microservice/Microservice.html#getVarResolver--"><code>Microservice.getVarResolver()</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The bean type.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>c</code> - The bean type.</dd> |
| <dd><code>value</code> - The bean.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="workingDir-java.io.File-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>workingDir</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.501">workingDir</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> workingDir)</pre> |
| <div class="block">Specifies the directory to use to resolve the config file and other paths defined with the config file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>workingDir</code> - The working directory, or <jk>null</jk> to use the underlying working directory.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="workingDir-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>workingDir</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.512">workingDir</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> workingDir)</pre> |
| <div class="block">Specifies the directory to use to resolve the config file and other paths defined with the config file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>workingDir</code> - The working directory, or <jk>null</jk> to use the underlying working directory.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listener-org.apache.juneau.microservice.MicroserviceListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listener</h4> |
| <pre>public <a href="../../../../org/apache/juneau/microservice/Microservice.Builder.html" title="class in org.apache.juneau.microservice">Microservice.Builder</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.523">listener</a>(<a href="../../../../org/apache/juneau/microservice/MicroserviceListener.html" title="interface in org.apache.juneau.microservice">MicroserviceListener</a> listener)</pre> |
| <div class="block">Registers an event listener for this microservice.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - An event listener for this microservice.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resolveFile-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>resolveFile</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> <a href="../../../../src-html/org/apache/juneau/microservice/Microservice.Builder.html#line.537">resolveFile</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</pre> |
| <div class="block">Resolves the specified path. |
| |
| <p> |
| If the working directory has been explicitly specified, relative paths are resolved relative to that.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - The path to resolve.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The resolved file.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/juneau/microservice/Microservice.html" title="class in org.apache.juneau.microservice"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/juneau/microservice/MicroserviceListener.html" title="interface in org.apache.juneau.microservice"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/juneau/microservice/Microservice.Builder.html" target="_top">Frames</a></li> |
| <li><a href="Microservice.Builder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2016–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |