JettyMicroserviceBuilder (Apache Juneau 8.1.2)

java.lang.Object
- org.apache.juneau.microservice.MicroserviceBuilder
- - org.apache.juneau.microservice.jetty.JettyMicroserviceBuilder

```
public class JettyMicroserviceBuilder
extends MicroserviceBuilder
```
Builder for JettyMicroservice class.
Instances of this class are created using JettyMicroservice.create().

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`JettyMicroserviceBuilder()` Constructor.
`protected`	`JettyMicroserviceBuilder(JettyMicroserviceBuilder copyFrom)` Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JettyMicroserviceBuilder`	`args(Args args)` Specifies the command-line arguments passed into the Java command.
`JettyMicroserviceBuilder`	`args(String... args)` Specifies the command-line arguments passed into the Java command.
`JettyMicroservice`	`build()` Instantiate a new microservice using the settings defined on this builder.
`JettyMicroserviceBuilder`	`config(Config config)` Specifies the config for initializing this microservice.
`JettyMicroserviceBuilder`	`configName(String configName)` Specifies the config name for initializing this microservice.
`JettyMicroserviceBuilder`	`configStore(ConfigStore configStore)` Specifies the config store to use for storing and retrieving configurations.
`JettyMicroserviceBuilder`	`console(Scanner consoleReader, PrintWriter consoleWriter)` Specifies the console input and output.
`JettyMicroserviceBuilder`	`consoleCommands(ConsoleCommand... consoleCommands)` Specifies console commands to make available on the Java console.
`JettyMicroserviceBuilder`	`consoleEnabled(boolean consoleEnabled)` Specifies that the Java console is enabled for this microservice.
`JettyMicroserviceBuilder`	`copy()` Creates a copy of this builder.
`JettyMicroserviceBuilder`	`jettyServerFactory(JettyServerFactory value)` Specifies the factory to use for creating the Jetty `Server` instance.
`JettyMicroserviceBuilder`	`jettyXml(Object jettyXml, boolean resolveVars)` Specifies the contents or location of the jetty.xml file used by the Jetty server.
`JettyMicroserviceBuilder`	`listener(JettyMicroserviceListener listener)` Registers an event listener for this microservice.
`JettyMicroserviceBuilder`	`logConfig(LogConfig logConfig)` Specifies logging instructions for the microservice.
`JettyMicroserviceBuilder`	`logger(Logger logger)` Specifies the logger used by the microservice and returned by the `Microservice.getLogger()` method.
`JettyMicroserviceBuilder`	`manifest(Object manifest)` Specifies the manifest file of the jar file this microservice is contained within.
`JettyMicroserviceBuilder`	`ports(int... ports)` Specifies the ports to use for the web server.
`JettyMicroserviceBuilder`	`servlet(Class<? extends RestServlet> c)` Adds a servlet to the servlet container.
`JettyMicroserviceBuilder`	`servlet(Class<? extends Servlet> c, String path)` Adds a servlet to the servlet container.
`JettyMicroserviceBuilder`	`servlet(Servlet servlet, String path)` Adds a servlet instance to the servlet container.
`JettyMicroserviceBuilder`	`servletAttribute(Map<String,Object> values)` Adds a set of servlet attributes to the servlet container.
`JettyMicroserviceBuilder`	`servletAttribute(String name, Object value)` Adds a servlet attribute to the servlet container.
`JettyMicroserviceBuilder`	`servlets(Map<String,Servlet> servlets)` Adds a set of servlets to the servlet container.
`JettyMicroserviceBuilder`	`varContext(String name, Object object)` Adds a var resolver context object for vars defined in the configuration and var resolver.
`JettyMicroserviceBuilder`	`vars(Class<? extends Var>... vars)` Augments the set of variables defined in the configuration and var resolver.
`JettyMicroserviceBuilder`	`workingDir(File path)` Specifies the directory to use to resolve the config file and other paths defined with the config file.
`JettyMicroserviceBuilder`	`workingDir(String path)` Specifies the directory to use to resolve the config file and other paths defined with the config file.

Methods inherited from class org.apache.juneau.microservice.MicroserviceBuilder
consoleCommands, listener, resolveFile

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JettyMicroserviceBuilder
```
protected JettyMicroserviceBuilder()
```
    Constructor.
  - JettyMicroserviceBuilder
```
protected JettyMicroserviceBuilder(JettyMicroserviceBuilder copyFrom)
```
    Copy constructor.
    
    Parameters:
    
    copyFrom - The builder to copy settings from.
- Method Detail
  - copy
```
public JettyMicroserviceBuilder copy()
```
    Description copied from class: MicroserviceBuilder
    
    Creates a copy of this builder.
    
    Overrides:
    
    copy in class MicroserviceBuilder
    
    Returns:
    
    A new copy of this builder.
  - jettyXml
```
public JettyMicroserviceBuilder jettyXml(Object jettyXml,
                                         boolean resolveVars)
                                  throws IOException
```
    Specifies the contents or location of the jetty.xml file used by the Jetty server.
    If you do not specify this value, it is pulled from the following in the specified order:
    - Jetty/config setting in the config file. Jetty-Config setting in the manifest file.
    By default, we look for the jetty.xml file in the following locations:
    - jetty.xml in home directory.
    - files/jetty.xml in home directory.
    - /jetty.xml in classpath.
    - /files/jetty.xml in classpath.
    Parameters:
    jettyXml - The contents or location of the file.
    Can be any of the following:
    
    String - Relative path to file on file system or classpath.
    File - File on file system.
    InputStream - Raw contents as UTF-8 encoded stream.
    Reader - Raw contents.
    resolveVars - If true, SVL variables in the file will automatically be resolved.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    IOException - Thrown by underlying stream.
  - ports
```
public JettyMicroserviceBuilder ports(int... ports)
```
    Specifies the ports to use for the web server.
    You can specify multiple ports. The first available will be used. '0' indicates to try a random port. The resulting available port gets set as the system property "availablePort" which can be referenced in the jetty.xml file as "$S{availablePort}" (assuming resolveVars is enabled).
    If you do not specify this value, it is pulled from the following in the specified order:
    - Jetty/port setting in the config file.
    - Jetty-Port setting in the manifest file.
    - 8000
    Jetty/port", mf.getWithDefault("Jetty-Port", new int[]{8000}
    Parameters:
    
    ports - The ports to use for the web server.
    
    Returns:
    
    This object (for method chaining).
  - servlet
```
public JettyMicroserviceBuilder servlet(Class<? extends RestServlet> c)
                                 throws ExecutableException
```
    Adds a servlet to the servlet container.
    This method can only be used with servlets with no-arg constructors.
    The path is pulled from the Rest.path() annotation.
    
    Parameters:
    
    c - The servlet to add to the servlet container.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    ExecutableException - Exception occurred on invoked constructor/method/field.
  - servlet
```
public JettyMicroserviceBuilder servlet(Class<? extends Servlet> c,
                                        String path)
                                 throws ExecutableException
```
    Adds a servlet to the servlet container.
    This method can only be used with servlets with no-arg constructors.
    
    Parameters:
    
    c - The servlet to add to the servlet container.
    
    path - The servlet path spec.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    ExecutableException - Exception occurred on invoked constructor/method/field.
  - servlet
```
public JettyMicroserviceBuilder servlet(Servlet servlet,
                                        String path)
```
    Adds a servlet instance to the servlet container.
    
    Parameters:
    
    servlet - The servlet to add to the servlet container.
    
    path - The servlet path spec.
    
    Returns:
    
    This object (for method chaining).
  - servlets
```
public JettyMicroserviceBuilder servlets(Map<String,Servlet> servlets)
```
    Adds a set of servlets to the servlet container.
    
    Parameters:
    
    servlets - A map of servlets to add to the servlet container.
    Keys are path specs for the servlet.
    
    Returns:
    
    This object (for method chaining).
  - servletAttribute
```
public JettyMicroserviceBuilder servletAttribute(String name,
                                                 Object value)
```
    Adds a servlet attribute to the servlet container.
    
    Parameters:
    
    name - The attribute name.
    
    value - The attribute value.
    
    Returns:
    
    This object (for method chaining).
  - servletAttribute
```
public JettyMicroserviceBuilder servletAttribute(Map<String,Object> values)
```
    Adds a set of servlet attributes to the servlet container.
    
    Parameters:
    
    values - The map of attributes.
    
    Returns:
    
    This object (for method chaining).
  - jettyServerFactory
```
public JettyMicroserviceBuilder jettyServerFactory(JettyServerFactory value)
```
    Specifies the factory to use for creating the Jetty Server instance.
    If not specified, uses BasicJettyServerFactory.
    
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - build
```
public JettyMicroservice build()
                        throws Exception
```
    Description copied from class: MicroserviceBuilder
    
    Instantiate a new microservice using the settings defined on this builder.
    
    Overrides:
    
    build in class MicroserviceBuilder
    
    Returns:
    
    A new microservice.
    
    Throws:
    
    Exception - Error occurred.
  - args
```
public JettyMicroserviceBuilder args(Args args)
```
    Description copied from class: MicroserviceBuilder
    
    Specifies the command-line arguments passed into the Java command.
    This is required if you use Microservice.getArgs() or $A string variables.
    
    Overrides:
    
    args in class MicroserviceBuilder
    
    Parameters:
    
    args - The command-line arguments passed into the Java command as a pre-parsed Args object.
    
    Returns:
    
    This object (for method chaining).
  - args
```
public JettyMicroserviceBuilder args(String... args)
```
    Description copied from class: MicroserviceBuilder
    
    Specifies the command-line arguments passed into the Java command.
    This is required if you use Microservice.getArgs() or $A string variables.
    
    Overrides:
    
    args in class MicroserviceBuilder
    
    Parameters:
    
    args - The command-line arguments passed into the Java command as the raw command-line arguments.
    
    Returns:
    
    This object (for method chaining).
  - manifest
```
public JettyMicroserviceBuilder manifest(Object manifest)
                                  throws IOException
```
    Description copied from class: MicroserviceBuilder
    Specifies the manifest file of the jar file this microservice is contained within.
    This is required if you use Microservice.getManifest(). It's also used to locate initialization values such as Main-Config.
    If you do not specify the manifest file, we attempt to resolve it through the following methods:
    1. Looking on the file system for a file at "META-INF/MANIFEST.MF". This is primarily to allow for running microservices from within eclipse workspaces where the manifest file is located in the project root.
    2. Using the class loader for this class to find the file at the URL "META-INF/MANIFEST.MF".
    Overrides:
    
    manifest in class MicroserviceBuilder
    
    Parameters:
    manifest - The manifest file of this microservice.
    Can be any of the following types:
    
    ManifestFile
    Manifest
    Reader - Containing the raw contents of the manifest. Note that the input must end with a newline.
    InputStream - Containing the raw contents of the manifest. Note that the input must end with a newline.
    File - File containing the raw contents of the manifest.
    String - Path to file containing the raw contents of the manifest.
    Class - Finds and loads the manifest file of the jar file that the specified class is contained within.
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    IOException - Thrown by underlying stream.
  - logger
```
public JettyMicroserviceBuilder logger(Logger logger)
```
    Description copied from class: MicroserviceBuilder
    
    Specifies the logger used by the microservice and returned by the Microservice.getLogger() method.
    Calling this method overrides the default logging mechanism controlled by the MicroserviceBuilder.logConfig(LogConfig) method.
    
    Overrides:
    
    logger in class MicroserviceBuilder
    
    Parameters:
    
    logger - The logger to use for logging microservice messages.
    
    Returns:
    
    This object (for method chaining).
  - logConfig
```
public JettyMicroserviceBuilder logConfig(LogConfig logConfig)
```
    Description copied from class: MicroserviceBuilder
    
    Specifies logging instructions for the microservice.
    If not specified, the values are taken from the "Logging" section of the configuration.
    This method is ignored if MicroserviceBuilder.logger(Logger) is used to set the microservice logger.
    
    Overrides:
    
    logConfig in class MicroserviceBuilder
    
    Parameters:
    
    logConfig - The log configuration.
    
    Returns:
    
    This object (for method chaining).
  - config
```
public JettyMicroserviceBuilder config(Config config)
```
    Description copied from class: MicroserviceBuilder
    
    Specifies the config for initializing this microservice.
    Calling this method overrides the default configuration controlled by the MicroserviceBuilder.configName(String) and MicroserviceBuilder.configStore(ConfigStore) methods.
    
    Overrides:
    
    config in class MicroserviceBuilder
    
    Parameters:
    
    config - The configuration.
    
    Returns:
    
    This object (for method chaining).
  - configName
```
public JettyMicroserviceBuilder configName(String configName)
```
    Description copied from class: MicroserviceBuilder
    Specifies the config name for initializing this microservice.
    If you do not specify the config file location, we attempt to resolve it through the following methods:
    1. Resolve file first in working directory, then in classpath, using the following names:
      
      The "configFile" argument in the command line arguments passed in through the constructor.
      The value of the Main-Config entry in the manifest file.
      A config file in the same location and with the same name as the executable jar file. (e.g. "java -jar myjar.jar" will look for "myjar.cfg").
    2. Resolve any "*.cfg" file that can be found in the working directory.
    3. Resolve any of the following files in the classpath: "juneau.cfg", "system.cfg"
    If no configuration file is found, and empty in-memory configuration is used.
    Overrides:
    
    configName in class MicroserviceBuilder
    
    Parameters:
    
    configName - The configuration name.
    
    Returns:
    
    This object (for method chaining).
  - configStore
```
public JettyMicroserviceBuilder configStore(ConfigStore configStore)
```
    Description copied from class: MicroserviceBuilder
    
    Specifies the config store to use for storing and retrieving configurations.
    By default, we use a ConfigFileStore store for configuration files.
    
    Overrides:
    
    configStore in class MicroserviceBuilder
    
    Parameters:
    
    configStore - The configuration name.
    
    Returns:
    
    This object (for method chaining).
  - consoleEnabled
```
public JettyMicroserviceBuilder consoleEnabled(boolean consoleEnabled)
```
    Description copied from class: MicroserviceBuilder
    
    Specifies that the Java console is enabled for this microservice.
    If not specified, this value is taken from the "Console/enabled" configuration setting. If not specified in the configuration, defaults to false.
    
    Overrides:
    
    consoleEnabled in class MicroserviceBuilder
    
    Parameters:
    
    consoleEnabled - true if the Java console is enabled for this microservice.
    
    Returns:
    
    This object (for method chaining).
  - consoleCommands
```
public JettyMicroserviceBuilder consoleCommands(ConsoleCommand... consoleCommands)
```
    Description copied from class: MicroserviceBuilder
    
    Specifies console commands to make available on the Java console.
    Note that these are ignored if the console is not enabled via MicroserviceBuilder.consoleEnabled(boolean).
    This list augments the commands defined via the "Console/commands" configuration setting.
    
    Overrides:
    
    consoleCommands in class MicroserviceBuilder
    
    Parameters:
    
    consoleCommands - The list of console commands to append to the list of available commands.
    
    Returns:
    
    This object (for method chaining).
  - console
```
public JettyMicroserviceBuilder console(Scanner consoleReader,
                                        PrintWriter consoleWriter)
```
    Description copied from class: MicroserviceBuilder
    
    Specifies the console input and output.
    If not specified, uses the console returned by System.console(). If that is not available, uses System.in and System.out.
    Note that these are ignored if the console is not enabled via MicroserviceBuilder.consoleEnabled(boolean).
    
    Overrides:
    
    console in class MicroserviceBuilder
    
    Parameters:
    
    consoleReader - The console input.
    
    consoleWriter - The console output.
    
    Returns:
    
    This object (for method chaining).
  - vars
```
public JettyMicroserviceBuilder vars(Class<? extends Var>... vars)
```
    Description copied from class: MicroserviceBuilder
    
    Augments the set of variables defined in the configuration and var resolver.
    This calls VarResolverBuilder.vars(Class[]) on the var resolver used to construct the configuration object returned by Microservice.getConfig() and the var resolver returned by Microservice.getVarResolver().
    
    Overrides:
    
    vars in class MicroserviceBuilder
    
    Parameters:
    
    vars - The set of variables to append to the var resolver builder.
    
    Returns:
    
    This object (for method chaining).
  - varContext
```
public JettyMicroserviceBuilder varContext(String name,
                                           Object object)
```
    Description copied from class: MicroserviceBuilder
    
    Adds a var resolver context object for vars defined in the configuration and var resolver.
    This calls VarResolverBuilder.contextObject(String,Object) on the var resolver used to construct the configuration object returned by Microservice.getConfig() and the var resolver returned by Microservice.getVarResolver().
    
    Overrides:
    
    varContext in class MicroserviceBuilder
    
    Parameters:
    
    name - The context object name.
    
    object - The context object.
    
    Returns:
    
    This object (for method chaining).
  - workingDir
```
public JettyMicroserviceBuilder workingDir(File path)
```
    Description copied from class: MicroserviceBuilder
    
    Specifies the directory to use to resolve the config file and other paths defined with the config file.
    
    Overrides:
    
    workingDir in class MicroserviceBuilder
    
    Parameters:
    
    path - The working directory, or null to use the underlying working directory.
    
    Returns:
    
    This object (for method chaining).
  - workingDir
```
public JettyMicroserviceBuilder workingDir(String path)
```
    Description copied from class: MicroserviceBuilder
    
    Specifies the directory to use to resolve the config file and other paths defined with the config file.
    
    Overrides:
    
    workingDir in class MicroserviceBuilder
    
    Parameters:
    
    path - The working directory, or null to use the underlying working directory.
    
    Returns:
    
    This object (for method chaining).
  - listener
```
public JettyMicroserviceBuilder listener(JettyMicroserviceListener listener)
```
    Registers an event listener for this microservice.
    
    Parameters:
    
    listener - An event listener for this microservice.
    
    Returns:
    
    This object (for method chaining).

Class JettyMicroserviceBuilder

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.microservice.MicroserviceBuilder

Methods inherited from class java.lang.Object

Constructor Detail

JettyMicroserviceBuilder

JettyMicroserviceBuilder

Method Detail

copy

jettyXml

ports

servlet

servlet

servlet

servlets

servletAttribute

servletAttribute

jettyServerFactory

build

args

args

manifest

logger

logConfig

config

configName

configStore

consoleEnabled

consoleCommands

console

vars

varContext

workingDir

workingDir

listener