UndertowConfig (jfinal-undertow 3.0 API)

java.lang.Object
- com.jfinal.server.undertow.UndertowConfig

public class UndertowConfig
extends Object

UndertowConfig

字段概要

字段
限定符和类型	字段和说明
`protected ClassLoaderKit`	`classLoaderKit`
`protected String[]`	`classPathDirs`
`protected String`	`contextPath`
`protected static boolean`	`devMode`
`protected boolean`	`gzipEnable`
`protected int`	`gzipLevel`
`protected int`	`gzipMinLength`
`protected String`	`host`
`protected String`	`hotSwapClassPrefix`
`protected HotSwapResolver`	`hotSwapResolver`
`protected Boolean`	`http2Enable`
`protected boolean`	`httpDisable`
`protected boolean`	`httpToHttps`
`protected int`	`httpToHttpsStatusCode`
`protected Integer`	`ioThreads`
`protected String`	`jfinalConfig`
`protected PropExt`	`p`
`protected int`	`port`
`protected String`	`resourcePath`
`protected String`	`serverName`
`protected boolean`	`sessionHotSwap`
`protected Integer`	`sessionTimeout`
`protected SslConfig`	`sslConfig`
`protected Integer`	`workerThreads`

构造器概要

构造器
构造器和说明
`UndertowConfig(Class<?> jfinalConfigClass)` 尝试加载默认配置文件 "undertow.txt" 与 "undertow-pro.txt" 初始化 UndertowConfig，这两个配置文件不存在时不抛出异常
`UndertowConfig(Class<?> jfinalConfigClass, String undertowConfig)` 使用指定的配置文件初始化 UndertowConfig，该配置文件不存在则抛出异常配置文件存在时还会继续尝试其生产环境配置文件，规则是： 1：当配置文件名是 abc.txt 2：生产环境配置文件是 abc-pro.txt 注意：生产环境配置文件不存在时不抛出异常，便于支持 fatjar 模式下创建 config/abc-pro.txt 文件用于配置生产环境
`UndertowConfig(String jfinalConfigClass)`
`UndertowConfig(String jfinalConfigClass, String undertowConfig)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addHotSwapClassPrefix(String prefix)`
`void`	`addSystemClassPrefix(String prefix)`
`protected Integer`	`buildIoThreads()` 优先使用外部配置文件中指定的值，当外部配置没有指定时，devMode 并且 notDeployMode 下使用更少的线程以节省时空
`protected String`	`buildUndertowConfigPro(String undertowConfig)` 假定用户创建 UndertowServer 时指定 undertow 的配置文件为 abc.txt 或者 abc-dev.txt 或者 abc_dev.txt，例如： UndertowServer.create(AppConfig.class, "abc.txt").start(); 尝试加载 abc-pro.txt 便于在 fatjar 模式下以 config 目录中通过创建 abc-pro.txt 配置文件覆盖打包在 jar 包中的 abc-dev.txt 配置
`protected Integer`	`buildWorkerThreads()`
`protected int`	`checkGzipLevel(int gzipLevel)`
`protected PropExt`	`createPropExt(String undertowConfig)`
`ClassLoader`	`getClassLoader()`
`protected ClassLoaderKit`	`getClassLoaderKit()`
`String[]`	`getClassPathDirs()` 获取存放 .class 文件的所有 classPath 目录，绝大部分场景下只有一个目录
`String`	`getContextPath()`
`int`	`getGzipLevel()`
`int`	`getGzipMinLength()`
`String`	`getHost()`
`HotSwapResolver`	`getHotSwapResolver()`
`Boolean`	`getHttp2Enable()`
`int`	`getHttpToHttpsStatusCode()`
`Integer`	`getIoThreads()`
`String`	`getJFinalConfig()` 检查 undertow.stopKey 参数合法性，为确保安全性其长度不能少于 16 个字符 protected String checkStopKey(String stopKey) { if (stopKey !
`int`	`getPort()`
`io.undertow.server.handlers.resource.ResourceManager`	`getResourceManager()`
`String`	`getResourcePath()`
`String`	`getServerName()` 在 HTTP response header 中显示的服务名，配置为 disable 时表示不启用未配置则使用默认值，例如：JFinal 4.3，否则使用配置的值注意：disable 为特殊配置，表示不启用该功能
`boolean`	`getSessionHotSwap()`
`Integer`	`getSessionTimeout()`
`SslConfig`	`getSslConfig()`
`Integer`	`getWorkerThreads()`
`protected void`	`init()`
`static boolean`	`isBlank(String str)`
`static boolean`	`isDevMode()`
`boolean`	`isGzipEnable()`
`boolean`	`isHttpDisable()`
`boolean`	`isHttpToHttps()`
`boolean`	`isSslEnable()`
`static boolean`	`notBlank(String str)`
`void`	`replaceClassLoader()`
`void`	`setContextPath(String contextPath)`
`void`	`setDevMode(boolean devMode)`
`void`	`setGzipEnable(boolean gzipEnable)`
`void`	`setGzipLevel(int gzipLevel)`
`void`	`setGzipMinLength(int gzipMinLength)`
`void`	`setHost(String host)`
`void`	`setHotSwapResolver(HotSwapResolver hotSwapResolver)`
`void`	`setHttp2Enable(boolean http2Enable)`
`void`	`setHttpDisable(boolean httpDisable)`
`void`	`setHttpToHttps(boolean httpToHttps)`
`void`	`setHttpToHttpsStatusCode(int httpToHttpsStatusCode)`
`void`	`setIoThreads(int ioThreads)`
`void`	`setPort(int port)`
`void`	`setResourcePath(String resourcePath)`
`void`	`setServerName(String serverName)`
`void`	`setSessionHotSwap(boolean sessionHotSwap)`
`void`	`setSessionTimeout(int sessionTimeout)` session 过期时间，注意单位是秒
`void`	`setSslConfig(SslConfig sslConfig)`
`void`	`setWorkerThreads(int workerThreads)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

jfinalConfig
```
protected String jfinalConfig
```

devMode

protected static volatile boolean devMode

port
```
protected int port
```

host
```
protected String host
```

contextPath
```
protected String contextPath
```

resourcePath
```
protected String resourcePath
```

ioThreads
```
protected Integer ioThreads
```

workerThreads
```
protected Integer workerThreads
```

gzipEnable
```
protected boolean gzipEnable
```

gzipLevel
```
protected int gzipLevel
```

gzipMinLength
```
protected int gzipMinLength
```

http2Enable
```
protected Boolean http2Enable
```

sessionTimeout
```
protected Integer sessionTimeout
```

sessionHotSwap
```
protected boolean sessionHotSwap
```

hotSwapClassPrefix
```
protected String hotSwapClassPrefix
```

sslConfig
```
protected SslConfig sslConfig
```

httpToHttps
```
protected boolean httpToHttps
```

httpToHttpsStatusCode
```
protected int httpToHttpsStatusCode
```

httpDisable
```
protected boolean httpDisable
```

serverName
```
protected String serverName
```

classPathDirs
```
protected String[] classPathDirs
```

hotSwapResolver

protected HotSwapResolver hotSwapResolver

classLoaderKit

protected ClassLoaderKit classLoaderKit

p
```
protected PropExt p
```

构造器详细资料
- UndertowConfig
```
public UndertowConfig(Class<?> jfinalConfigClass)
```
  尝试加载默认配置文件 "undertow.txt" 与 "undertow-pro.txt" 初始化 UndertowConfig，这两个配置文件不存在时不抛出异常
- UndertowConfig
```
public UndertowConfig(String jfinalConfigClass)
```
- UndertowConfig
```
public UndertowConfig(Class<?> jfinalConfigClass,
                      String undertowConfig)
```
  使用指定的配置文件初始化 UndertowConfig，该配置文件不存在则抛出异常配置文件存在时还会继续尝试其生产环境配置文件，规则是： 1：当配置文件名是 abc.txt 2：生产环境配置文件是 abc-pro.txt 注意：生产环境配置文件不存在时不抛出异常，便于支持 fatjar 模式下创建 config/abc-pro.txt 文件用于配置生产环境
- UndertowConfig
```
public UndertowConfig(String jfinalConfigClass,
                      String undertowConfig)
```

方法详细资料

createPropExt

protected PropExt createPropExt(String undertowConfig)

buildUndertowConfigPro
```
protected String buildUndertowConfigPro(String undertowConfig)
```
假定用户创建 UndertowServer 时指定 undertow 的配置文件为 abc.txt 或者 abc-dev.txt 或者 abc_dev.txt，例如： UndertowServer.create(AppConfig.class, "abc.txt").start(); 尝试加载 abc-pro.txt 便于在 fatjar 模式下以 config 目录中通过创建 abc-pro.txt 配置文件覆盖打包在 jar 包中的 abc-dev.txt 配置

init
```
protected void init()
```

buildIoThreads
```
protected Integer buildIoThreads()
```
优先使用外部配置文件中指定的值，当外部配置没有指定时，devMode 并且 notDeployMode 下使用更少的线程以节省时空

buildWorkerThreads

protected Integer buildWorkerThreads()

checkGzipLevel

protected int checkGzipLevel(int gzipLevel)

isBlank

public static boolean isBlank(String str)

notBlank

public static boolean notBlank(String str)

getJFinalConfig
```
public String getJFinalConfig()
```
检查 undertow.stopKey 参数合法性，为确保安全性其长度不能少于 16 个字符 protected String checkStopKey(String stopKey) { if (stopKey != null) { stopKey = stopKey.trim(); if (stopKey.length() < 16) { throw new IllegalArgumentException("undertow.stopKey 的长度不能小于 16 个字符"); } } return stopKey; }

getResourceManager

public io.undertow.server.handlers.resource.ResourceManager getResourceManager()

getClassLoaderKit

protected ClassLoaderKit getClassLoaderKit()

getClassLoader
```
public ClassLoader getClassLoader()
```

replaceClassLoader
```
public void replaceClassLoader()
```

getHotSwapResolver

public HotSwapResolver getHotSwapResolver()

setHotSwapResolver

public void setHotSwapResolver(HotSwapResolver hotSwapResolver)

addSystemClassPrefix

public void addSystemClassPrefix(String prefix)

addHotSwapClassPrefix

public void addHotSwapClassPrefix(String prefix)

getClassPathDirs
```
public String[] getClassPathDirs()
```
获取存放 .class 文件的所有 classPath 目录，绝大部分场景下只有一个目录

setDevMode

public void setDevMode(boolean devMode)

isDevMode
```
public static boolean isDevMode()
```

setPort
```
public void setPort(int port)
```

getPort
```
public int getPort()
```

setContextPath

public void setContextPath(String contextPath)

getContextPath
```
public String getContextPath()
```

setResourcePath

public void setResourcePath(String resourcePath)

getResourcePath
```
public String getResourcePath()
```

setHost
```
public void setHost(String host)
```

getHost
```
public String getHost()
```

setIoThreads

public void setIoThreads(int ioThreads)

getIoThreads
```
public Integer getIoThreads()
```

setWorkerThreads

public void setWorkerThreads(int workerThreads)

getWorkerThreads
```
public Integer getWorkerThreads()
```

setGzipEnable

public void setGzipEnable(boolean gzipEnable)

isGzipEnable
```
public boolean isGzipEnable()
```

setGzipLevel

public void setGzipLevel(int gzipLevel)

getGzipLevel
```
public int getGzipLevel()
```

setGzipMinLength

public void setGzipMinLength(int gzipMinLength)

getGzipMinLength
```
public int getGzipMinLength()
```

setHttp2Enable

public void setHttp2Enable(boolean http2Enable)

getHttp2Enable
```
public Boolean getHttp2Enable()
```

setSessionTimeout
```
public void setSessionTimeout(int sessionTimeout)
```
session 过期时间，注意单位是秒

getSessionTimeout
```
public Integer getSessionTimeout()
```

setSessionHotSwap

public void setSessionHotSwap(boolean sessionHotSwap)

getSessionHotSwap
```
public boolean getSessionHotSwap()
```

isSslEnable
```
public boolean isSslEnable()
```

getSslConfig
```
public SslConfig getSslConfig()
```

setSslConfig

public void setSslConfig(SslConfig sslConfig)

setHttpToHttps

public void setHttpToHttps(boolean httpToHttps)

isHttpToHttps
```
public boolean isHttpToHttps()
```

setHttpToHttpsStatusCode

public void setHttpToHttpsStatusCode(int httpToHttpsStatusCode)

getHttpToHttpsStatusCode
```
public int getHttpToHttpsStatusCode()
```

setHttpDisable

public void setHttpDisable(boolean httpDisable)

isHttpDisable
```
public boolean isHttpDisable()
```

setServerName

public void setServerName(String serverName)

getServerName
```
public String getServerName()
```
在 HTTP response header 中显示的服务名，配置为 disable 时表示不启用未配置则使用默认值，例如：JFinal 4.3，否则使用配置的值注意：disable 为特殊配置，表示不启用该功能

类 UndertowConfig

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

jfinalConfig

devMode

port

host

contextPath

resourcePath

ioThreads

workerThreads

gzipEnable

gzipLevel

gzipMinLength

http2Enable

sessionTimeout

sessionHotSwap

hotSwapClassPrefix

sslConfig

httpToHttps

httpToHttpsStatusCode

httpDisable

serverName

classPathDirs

hotSwapResolver

classLoaderKit

p

构造器详细资料

UndertowConfig

UndertowConfig

UndertowConfig

UndertowConfig

方法详细资料

createPropExt

buildUndertowConfigPro

init

buildIoThreads

buildWorkerThreads

checkGzipLevel

isBlank

notBlank

getJFinalConfig

getResourceManager

getClassLoaderKit

getClassLoader

replaceClassLoader

getHotSwapResolver

setHotSwapResolver

addSystemClassPrefix

addHotSwapClassPrefix

getClassPathDirs

setDevMode

isDevMode

setPort

getPort

setContextPath

getContextPath

setResourcePath

getResourcePath

setHost

getHost

setIoThreads

getIoThreads

setWorkerThreads

getWorkerThreads

setGzipEnable

isGzipEnable

setGzipLevel

getGzipLevel

setGzipMinLength

getGzipMinLength

setHttp2Enable

getHttp2Enable

setSessionTimeout

getSessionTimeout

setSessionHotSwap

getSessionHotSwap