PayaraMicro (Payara Project 5.2021.4 API)

java.lang.Object
- fish.payara.micro.PayaraMicro

All Implemented Interfaces:: PayaraMicroBoot

public class PayaraMicro
extends Object
implements PayaraMicroBoot

Author:: steve

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PayaraMicro`	`addDeployFromGAV(String GAV)` Adds a Maven GAV coordinate to the list of archives to be deployed at boot.
`PayaraMicro`	`addDeployment(String pathToWar)` Adds an archive to the list of archives to be deployed at boot.
`PayaraMicro`	`addDeploymentFile(File file)` Adds an archive to the list of archives to be deployed at boot.
`PayaraMicro`	`addLibrary(File lib)` Adds the library to the classloader and loads it
`PayaraMicro`	`addRepoUrl(String... URLs)` Adds a Maven repository to the list of repositories to search for artifacts in
`static PayaraMicroRuntime`	`bootstrap()` Bootstraps the PayaraMicroRuntime with all defaults and no additional configuration.
`PayaraMicroRuntime`	`bootStrap()` Boots the Payara Micro Server.
`File`	`getAlternateDomainXML()` The path to an alternative domain.xml for PayaraMicro to use at boot
`int`	`getAutoBindRange()` Gets the maximum number of ports to check if free for autobinding purposes
`String`	`getClusterMulticastGroup()` Gets the cluster group
`int`	`getClusterPort()` Gets the cluster multicast port used for cluster communications
`int`	`getClusterStartPort()` Gets the instance listen port number used by clustering.
`File`	`getDeploymentDir()` A directory which will be scanned for archives to deploy
`boolean`	`getHttpAutoBind()` Indicates whether autobinding of the HTTP port is enabled
`int`	`getHttpPort()` The configured port Payara Micro will use for HTTP requests.
`String`	`getHzClusterName()` Gets the name of the Hazelcast cluster group.
`static PayaraMicro`	`getInstance()` Obtains the static singleton instance of the Payara Micro Server.
`static PayaraMicro`	`getInstance(boolean create)`
`String`	`getInstanceGroup()` Gets the name of the instance group
`String`	`getInstanceName()` Gets the logical name for this PayaraMicro Server within the server cluster
`int`	`getMaxHttpThreads()` The maximum threads in the HTTP(S) threadpool processing HTTP(S) requests.
`int`	`getMinHttpThreads()` The minimum number of threads in the HTTP(S) threadpool Default value is 10
`File`	`getRootDir()` The File path to a directory that PayaraMicro should use for storing its configuration files
`PayaraMicroRuntime`	`getRuntime()` Get a handle on the running Payara instance to manipulate the server once running
`boolean`	`getSslAutoBind()` Indicates whether autobinding of the HTTPS port is enabled
`String`	`getSslCert()` The name of the SSL certificate to use in the keystore
`int`	`getSslPort()` The configured port for HTTPS requests
`File`	`getUberJar()` The UberJar to create
`boolean`	`isLite()` Indicates whether this is a lite cluster member which means it stores no cluster data although it participates fully in the cluster.
`boolean`	`isNoCluster()` Indicated whether clustering is enabled
`static void`	`main(String... args)`
`PayaraMicro`	`setAccessLogDir(String filePath)` Set user defined file directory for the access log
`PayaraMicro`	`setAccessLogFormat(String format)` Set user defined formatting for the access log
`PayaraMicro`	`setAlternateDomainXML(File alternateDomainXML)` Sets the path to a domain.xml file PayaraMicro should use to boot.
`PayaraMicro`	`setApplicationDomainXML(String domainXml)` Sets an application specific domain.xml file that is embedded on the classpath of your application.
`PayaraMicro`	`setAutoBindRange(int autoBindRange)` Sets the maximum number of ports to check if free for autobinding purposes
`PayaraMicro`	`setClusterMulticastGroup(String hzMulticastGroup)` Sets the cluster group used for Payara Micro clustering used for cluster communications and discovery.
`PayaraMicro`	`setClusterPort(int hzPort)` Sets the multicast group used for Payara Micro clustering used for cluster communication and discovery.
`PayaraMicro`	`setClusterStartPort(int hzStartPort)` Sets the start port number for the Payara Micro to listen on for cluster communications.
`PayaraMicro`	`setDeploymentDir(File deploymentRoot)` Sets a directory to scan for archives to deploy on boot.
`PayaraMicro`	`setHttpAutoBind(boolean httpAutoBind)` Enables or disables autobinding of the HTTP port
`PayaraMicro`	`setHttpPort(int httpPort)` Sets the port used for HTTP requests
`PayaraMicro`	`setHzClusterName(String hzClusterName)` Sets the name of the Hazelcast cluster group
`PayaraMicro`	`setInstanceGroup(String instanceGroup)` Sets the instance group name
`PayaraMicro`	`setInstanceName(String instanceName)` Sets the logical instance name for this PayaraMicro server within the server cluster If this is not set a UUID is generated
`PayaraMicro`	`setLite(boolean liteMember)` Sets the lite status of this cluster member.
`PayaraMicro`	`setLogoFile(String filePath)` Sets the path to the logo file printed at boot.
`PayaraMicro`	`setLogPropertiesFile(File fileName)` Set user defined properties file for logging
`PayaraMicro`	`setMaxHttpThreads(int maxHttpThreads)` The maximum threads in the HTTP(S) threadpool processing HTTP(S) requests.
`PayaraMicro`	`setMinHttpThreads(int minHttpThreads)` The minimum number of threads in the HTTP(S) threadpool Default value is 10
`PayaraMicro`	`setNoCluster(boolean noCluster)` Enables or disables clustering before bootstrap
`PayaraMicroBoot`	`setPostBootHandler(Consumer<AdminCommandRunner> handler)` Register a handler for executing admin commands at post-boot time.
`PayaraMicroBoot`	`setPreBootHandler(Consumer<AdminCommandRunner> handler)` Register a handler for executing admin commands at pre-boot time.
`PayaraMicro`	`setPrintLogo(boolean generate)` Set whether the logo should be generated on boot
`PayaraMicro`	`setRootDir(File rootDir)` Sets the File path to a directory PayaraMicro should use to install its configuration files.
`PayaraMicro`	`setSniEnabled(boolean value)` Sets whether SNI enabled for SSL
`PayaraMicro`	`setSslAutoBind(boolean sslAutoBind)` Enables or disables autobinding of the HTTPS port
`PayaraMicro`	`setSslCert(String alias)` Sets the name of the certificate to use in the keystore
`PayaraMicro`	`setSslPort(int sslPort)` Sets the configured port for HTTPS requests.
`ClassLoader`	`setThreadBootstrapLoader()`
`static void`	`setUpackedJarDir(File file)` Sets the directory where unpacked jars should live And tells the runtime to unpack the jars This must be called before getInstance
`PayaraMicro`	`setUserLogFile(String fileName)` Set user defined file for the Log entries
`void`	`shutdown()` Stops and then shutsdown the Payara Micro Server
`static void`	`unpackJars()` Tells the runtime to unpack the jars before booting This must be called before getInstance If you require JSP compilation you MUST call this method

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

- Method Detail
  - unpackJars
```
public static void unpackJars()
```
    Tells the runtime to unpack the jars before booting This must be called before getInstance If you require JSP compilation you MUST call this method
  - setUpackedJarDir
```
public static void setUpackedJarDir(File file)
```
    Sets the directory where unpacked jars should live And tells the runtime to unpack the jars This must be called before getInstance
    
    Parameters:
    
    file -
  - getInstance
```
public static PayaraMicro getInstance()
```
    Obtains the static singleton instance of the Payara Micro Server. If it does not exist it will be created.
    
    Returns:
    
    The singleton instance
  - bootstrap
```
public static PayaraMicroRuntime bootstrap()
                                    throws BootstrapException
```
    Bootstraps the PayaraMicroRuntime with all defaults and no additional configuration. Functionally equivalent to PayaraMicro.getInstance().bootstrap();
    
    Returns:
    
    Throws:
    
    BootstrapException
  - getInstance
```
public static PayaraMicro getInstance(boolean create)
```
    Parameters:
    
    create - If false the instance won't be created if it has not been initialised
    
    Returns:
    
    null if no instance exists and create is false. Otherwise returns the singleton instance
  - addDeployFromGAV
```
public PayaraMicro addDeployFromGAV(String GAV)
```
    Description copied from interface: PayaraMicroBoot
    
    Adds a Maven GAV coordinate to the list of archives to be deployed at boot.
    
    Specified by:
    
    addDeployFromGAV in interface PayaraMicroBoot
    
    Parameters:
    
    GAV - GAV coordinate
    
    Returns:
  - addDeployment
```
public PayaraMicro addDeployment(String pathToWar)
```
    Description copied from interface: PayaraMicroBoot
    
    Adds an archive to the list of archives to be deployed at boot. These archives are not monitored for changes during running so are not redeployed without restarting the server
    
    Specified by:
    
    addDeployment in interface PayaraMicroBoot
    
    Parameters:
    
    pathToWar - File path to the deployment archive
    
    Returns:
  - addDeploymentFile
```
public PayaraMicro addDeploymentFile(File file)
```
    Description copied from interface: PayaraMicroBoot
    
    Adds an archive to the list of archives to be deployed at boot. These archives are not monitored for changes during running so are not redeployed without restarting the server
    
    Specified by:
    
    addDeploymentFile in interface PayaraMicroBoot
    
    Parameters:
    
    file - File path to the deployment archive
    
    Returns:
  - addRepoUrl
```
public PayaraMicro addRepoUrl(String... URLs)
```
    Description copied from interface: PayaraMicroBoot
    
    Adds a Maven repository to the list of repositories to search for artifacts in
    
    Specified by:
    
    addRepoUrl in interface PayaraMicroBoot
    
    Parameters:
    
    URLs - URL to Maven repository
    
    Returns:
  - bootStrap
```
public PayaraMicroRuntime bootStrap()
                             throws BootstrapException
```
    Description copied from interface: PayaraMicroBoot
    
    Boots the Payara Micro Server. All parameters are checked at this point
    
    Specified by:
    
    bootStrap in interface PayaraMicroBoot
    
    Returns:
    
    An instance of PayaraMicroRuntime that can be used to access the running server
    
    Throws:
    
    BootstrapException
  - getAlternateDomainXML
```
public File getAlternateDomainXML()
```
    Description copied from interface: PayaraMicroBoot
    
    The path to an alternative domain.xml for PayaraMicro to use at boot
    
    Specified by:
    
    getAlternateDomainXML in interface PayaraMicroBoot
    
    Returns:
    
    The path to the domain.xml
  - getAutoBindRange
```
public int getAutoBindRange()
```
    Description copied from interface: PayaraMicroBoot
    
    Gets the maximum number of ports to check if free for autobinding purposes
    
    Specified by:
    
    getAutoBindRange in interface PayaraMicroBoot
    
    Returns:
    
    The number of ports to check if free
  - getClusterMulticastGroup
```
public String getClusterMulticastGroup()
```
    Description copied from interface: PayaraMicroBoot
    
    Gets the cluster group
    
    Specified by:
    
    getClusterMulticastGroup in interface PayaraMicroBoot
    
    Returns:
    
    The Multicast Group that will beused for the Hazelcast clustering
  - getClusterPort
```
public int getClusterPort()
```
    Description copied from interface: PayaraMicroBoot
    
    Gets the cluster multicast port used for cluster communications
    
    Specified by:
    
    getClusterPort in interface PayaraMicroBoot
    
    Returns:
    
    The configured cluster port
  - getClusterStartPort
```
public int getClusterStartPort()
```
    Description copied from interface: PayaraMicroBoot
    
    Gets the instance listen port number used by clustering. This number will be incremented automatically if the port is unavailable due to another instance running on the same host,
    
    Specified by:
    
    getClusterStartPort in interface PayaraMicroBoot
    
    Returns:
    
    The start port number
  - getDeploymentDir
```
public File getDeploymentDir()
```
    Description copied from interface: PayaraMicroBoot
    
    A directory which will be scanned for archives to deploy
    
    Specified by:
    
    getDeploymentDir in interface PayaraMicroBoot
    
    Returns:
  - getHttpAutoBind
```
public boolean getHttpAutoBind()
```
    Description copied from interface: PayaraMicroBoot
    
    Indicates whether autobinding of the HTTP port is enabled
    
    Specified by:
    
    getHttpAutoBind in interface PayaraMicroBoot
    
    Returns:
  - getHttpPort
```
public int getHttpPort()
```
    Description copied from interface: PayaraMicroBoot
    
    The configured port Payara Micro will use for HTTP requests.
    
    Specified by:
    
    getHttpPort in interface PayaraMicroBoot
    
    Returns:
    
    The HTTP port
  - getHzClusterName
```
public String getHzClusterName()
```
    Description copied from interface: PayaraMicroBoot
    
    Gets the name of the Hazelcast cluster group. Clusters with different names do not interact
    
    Specified by:
    
    getHzClusterName in interface PayaraMicroBoot
    
    Returns:
    
    The current Cluster Name
  - getInstanceName
```
public String getInstanceName()
```
    Description copied from interface: PayaraMicroBoot
    
    Gets the logical name for this PayaraMicro Server within the server cluster
    
    Specified by:
    
    getInstanceName in interface PayaraMicroBoot
    
    Returns:
    
    The configured instance name
  - getMaxHttpThreads
```
public int getMaxHttpThreads()
```
    Description copied from interface: PayaraMicroBoot
    
    The maximum threads in the HTTP(S) threadpool processing HTTP(S) requests. Setting this will determine how many concurrent HTTP requests can be processed. The default value is 200. This value is shared by both HTTP and HTTP(S) requests.
    
    Specified by:
    
    getMaxHttpThreads in interface PayaraMicroBoot
    
    Returns:
  - getMinHttpThreads
```
public int getMinHttpThreads()
```
    Description copied from interface: PayaraMicroBoot
    
    The minimum number of threads in the HTTP(S) threadpool Default value is 10
    
    Specified by:
    
    getMinHttpThreads in interface PayaraMicroBoot
    
    Returns:
    
    The minimum threads to be created in the threadpool
  - getRootDir
```
public File getRootDir()
```
    Description copied from interface: PayaraMicroBoot
    
    The File path to a directory that PayaraMicro should use for storing its configuration files
    
    Specified by:
    
    getRootDir in interface PayaraMicroBoot
    
    Returns:
  - getRuntime
```
public PayaraMicroRuntime getRuntime()
                              throws IllegalStateException
```
    Description copied from interface: PayaraMicroBoot
    
    Get a handle on the running Payara instance to manipulate the server once running
    
    Specified by:
    
    getRuntime in interface PayaraMicroBoot
    
    Returns:
    
    Throws:
    
    IllegalStateException
  - getSslAutoBind
```
public boolean getSslAutoBind()
```
    Description copied from interface: PayaraMicroBoot
    
    Indicates whether autobinding of the HTTPS port is enabled
    
    Specified by:
    
    getSslAutoBind in interface PayaraMicroBoot
    
    Returns:
  - getSslPort
```
public int getSslPort()
```
    Description copied from interface: PayaraMicroBoot
    
    The configured port for HTTPS requests
    
    Specified by:
    
    getSslPort in interface PayaraMicroBoot
    
    Returns:
    
    The HTTPS port
  - getSslCert
```
public String getSslCert()
```
    Description copied from interface: PayaraMicroBoot
    
    The name of the SSL certificate to use in the keystore
    
    Specified by:
    
    getSslCert in interface PayaraMicroBoot
    
    Returns:
  - getUberJar
```
public File getUberJar()
```
    Description copied from interface: PayaraMicroBoot
    
    The UberJar to create
    
    Specified by:
    
    getUberJar in interface PayaraMicroBoot
    
    Returns:
  - isLite
```
public boolean isLite()
```
    Description copied from interface: PayaraMicroBoot
    
    Indicates whether this is a lite cluster member which means it stores no cluster data although it participates fully in the cluster.
    
    Specified by:
    
    isLite in interface PayaraMicroBoot
    
    Returns:
  - isNoCluster
```
public boolean isNoCluster()
```
    Description copied from interface: PayaraMicroBoot
    
    Indicated whether clustering is enabled
    
    Specified by:
    
    isNoCluster in interface PayaraMicroBoot
    
    Returns:
  - setAccessLogDir
```
public PayaraMicro setAccessLogDir(String filePath)
```
    Description copied from interface: PayaraMicroBoot
    
    Set user defined file directory for the access log
    
    Specified by:
    
    setAccessLogDir in interface PayaraMicroBoot
  - setAccessLogFormat
```
public PayaraMicro setAccessLogFormat(String format)
```
    Description copied from interface: PayaraMicroBoot
    
    Set user defined formatting for the access log
    
    Specified by:
    
    setAccessLogFormat in interface PayaraMicroBoot
  - setAlternateDomainXML
```
public PayaraMicro setAlternateDomainXML(File alternateDomainXML)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the path to a domain.xml file PayaraMicro should use to boot. If this is not set PayaraMicro will use an appropriate domain.xml from within its jar file
    
    Specified by:
    
    setAlternateDomainXML in interface PayaraMicroBoot
    
    Returns:
  - setApplicationDomainXML
```
public PayaraMicro setApplicationDomainXML(String domainXml)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets an application specific domain.xml file that is embedded on the classpath of your application.
    
    Specified by:
    
    setApplicationDomainXML in interface PayaraMicroBoot
    
    Parameters:
    
    domainXml - This is a resource string for your domain.xml
    
    Returns:
  - setPreBootHandler
```
public PayaraMicroBoot setPreBootHandler(Consumer<AdminCommandRunner> handler)
```
    Description copied from interface: PayaraMicroBoot
    
    Register a handler for executing admin commands at pre-boot time. Handler will be called with reference to AdminCommandRunner before instance starts. It offers way of changing domain configuration by means of running command set. The commands will be only executed on the instance that is booted. Only single handler can be registered.
    
    Specified by:
    
    setPreBootHandler in interface PayaraMicroBoot
    
    Returns:
  - setPostBootHandler
```
public PayaraMicroBoot setPostBootHandler(Consumer<AdminCommandRunner> handler)
```
    Description copied from interface: PayaraMicroBoot
    
    Register a handler for executing admin commands at post-boot time. Handler will be called with reference to AdminCommandRunner after all services start, but before deployment starts. All commands available over asadmin command are valid in this phase. The commands will be only executed on the instance starting up, not in any cluster it may have formed. Only single handler can be registered
    
    Specified by:
    
    setPostBootHandler in interface PayaraMicroBoot
    
    Returns:
  - setAutoBindRange
```
public PayaraMicro setAutoBindRange(int autoBindRange)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the maximum number of ports to check if free for autobinding purposes
    
    Specified by:
    
    setAutoBindRange in interface PayaraMicroBoot
    
    Parameters:
    
    autoBindRange - The maximum number of ports to increment the port value by
    
    Returns:
  - setClusterMulticastGroup
```
public PayaraMicro setClusterMulticastGroup(String hzMulticastGroup)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the cluster group used for Payara Micro clustering used for cluster communications and discovery. Each Payara Micro cluster should have different values for the MulticastGroup
    
    Specified by:
    
    setClusterMulticastGroup in interface PayaraMicroBoot
    
    Parameters:
    
    hzMulticastGroup - String representation of the multicast group
    
    Returns:
  - setClusterPort
```
public PayaraMicro setClusterPort(int hzPort)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the multicast group used for Payara Micro clustering used for cluster communication and discovery. Each Payara Micro cluster should have different values for the cluster port
    
    Specified by:
    
    setClusterPort in interface PayaraMicroBoot
    
    Parameters:
    
    hzPort - The port number
    
    Returns:
  - setClusterStartPort
```
public PayaraMicro setClusterStartPort(int hzStartPort)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the start port number for the Payara Micro to listen on for cluster communications.
    
    Specified by:
    
    setClusterStartPort in interface PayaraMicroBoot
    
    Parameters:
    
    hzStartPort - Start port number
    
    Returns:
  - setDeploymentDir
```
public PayaraMicro setDeploymentDir(File deploymentRoot)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets a directory to scan for archives to deploy on boot. This directory is not monitored while running for changes. Therefore archives in this directory will NOT be redeployed during runtime.
    
    Specified by:
    
    setDeploymentDir in interface PayaraMicroBoot
    
    Parameters:
    
    deploymentRoot - File path to the directory
    
    Returns:
  - setHttpAutoBind
```
public PayaraMicro setHttpAutoBind(boolean httpAutoBind)
```
    Description copied from interface: PayaraMicroBoot
    
    Enables or disables autobinding of the HTTP port
    
    Specified by:
    
    setHttpAutoBind in interface PayaraMicroBoot
    
    Parameters:
    
    httpAutoBind - The true or false value to enable or disable HTTP autobinding
    
    Returns:
  - setHttpPort
```
public PayaraMicro setHttpPort(int httpPort)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the port used for HTTP requests
    
    Specified by:
    
    setHttpPort in interface PayaraMicroBoot
    
    Parameters:
    
    httpPort - The port number
    
    Returns:
  - setHzClusterName
```
public PayaraMicro setHzClusterName(String hzClusterName)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the name of the Hazelcast cluster group
    
    Specified by:
    
    setHzClusterName in interface PayaraMicroBoot
    
    Parameters:
    
    hzClusterName - The name of the hazelcast cluster
    
    Returns:
  - getInstanceGroup
```
public String getInstanceGroup()
```
    Gets the name of the instance group
    
    Specified by:
    
    getInstanceGroup in interface PayaraMicroBoot
    
    Returns:
    
    The name of the instance group
  - setInstanceGroup
```
public PayaraMicro setInstanceGroup(String instanceGroup)
```
    Sets the instance group name
    
    Specified by:
    
    setInstanceGroup in interface PayaraMicroBoot
    
    Parameters:
    
    instanceGroup - The instance group name
    
    Returns:
  - setInstanceName
```
public PayaraMicro setInstanceName(String instanceName)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the logical instance name for this PayaraMicro server within the server cluster If this is not set a UUID is generated
    
    Specified by:
    
    setInstanceName in interface PayaraMicroBoot
    
    Parameters:
    
    instanceName - The logical server name
    
    Returns:
  - setLite
```
public PayaraMicro setLite(boolean liteMember)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the lite status of this cluster member. If true the Payara Micro is a lite cluster member which means it stores no cluster data.
    
    Specified by:
    
    setLite in interface PayaraMicroBoot
    
    Parameters:
    
    liteMember - set to true to set as a lite cluster member with no data storage
    
    Returns:
  - setLogPropertiesFile
```
public PayaraMicro setLogPropertiesFile(File fileName)
```
    Description copied from interface: PayaraMicroBoot
    
    Set user defined properties file for logging
    
    Specified by:
    
    setLogPropertiesFile in interface PayaraMicroBoot
    
    Returns:
  - setLogoFile
```
public PayaraMicro setLogoFile(String filePath)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the path to the logo file printed at boot. This can be on the classpath of the server or an absolute URL
    
    Specified by:
    
    setLogoFile in interface PayaraMicroBoot
    
    Returns:
  - setMaxHttpThreads
```
public PayaraMicro setMaxHttpThreads(int maxHttpThreads)
```
    Description copied from interface: PayaraMicroBoot
    
    The maximum threads in the HTTP(S) threadpool processing HTTP(S) requests. Setting this will determine how many concurrent HTTP requests can be processed. The default value is 200
    
    Specified by:
    
    setMaxHttpThreads in interface PayaraMicroBoot
    
    Parameters:
    
    maxHttpThreads - Maximum threads in the HTTP(S) threadpool
    
    Returns:
  - setMinHttpThreads
```
public PayaraMicro setMinHttpThreads(int minHttpThreads)
```
    Description copied from interface: PayaraMicroBoot
    
    The minimum number of threads in the HTTP(S) threadpool Default value is 10
    
    Specified by:
    
    setMinHttpThreads in interface PayaraMicroBoot
    
    Returns:
  - setNoCluster
```
public PayaraMicro setNoCluster(boolean noCluster)
```
    Description copied from interface: PayaraMicroBoot
    
    Enables or disables clustering before bootstrap
    
    Specified by:
    
    setNoCluster in interface PayaraMicroBoot
    
    Parameters:
    
    noCluster - set to true to disable clustering
    
    Returns:
  - setPrintLogo
```
public PayaraMicro setPrintLogo(boolean generate)
```
    Description copied from interface: PayaraMicroBoot
    
    Set whether the logo should be generated on boot
    
    Specified by:
    
    setPrintLogo in interface PayaraMicroBoot
    
    Returns:
  - setRootDir
```
public PayaraMicro setRootDir(File rootDir)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the File path to a directory PayaraMicro should use to install its configuration files. If this is set the PayaraMicro configuration files will be stored in the directory and persist across server restarts. If this is not set the configuration files are created in a temporary location and not persisted across server restarts.
    
    Specified by:
    
    setRootDir in interface PayaraMicroBoot
    
    Parameters:
    
    rootDir - Path to a valid directory
    
    Returns:
    
    Returns the PayaraMicro instance
  - setSslAutoBind
```
public PayaraMicro setSslAutoBind(boolean sslAutoBind)
```
    Description copied from interface: PayaraMicroBoot
    
    Enables or disables autobinding of the HTTPS port
    
    Specified by:
    
    setSslAutoBind in interface PayaraMicroBoot
    
    Parameters:
    
    sslAutoBind - The true or false value to enable or disable HTTPS autobinding
    
    Returns:
  - setSslPort
```
public PayaraMicro setSslPort(int sslPort)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the configured port for HTTPS requests. If this is not set HTTPS is disabled
    
    Specified by:
    
    setSslPort in interface PayaraMicroBoot
    
    Parameters:
    
    sslPort - The HTTPS port
    
    Returns:
  - setSslCert
```
public PayaraMicro setSslCert(String alias)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets the name of the certificate to use in the keystore
    
    Specified by:
    
    setSslCert in interface PayaraMicroBoot
    
    Parameters:
    
    alias - the name of the certificate in the keystore
    
    Returns:
  - setUserLogFile
```
public PayaraMicro setUserLogFile(String fileName)
```
    Description copied from interface: PayaraMicroBoot
    
    Set user defined file for the Log entries
    
    Specified by:
    
    setUserLogFile in interface PayaraMicroBoot
    
    Returns:
  - setSniEnabled
```
public PayaraMicro setSniEnabled(boolean value)
```
    Description copied from interface: PayaraMicroBoot
    
    Sets whether SNI enabled for SSL
    
    Specified by:
    
    setSniEnabled in interface PayaraMicroBoot
    
    Parameters:
    
    value - true to enable SNI
    
    Returns:
  - shutdown
```
public void shutdown()
              throws BootstrapException
```
    Description copied from interface: PayaraMicroBoot
    
    Stops and then shutsdown the Payara Micro Server
    
    Specified by:
    
    shutdown in interface PayaraMicroBoot
    
    Throws:
    
    BootstrapException
  - setThreadBootstrapLoader
```
public ClassLoader setThreadBootstrapLoader()
```
  - main
```
public static void main(String... args)
```
  - addLibrary
```
public PayaraMicro addLibrary(File lib)
```
    Adds the library to the classloader and loads it
    
    Specified by:
    
    addLibrary in interface PayaraMicroBoot
    
    Parameters:
    
    lib - The URL or filepath of the library to add
    
    Returns:
    
    Since:
    
    4.1.2.173

Class PayaraMicro

Method Summary

Methods inherited from class java.lang.Object

Method Detail

unpackJars

setUpackedJarDir

getInstance

bootstrap

getInstance

addDeployFromGAV

addDeployment

addDeploymentFile

addRepoUrl

bootStrap

getAlternateDomainXML

getAutoBindRange

getClusterMulticastGroup

getClusterPort

getClusterStartPort

getDeploymentDir

getHttpAutoBind

getHttpPort

getHzClusterName

getInstanceName

getMaxHttpThreads

getMinHttpThreads

getRootDir

getRuntime

getSslAutoBind

getSslPort

getSslCert

getUberJar

isLite

isNoCluster

setAccessLogDir

setAccessLogFormat

setAlternateDomainXML

setApplicationDomainXML

setPreBootHandler

setPostBootHandler

setAutoBindRange

setClusterMulticastGroup

setClusterPort

setClusterStartPort

setDeploymentDir

setHttpAutoBind

setHttpPort

setHzClusterName

getInstanceGroup

setInstanceGroup

setInstanceName

setLite

setLogPropertiesFile

setLogoFile

setMaxHttpThreads

setMinHttpThreads

setNoCluster

setPrintLogo

setRootDir

setSslAutoBind

setSslPort

setSslCert

setUserLogFile

setSniEnabled

shutdown

setThreadBootstrapLoader

main

addLibrary