PayaraMicro (Payara Project 5.184 API)

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

```
public class PayaraMicro
extends Object
```
Author:

steve

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PayaraMicro`	`addDeployFromGAV(String GAV)`
`PayaraMicro`	`addDeployment(String pathToWar)`
`PayaraMicro`	`addDeploymentFile(File file)`
`PayaraMicro`	`addLibrary(File lib)` Adds the library to the classloader and loads it
`PayaraMicro`	`addRepoUrl(String... URLs)`
`static PayaraMicroRuntime`	`bootstrap()` Bootstraps the PayaraMicroRuntime with all defaults and no additional configuration.
`PayaraMicroRuntime`	`bootStrap()`
`File`	`getAlternateDomainXML()`
`int`	`getAutoBindRange()`
`String`	`getClusterMulticastGroup()`
`int`	`getClusterPort()`
`int`	`getClusterStartPort()`
`File`	`getDeploymentDir()`
`boolean`	`getHttpAutoBind()`
`int`	`getHttpPort()`
`String`	`getHzClusterName()`
`String`	`getHzClusterPassword()`
`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()`
`int`	`getMaxHttpThreads()`
`int`	`getMinHttpThreads()`
`File`	`getRootDir()`
`PayaraMicroRuntime`	`getRuntime()`
`boolean`	`getSslAutoBind()`
`String`	`getSslCert()`
`int`	`getSslPort()`
`File`	`getUberJar()`
`boolean`	`isLite()`
`boolean`	`isNoCluster()`
`static void`	`main(String... args)`
`PayaraMicro`	`setAccessLogDir(String filePath)`
`PayaraMicro`	`setAccessLogFormat(String format)`
`PayaraMicro`	`setAlternateDomainXML(File alternateDomainXML)`
`PayaraMicro`	`setApplicationDomainXML(String domainXml)`
`PayaraMicro`	`setAutoBindRange(int autoBindRange)`
`PayaraMicro`	`setClusterMulticastGroup(String hzMulticastGroup)`
`PayaraMicro`	`setClusterPort(int hzPort)`
`PayaraMicro`	`setClusterStartPort(int hzStartPort)`
`PayaraMicro`	`setDeploymentDir(File deploymentRoot)`
`PayaraMicro`	`setHttpAutoBind(boolean httpAutoBind)`
`PayaraMicro`	`setHttpPort(int httpPort)`
`PayaraMicro`	`setHzClusterName(String hzClusterName)`
`PayaraMicro`	`setHzClusterPassword(String hzClusterPassword)`
`PayaraMicro`	`setInstanceGroup(String instanceGroup)` Sets the instance group name
`PayaraMicro`	`setInstanceName(String instanceName)`
`PayaraMicro`	`setLite(boolean liteMember)`
`PayaraMicro`	`setLogoFile(String filePath)`
`PayaraMicro`	`setLogPropertiesFile(File fileName)`
`PayaraMicro`	`setMaxHttpThreads(int maxHttpThreads)`
`PayaraMicro`	`setMinHttpThreads(int minHttpThreads)`
`PayaraMicro`	`setNoCluster(boolean noCluster)`
`PayaraMicro`	`setPrintLogo(boolean generate)`
`PayaraMicro`	`setRootDir(File rootDir)`
`PayaraMicro`	`setSniEnabled(boolean value)`
`PayaraMicro`	`setSslAutoBind(boolean sslAutoBind)`
`PayaraMicro`	`setSslCert(String alias)`
`PayaraMicro`	`setSslPort(int sslPort)`
`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)`
`void`	`shutdown()`
`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)

addDeployment

public PayaraMicro addDeployment(String pathToWar)

addDeploymentFile

public PayaraMicro addDeploymentFile(File file)

addRepoUrl

public PayaraMicro addRepoUrl(String... URLs)

bootStrap

public PayaraMicroRuntime bootStrap()
                             throws BootstrapException

Throws:: BootstrapException

getAlternateDomainXML
```
public File getAlternateDomainXML()
```

getAutoBindRange
```
public int getAutoBindRange()
```

getClusterMulticastGroup

public String getClusterMulticastGroup()

getClusterPort
```
public int getClusterPort()
```

getClusterStartPort
```
public int getClusterStartPort()
```

getDeploymentDir
```
public File getDeploymentDir()
```

getHttpAutoBind
```
public boolean getHttpAutoBind()
```

getHttpPort
```
public int getHttpPort()
```

getHzClusterName
```
public String getHzClusterName()
```

getHzClusterPassword
```
public String getHzClusterPassword()
```

getInstanceName
```
public String getInstanceName()
```

getMaxHttpThreads
```
public int getMaxHttpThreads()
```

getMinHttpThreads
```
public int getMinHttpThreads()
```

getRootDir
```
public File getRootDir()
```

getRuntime

public PayaraMicroRuntime getRuntime()
                              throws IllegalStateException

Throws:: IllegalStateException

getSslAutoBind
```
public boolean getSslAutoBind()
```

getSslPort
```
public int getSslPort()
```

getSslCert
```
public String getSslCert()
```

getUberJar
```
public File getUberJar()
```

isLite
```
public boolean isLite()
```

isNoCluster
```
public boolean isNoCluster()
```

setAccessLogDir

public PayaraMicro setAccessLogDir(String filePath)

setAccessLogFormat

public PayaraMicro setAccessLogFormat(String format)

setAlternateDomainXML

public PayaraMicro setAlternateDomainXML(File alternateDomainXML)

setApplicationDomainXML

public PayaraMicro setApplicationDomainXML(String domainXml)

setAutoBindRange

public PayaraMicro setAutoBindRange(int autoBindRange)

setClusterMulticastGroup

public PayaraMicro setClusterMulticastGroup(String hzMulticastGroup)

setClusterPort

public PayaraMicro setClusterPort(int hzPort)

setClusterStartPort

public PayaraMicro setClusterStartPort(int hzStartPort)

setDeploymentDir

public PayaraMicro setDeploymentDir(File deploymentRoot)

setHttpAutoBind

public PayaraMicro setHttpAutoBind(boolean httpAutoBind)

setHttpPort

public PayaraMicro setHttpPort(int httpPort)

setHzClusterName

public PayaraMicro setHzClusterName(String hzClusterName)

setHzClusterPassword

public PayaraMicro setHzClusterPassword(String hzClusterPassword)

getInstanceGroup
```
public String getInstanceGroup()
```
Gets the name of the instance group

Returns:

The name of the instance group

setInstanceGroup
```
public PayaraMicro setInstanceGroup(String instanceGroup)
```
Sets the instance group name

Parameters:

instanceGroup - The instance group name

Returns:

setInstanceName

public PayaraMicro setInstanceName(String instanceName)

setLite

public PayaraMicro setLite(boolean liteMember)

setLogPropertiesFile

public PayaraMicro setLogPropertiesFile(File fileName)

setLogoFile

public PayaraMicro setLogoFile(String filePath)

setMaxHttpThreads

public PayaraMicro setMaxHttpThreads(int maxHttpThreads)

setMinHttpThreads

public PayaraMicro setMinHttpThreads(int minHttpThreads)

setNoCluster

public PayaraMicro setNoCluster(boolean noCluster)

setPrintLogo

public PayaraMicro setPrintLogo(boolean generate)

setRootDir

public PayaraMicro setRootDir(File rootDir)

setSslAutoBind

public PayaraMicro setSslAutoBind(boolean sslAutoBind)

setSslPort

public PayaraMicro setSslPort(int sslPort)

setSslCert

public PayaraMicro setSslCert(String alias)

setUserLogFile

public PayaraMicro setUserLogFile(String fileName)

setSniEnabled

public PayaraMicro setSniEnabled(boolean value)

shutdown

public void shutdown()
              throws BootstrapException

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

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

getHzClusterPassword

getInstanceName

getMaxHttpThreads

getMinHttpThreads

getRootDir

getRuntime

getSslAutoBind

getSslPort

getSslCert

getUberJar

isLite

isNoCluster

setAccessLogDir

setAccessLogFormat

setAlternateDomainXML

setApplicationDomainXML

setAutoBindRange

setClusterMulticastGroup

setClusterPort

setClusterStartPort

setDeploymentDir

setHttpAutoBind

setHttpPort

setHzClusterName

setHzClusterPassword

getInstanceGroup

setInstanceGroup

setInstanceName

setLite

setLogPropertiesFile

setLogoFile

setMaxHttpThreads

setMinHttpThreads

setNoCluster

setPrintLogo

setRootDir

setSslAutoBind

setSslPort

setSslCert

setUserLogFile

setSniEnabled

shutdown

setThreadBootstrapLoader

main

addLibrary