public class PayaraMicro extends Object implements PayaraMicroBoot
| 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.
|
String |
getHzClusterPassword()
Gets the password 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 |
setHzClusterPassword(String hzClusterPassword)
Sets the Hazelcast cluster group password.
|
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
|
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
|
public static void unpackJars()
public static void setUpackedJarDir(File file)
file - public static PayaraMicro getInstance()
public static PayaraMicroRuntime bootstrap() throws BootstrapException
BootstrapExceptionpublic static PayaraMicro getInstance(boolean create)
create - If false the instance won't be created if it has not been
initialisedpublic PayaraMicro addDeployFromGAV(String GAV)
PayaraMicroBootaddDeployFromGAV in interface PayaraMicroBootGAV - GAV coordinatepublic PayaraMicro addDeployment(String pathToWar)
PayaraMicroBootaddDeployment in interface PayaraMicroBootpathToWar - File path to the deployment archivepublic PayaraMicro addDeploymentFile(File file)
PayaraMicroBootaddDeploymentFile in interface PayaraMicroBootfile - File path to the deployment archivepublic PayaraMicro addRepoUrl(String... URLs)
PayaraMicroBootaddRepoUrl in interface PayaraMicroBootURLs - URL to Maven repositorypublic PayaraMicroRuntime bootStrap() throws BootstrapException
PayaraMicroBootbootStrap in interface PayaraMicroBootBootstrapExceptionpublic File getAlternateDomainXML()
PayaraMicroBootgetAlternateDomainXML in interface PayaraMicroBootpublic int getAutoBindRange()
PayaraMicroBootgetAutoBindRange in interface PayaraMicroBootpublic String getClusterMulticastGroup()
PayaraMicroBootgetClusterMulticastGroup in interface PayaraMicroBootpublic int getClusterPort()
PayaraMicroBootgetClusterPort in interface PayaraMicroBootpublic int getClusterStartPort()
PayaraMicroBootgetClusterStartPort in interface PayaraMicroBootpublic File getDeploymentDir()
PayaraMicroBootgetDeploymentDir in interface PayaraMicroBootpublic boolean getHttpAutoBind()
PayaraMicroBootgetHttpAutoBind in interface PayaraMicroBootpublic int getHttpPort()
PayaraMicroBootgetHttpPort in interface PayaraMicroBootpublic String getHzClusterName()
PayaraMicroBootgetHzClusterName in interface PayaraMicroBootpublic String getHzClusterPassword()
PayaraMicroBootgetHzClusterPassword in interface PayaraMicroBootpublic String getInstanceName()
PayaraMicroBootgetInstanceName in interface PayaraMicroBootpublic int getMaxHttpThreads()
PayaraMicroBootgetMaxHttpThreads in interface PayaraMicroBootpublic int getMinHttpThreads()
PayaraMicroBootgetMinHttpThreads in interface PayaraMicroBootpublic File getRootDir()
PayaraMicroBootgetRootDir in interface PayaraMicroBootpublic PayaraMicroRuntime getRuntime() throws IllegalStateException
PayaraMicroBootgetRuntime in interface PayaraMicroBootIllegalStateExceptionpublic boolean getSslAutoBind()
PayaraMicroBootgetSslAutoBind in interface PayaraMicroBootpublic int getSslPort()
PayaraMicroBootgetSslPort in interface PayaraMicroBootpublic String getSslCert()
PayaraMicroBootgetSslCert in interface PayaraMicroBootpublic File getUberJar()
PayaraMicroBootgetUberJar in interface PayaraMicroBootpublic boolean isLite()
PayaraMicroBootisLite in interface PayaraMicroBootpublic boolean isNoCluster()
PayaraMicroBootisNoCluster in interface PayaraMicroBootpublic PayaraMicro setAccessLogDir(String filePath)
PayaraMicroBootsetAccessLogDir in interface PayaraMicroBootpublic PayaraMicro setAccessLogFormat(String format)
PayaraMicroBootsetAccessLogFormat in interface PayaraMicroBootpublic PayaraMicro setAlternateDomainXML(File alternateDomainXML)
PayaraMicroBootsetAlternateDomainXML in interface PayaraMicroBootpublic PayaraMicro setApplicationDomainXML(String domainXml)
PayaraMicroBootsetApplicationDomainXML in interface PayaraMicroBootdomainXml - This is a resource string for your domain.xmlpublic PayaraMicro setAutoBindRange(int autoBindRange)
PayaraMicroBootsetAutoBindRange in interface PayaraMicroBootautoBindRange - The maximum number of ports to increment the port
value bypublic PayaraMicro setClusterMulticastGroup(String hzMulticastGroup)
PayaraMicroBootsetClusterMulticastGroup in interface PayaraMicroBoothzMulticastGroup - String representation of the multicast grouppublic PayaraMicro setClusterPort(int hzPort)
PayaraMicroBootsetClusterPort in interface PayaraMicroBoothzPort - The port numberpublic PayaraMicro setClusterStartPort(int hzStartPort)
PayaraMicroBootsetClusterStartPort in interface PayaraMicroBoothzStartPort - Start port numberpublic PayaraMicro setDeploymentDir(File deploymentRoot)
PayaraMicroBootsetDeploymentDir in interface PayaraMicroBootdeploymentRoot - File path to the directorypublic PayaraMicro setHttpAutoBind(boolean httpAutoBind)
PayaraMicroBootsetHttpAutoBind in interface PayaraMicroBoothttpAutoBind - The true or false value to enable or disable HTTP
autobindingpublic PayaraMicro setHttpPort(int httpPort)
PayaraMicroBootsetHttpPort in interface PayaraMicroBoothttpPort - The port numberpublic PayaraMicro setHzClusterName(String hzClusterName)
PayaraMicroBootsetHzClusterName in interface PayaraMicroBoothzClusterName - The name of the hazelcast clusterpublic PayaraMicro setHzClusterPassword(String hzClusterPassword)
PayaraMicroBootsetHzClusterPassword in interface PayaraMicroBoothzClusterPassword - The password to setpublic String getInstanceGroup()
getInstanceGroup in interface PayaraMicroBootpublic PayaraMicro setInstanceGroup(String instanceGroup)
setInstanceGroup in interface PayaraMicroBootinstanceGroup - The instance group namepublic PayaraMicro setInstanceName(String instanceName)
PayaraMicroBootsetInstanceName in interface PayaraMicroBootinstanceName - The logical server namepublic PayaraMicro setLite(boolean liteMember)
PayaraMicroBootsetLite in interface PayaraMicroBootliteMember - set to true to set as a lite cluster member with no
data storagepublic PayaraMicro setLogPropertiesFile(File fileName)
PayaraMicroBootsetLogPropertiesFile in interface PayaraMicroBootpublic PayaraMicro setLogoFile(String filePath)
PayaraMicroBootsetLogoFile in interface PayaraMicroBootpublic PayaraMicro setMaxHttpThreads(int maxHttpThreads)
PayaraMicroBootsetMaxHttpThreads in interface PayaraMicroBootmaxHttpThreads - Maximum threads in the HTTP(S) threadpoolpublic PayaraMicro setMinHttpThreads(int minHttpThreads)
PayaraMicroBootsetMinHttpThreads in interface PayaraMicroBootpublic PayaraMicro setNoCluster(boolean noCluster)
PayaraMicroBootsetNoCluster in interface PayaraMicroBootnoCluster - set to true to disable clusteringpublic PayaraMicro setPrintLogo(boolean generate)
PayaraMicroBootsetPrintLogo in interface PayaraMicroBootpublic PayaraMicro setRootDir(File rootDir)
PayaraMicroBootsetRootDir in interface PayaraMicroBootrootDir - Path to a valid directorypublic PayaraMicro setSslAutoBind(boolean sslAutoBind)
PayaraMicroBootsetSslAutoBind in interface PayaraMicroBootsslAutoBind - The true or false value to enable or disable HTTPS
autobindingpublic PayaraMicro setSslPort(int sslPort)
PayaraMicroBootsetSslPort in interface PayaraMicroBootsslPort - The HTTPS portpublic PayaraMicro setSslCert(String alias)
PayaraMicroBootsetSslCert in interface PayaraMicroBootalias - the name of the certificate in the keystorepublic PayaraMicro setUserLogFile(String fileName)
PayaraMicroBootsetUserLogFile in interface PayaraMicroBootpublic PayaraMicro setSniEnabled(boolean value)
PayaraMicroBootsetSniEnabled in interface PayaraMicroBootvalue - true to enable SNIpublic void shutdown()
throws BootstrapException
PayaraMicroBootshutdown in interface PayaraMicroBootBootstrapExceptionpublic ClassLoader setThreadBootstrapLoader()
public static void main(String... args)
public PayaraMicro addLibrary(File lib)
addLibrary in interface PayaraMicroBootlib - The URL or filepath of the library to addCopyright © 2019. All rights reserved.