public class PayaraMicroImpl extends Object implements PayaraMicroBoot
| Modifier and Type | Method and Description |
|---|---|
PayaraMicroImpl |
addDeployFromGAV(String GAV)
Adds a Maven GAV coordinate to the list of archives to be deployed at
boot.
|
PayaraMicroImpl |
addDeployment(String pathToWar)
Adds an archive to the list of archives to be deployed at boot.
|
PayaraMicroImpl |
addDeploymentFile(File file)
Adds an archive to the list of archives to be deployed at boot.
|
void |
addLibrary(File lib)
Adds the library to the classloader and loads it
|
PayaraMicroImpl |
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.
|
String |
getHzClusterPassword()
Gets the password of the Hazelcast cluster group
|
static PayaraMicroImpl |
getInstance()
Obtains the static singleton instance of the Payara Micro Server.
|
static PayaraMicroImpl |
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
|
PayaraMicroRuntimeImpl |
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
|
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)
Runs a Payara Micro server used via java -jar payara-micro.jar
|
void |
setAccessLogDir(String filePath)
Set user defined file directory for the access log
|
void |
setAccessLogFormat(String format)
Set user defined formatting for the access log
|
PayaraMicroImpl |
setAlternateDomainXML(File alternateDomainXML)
Sets the path to a domain.xml file PayaraMicro should use to boot.
|
PayaraMicroImpl |
setApplicationDomainXML(String domainXml)
Sets an application specific domain.xml file that is embedded on the
classpath of your application.
|
PayaraMicroImpl |
setAutoBindRange(int autoBindRange)
Sets the maximum number of ports to check if free for autobinding
purposes
|
PayaraMicroImpl |
setClusterMulticastGroup(String hzMulticastGroup)
Sets the cluster group used for Payara Micro clustering used for cluster
communications and discovery.
|
PayaraMicroImpl |
setClusterPort(int hzPort)
Sets the multicast group used for Payara Micro clustering used for
cluster communication and discovery.
|
PayaraMicroImpl |
setClusterStartPort(int hzStartPort)
Sets the start port number for the Payara Micro to listen on for cluster
communications.
|
PayaraMicroImpl |
setDeploymentDir(File deploymentRoot)
Sets a directory to scan for archives to deploy on boot.
|
PayaraMicroImpl |
setHttpAutoBind(boolean httpAutoBind)
Enables or disables autobinding of the HTTP port
|
PayaraMicroImpl |
setHttpPort(int httpPort)
Sets the port used for HTTP requests
|
PayaraMicroImpl |
setHzClusterName(String hzClusterName)
Sets the name of the Hazelcast cluster group
|
PayaraMicroImpl |
setHzClusterPassword(String hzClusterPassword)
Sets the Hazelcast cluster group password.
|
PayaraMicroImpl |
setInstanceGroup(String instanceGroup)
Sets the instance group name
|
PayaraMicroImpl |
setInstanceName(String instanceName)
Sets the logical instance name for this PayaraMicro server within the
server cluster If this is not set a name is generated
|
PayaraMicroImpl |
setLite(boolean liteMember)
Sets the lite status of this cluster member.
|
PayaraMicroImpl |
setLogoFile(String filePath)
Sets the path to the logo file printed at boot.
|
PayaraMicroImpl |
setLogPropertiesFile(File fileName)
Set user defined properties file for logging
|
PayaraMicroImpl |
setMaxHttpThreads(int maxHttpThreads)
The maximum threads in the HTTP(S) threadpool processing HTTP(S)
requests.
|
PayaraMicroImpl |
setMinHttpThreads(int minHttpThreads)
The minimum number of threads in the HTTP(S) threadpool Default value is
10
|
PayaraMicroImpl |
setNoCluster(boolean noCluster)
Enables or disables clustering before bootstrap
|
PayaraMicroImpl |
setPrintLogo(boolean generate)
Set whether the logo should be generated on boot
|
PayaraMicroImpl |
setRootDir(File rootDir)
Sets the File path to a directory PayaraMicro should use to install its
configuration files.
|
PayaraMicroImpl |
setSslAutoBind(boolean sslAutoBind)
Enables or disables autobinding of the HTTPS port
|
PayaraMicroImpl |
setSslPort(int sslPort)
Sets the configured port for HTTPS requests.
|
PayaraMicroImpl |
setUserLogFile(String fileName)
Set user defined file for the Log entries
|
void |
shutdown()
Stops and then shutsdown the Payara Micro Server
|
public static void main(String[] args) throws Exception
args - Command line arguments for PayaraMicro Usage: --help to see
all the options
BootstrapException - If there is a problem booting the serverExceptionpublic static PayaraMicroImpl getInstance()
public static PayaraMicroRuntime bootstrap() throws BootstrapException
BootstrapExceptionpublic static PayaraMicroImpl getInstance(boolean create)
create - If false the instance won't be created if it has not been
initialisedpublic String getClusterMulticastGroup()
getClusterMulticastGroup in interface PayaraMicroBootpublic PayaraMicroImpl setClusterMulticastGroup(String hzMulticastGroup)
setClusterMulticastGroup in interface PayaraMicroBoothzMulticastGroup - String representation of the multicast grouppublic PayaraMicroImpl setLogoFile(String filePath)
setLogoFile in interface PayaraMicroBootfilePath - public PayaraMicroImpl setPrintLogo(boolean generate)
setPrintLogo in interface PayaraMicroBootgenerate - public PayaraMicroImpl setUserLogFile(String fileName)
setUserLogFile in interface PayaraMicroBootfileName - public PayaraMicroImpl setLogPropertiesFile(File fileName)
setLogPropertiesFile in interface PayaraMicroBootfileName - public void setAccessLogDir(String filePath)
setAccessLogDir in interface PayaraMicroBootfilePath - public void setAccessLogFormat(String format)
setAccessLogFormat in interface PayaraMicroBootformat - public int getClusterPort()
getClusterPort in interface PayaraMicroBootpublic PayaraMicroImpl setClusterPort(int hzPort)
setClusterPort in interface PayaraMicroBoothzPort - The port numberpublic int getClusterStartPort()
getClusterStartPort in interface PayaraMicroBootpublic PayaraMicroImpl setClusterStartPort(int hzStartPort)
setClusterStartPort in interface PayaraMicroBoothzStartPort - Start port numberpublic int getHttpPort()
getHttpPort in interface PayaraMicroBootpublic PayaraMicroImpl setHttpPort(int httpPort)
setHttpPort in interface PayaraMicroBoothttpPort - The port numberpublic int getSslPort()
getSslPort in interface PayaraMicroBootpublic File getUberJar()
getUberJar in interface PayaraMicroBootpublic PayaraMicroImpl setSslPort(int sslPort)
setSslPort in interface PayaraMicroBootsslPort - The HTTPS portpublic String getInstanceName()
getInstanceName in interface PayaraMicroBootpublic PayaraMicroImpl setInstanceName(String instanceName)
setInstanceName in interface PayaraMicroBootinstanceName - The logical server namepublic File getDeploymentDir()
getDeploymentDir in interface PayaraMicroBootpublic PayaraMicroImpl setDeploymentDir(File deploymentRoot)
setDeploymentDir in interface PayaraMicroBootdeploymentRoot - File path to the directorypublic File getAlternateDomainXML()
getAlternateDomainXML in interface PayaraMicroBootpublic PayaraMicroImpl setApplicationDomainXML(String domainXml)
setApplicationDomainXML in interface PayaraMicroBootdomainXml - This is a resource string for your domain.xmlpublic PayaraMicroImpl setAlternateDomainXML(File alternateDomainXML)
setAlternateDomainXML in interface PayaraMicroBootalternateDomainXML - public PayaraMicroImpl addDeployment(String pathToWar)
addDeployment in interface PayaraMicroBootpathToWar - File path to the deployment archivepublic PayaraMicroImpl addDeploymentFile(File file)
addDeploymentFile in interface PayaraMicroBootfile - File path to the deployment archivepublic PayaraMicroImpl addDeployFromGAV(String GAV)
addDeployFromGAV in interface PayaraMicroBootGAV - GAV coordinatepublic PayaraMicroImpl addRepoUrl(String... URLs)
addRepoUrl in interface PayaraMicroBootURLs - URL to Maven repositorypublic boolean isNoCluster()
isNoCluster in interface PayaraMicroBootpublic PayaraMicroImpl setNoCluster(boolean noCluster)
setNoCluster in interface PayaraMicroBootnoCluster - set to true to disable clusteringpublic boolean isLite()
isLite in interface PayaraMicroBootpublic PayaraMicroImpl setLite(boolean liteMember)
setLite in interface PayaraMicroBootliteMember - set to true to set as a lite cluster member with no
data storagepublic int getMaxHttpThreads()
getMaxHttpThreads in interface PayaraMicroBootpublic PayaraMicroImpl setMaxHttpThreads(int maxHttpThreads)
setMaxHttpThreads in interface PayaraMicroBootmaxHttpThreads - Maximum threads in the HTTP(S) threadpoolpublic int getMinHttpThreads()
getMinHttpThreads in interface PayaraMicroBootpublic PayaraMicroImpl setMinHttpThreads(int minHttpThreads)
setMinHttpThreads in interface PayaraMicroBootminHttpThreads - public File getRootDir()
getRootDir in interface PayaraMicroBootpublic PayaraMicroImpl setRootDir(File rootDir)
setRootDir in interface PayaraMicroBootrootDir - Path to a valid directorypublic boolean getHttpAutoBind()
getHttpAutoBind in interface PayaraMicroBootpublic PayaraMicroImpl setHttpAutoBind(boolean httpAutoBind)
setHttpAutoBind in interface PayaraMicroBoothttpAutoBind - The true or false value to enable or disable HTTP
autobindingpublic boolean getSslAutoBind()
getSslAutoBind in interface PayaraMicroBootpublic PayaraMicroImpl setSslAutoBind(boolean sslAutoBind)
setSslAutoBind in interface PayaraMicroBootsslAutoBind - The true or false value to enable or disable HTTPS
autobindingpublic int getAutoBindRange()
getAutoBindRange in interface PayaraMicroBootpublic PayaraMicroImpl setAutoBindRange(int autoBindRange)
setAutoBindRange in interface PayaraMicroBootautoBindRange - The maximum number of ports to increment the port
value bypublic String getHzClusterName()
getHzClusterName in interface PayaraMicroBootpublic PayaraMicroImpl setHzClusterName(String hzClusterName)
setHzClusterName in interface PayaraMicroBoothzClusterName - The name of the hazelcast clusterpublic String getHzClusterPassword()
getHzClusterPassword in interface PayaraMicroBootpublic PayaraMicroImpl setHzClusterPassword(String hzClusterPassword)
setHzClusterPassword in interface PayaraMicroBoothzClusterPassword - The password to setpublic String getInstanceGroup()
getInstanceGroup in interface PayaraMicroBootpublic PayaraMicroImpl setInstanceGroup(String instanceGroup)
setInstanceGroup in interface PayaraMicroBootinstanceGroup - The instance group namepublic PayaraMicroRuntime bootStrap() throws BootstrapException
bootStrap in interface PayaraMicroBootBootstrapExceptionpublic PayaraMicroRuntimeImpl getRuntime() throws IllegalStateException
getRuntime in interface PayaraMicroBootIllegalStateExceptionpublic void shutdown()
throws BootstrapException
shutdown in interface PayaraMicroBootBootstrapExceptionpublic void addLibrary(File lib)
PayaraMicroBootaddLibrary in interface PayaraMicroBootlib - The library to addCopyright © 2017. All rights reserved.