Package org.summerboot.jexpress.nio.grpc

Class GRPCServerConfig

java.lang.Object

org.summerboot.jexpress.boot.config.BootConfig

org.summerboot.jexpress.nio.grpc.GRPCServerConfig

All Implemented Interfaces:

JExpressConfig

public class GRPCServerConfig
extends BootConfig

Author:

Changski Tie Zheng Zhang 张铁铮, 魏泽北, 杜旺财, 杜富贵

Nested Class Summary

Nested classes/interfaces inherited from class org.summerboot.jexpress.boot.config.BootConfig

BootConfig.ThreadingMode

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowCoreThreadTimeOut
protected boolean	autoStart
protected List<InetSocketAddress>	bindingAddresses
protected Set<String>	callerAddressFilterBlacklist
protected GeoIpUtil.CallerAddressFilterOption	CallerAddressFilterOption
protected String	callerAddressFilterRegexPrefix
protected Set<String>	callerAddressFilterWhitelist
static final GRPCServerConfig	cfg
protected static final String	FILENAME_TRUSTSTORE_4SERVER
protected static final String	ID
protected static final String	KEY_kmf_AliasKey
protected static final String	KEY_kmf_AliasPwdKey
protected static final String	KEY_kmf_key
protected static final String	KEY_kmf_StorePwdKey
protected static final String	KEY_tmf_key
protected static final String	KEY_tmf_StorePwdKey
protected KeyManagerFactory	kmf
protected boolean	prestartAllCoreThreads
protected TrustManagerFactory	tmf
protected ThreadPoolExecutor	tpe
protected int	tpeCore
protected long	tpeKeepAliveSeconds
protected int	tpeMax
protected int	tpeQueue
protected BootConfig.ThreadingMode	tpeThreadingMode

Fields inherited from class org.summerboot.jexpress.boot.config.BootConfig

BR, cache, cfgFile, configName, CPU_CORE, DEFAULT_DEC_VALUE, DESC_KMF, DESC_PLAINPWD, DESC_TMF, FILENAME_KEYSTORE, FILENAME_SRC_TRUSTSTORE, generateTemplate, logger, props

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GRPCServerConfig()

Method Summary

Modifier and Type	Method	Description
protected void	generateTemplate_keystore(StringBuilder sb)
protected void	generateTemplate_truststore(StringBuilder sb)
List<InetSocketAddress>	getBindingAddresses()
Set<String>	getCallerAddressFilterBlacklist()
GeoIpUtil.CallerAddressFilterOption	getCallerAddressFilterOption()
String	getCallerAddressFilterRegexPrefix()
Set<String>	getCallerAddressFilterWhitelist()
KeyManagerFactory	getKmf()
TrustManagerFactory	getTmf()
ThreadPoolExecutor	getTpe()
int	getTpeCore()
long	getTpeKeepAliveSeconds()
int	getTpeMax()
int	getTpeQueue()
BootConfig.ThreadingMode	getTpeThreadingMode()
boolean	isAutoStart()
protected void	loadCustomizedConfigs(File cfgFile, boolean isReal, ConfigUtil helper, Properties props)
static void	main(String[] args)
protected void	preLoad(File cfgFile, boolean isReal, ConfigUtil helper, Properties props)
protected void	reset()
void	shutdown()

Methods inherited from class org.summerboot.jexpress.boot.config.BootConfig

buildThreadPoolExecutor, buildThreadPoolExecutor, buildThreadPoolExecutor, createIfNotExist, generateTemplate, getCfgFile, getLength, getProperties, info, instance, lineBreak, load, loadField, name, parse, registerSingleton, resetToDefault, resetToNull, temp, updateConfigFile, updateFilePath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FILENAME_TRUSTSTORE_4SERVER

protected static final String FILENAME_TRUSTSTORE_4SERVER

See Also:

• Constant Field Values

ID

protected static final String ID

See Also:

• Constant Field Values

cfg

public static final GRPCServerConfig cfg

bindingAddresses

@ConfigHeader(title="1. gRpc.server Network Listeners",
              format="ip1:port1, ip2:port2, ..., ipN:portN",
              example="192.168.1.10:8424, 127.0.0.1:8424, 0.0.0.0:8424")
@Config(key="gRpc.server.bindings",
        predefinedValue="0.0.0.0:8424, 0.0.0.0:8425",
        required=true)
protected volatile List<InetSocketAddress> bindingAddresses

autoStart

@Config(key="gRpc.server.autostart",
        defaultValue="true")
protected volatile boolean autoStart

CallerAddressFilterOption

@Config(key="gRpc.server.CallerAddressFilter.option",
        defaultValue="HostName",
        desc="valid value = String, HostString, HostName, AddressStirng, HostAddress, AddrHostName, CanonicalHostName")
protected volatile GeoIpUtil.CallerAddressFilterOption CallerAddressFilterOption

callerAddressFilterRegexPrefix

@Config(key="gRpc.server.CallerAddressFilter.Regex.Prefix",
        desc="A non-blank prefix to mark a string as Regex in both Whitelist and Blacklist, blank means all strings are not Regex")
protected volatile String callerAddressFilterRegexPrefix

callerAddressFilterWhitelist

@Config(key="gRpc.server.CallerAddressFilter.Whitelist",
        desc="Whitelist in CSV format, example (when Regex.Prefix = RG): 127.0.0.1, RG^192\\\\.168\\\\.1\\\\.")
protected volatile Set<String> callerAddressFilterWhitelist

callerAddressFilterBlacklist

@Config(key="gRpc.server.CallerAddressFilter.Blacklist",
        desc="Blacklist in CSV format, example (when Regex.Prefix = RG): 10.1.1.40, RG^192\\\\.168\\\\.2\\\\.")
protected volatile Set<String> callerAddressFilterBlacklist

tpeThreadingMode

@Config(key="gRpc.server.pool.BizExecutor.mode",
        defaultValue="VirtualThread",
        desc="valid value = VirtualThread (default for Java 21+), CPU, IO and Mixed (default for old Java) \n use CPU core + 1 when application is CPU bound\nuse CPU core x 2 + 1 when application is I/O bound\nneed to find the best value based on your performance test result when nio.server.BizExecutor.mode=Mixed")
protected volatile BootConfig.ThreadingMode tpeThreadingMode

tpeCore

@Config(key="gRpc.server.pool.coreSize",
        predefinedValue="0",
        desc="coreSize 0 = current computer/VM\'s available processors x 2 + 1")
protected volatile int tpeCore

tpeMax

@Config(key="gRpc.server.pool.maxSize",
        predefinedValue="0",
        desc="maxSize 0 = current computer/VM\'s available processors x 2 + 1")
protected volatile int tpeMax

tpeQueue

@Config(key="gRpc.server.pool.queueSize",
        defaultValue="2147483647",
        desc="The waiting list size when the pool is full")
protected volatile int tpeQueue

tpeKeepAliveSeconds

@Config(key="gRpc.server.pool.keepAliveSeconds",
        defaultValue="60")
protected volatile long tpeKeepAliveSeconds

prestartAllCoreThreads

@Config(key="gRpc.server.pool.prestartAllCoreThreads",
        defaultValue="false")
protected boolean prestartAllCoreThreads

allowCoreThreadTimeOut

@Config(key="gRpc.server.pool.allowCoreThreadTimeOut",
        defaultValue="false")
protected boolean allowCoreThreadTimeOut

tpe

protected ThreadPoolExecutor tpe

KEY_kmf_key

protected static final String KEY_kmf_key

See Also:

• Constant Field Values

KEY_kmf_StorePwdKey

protected static final String KEY_kmf_StorePwdKey

See Also:

• Constant Field Values

KEY_kmf_AliasKey

protected static final String KEY_kmf_AliasKey

See Also:

• Constant Field Values

KEY_kmf_AliasPwdKey

protected static final String KEY_kmf_AliasPwdKey

See Also:

• Constant Field Values

kmf

@ConfigHeader(title="2. gRpc.server keystore")
@Config(key="gRpc.server.ssl.KeyStore",
        StorePwdKey="gRpc.server.ssl.KeyStorePwd",
        AliasKey="gRpc.server.ssl.KeyAlias",
        AliasPwdKey="gRpc.server.ssl.KeyPwd",
        desc="Path to key store file. Use SSL/TLS when keystore is provided, otherwise use plain socket",
        callbackMethodName4Dump="generateTemplate_keystore")
protected volatile KeyManagerFactory kmf

KEY_tmf_key

protected static final String KEY_tmf_key

See Also:

• Constant Field Values

KEY_tmf_StorePwdKey

protected static final String KEY_tmf_StorePwdKey

See Also:

• Constant Field Values

tmf

@ConfigHeader(title="3. gRpc.server truststore")
@Config(key="gRpc.server.ssl.TrustStore",
        StorePwdKey="gRpc.server.ssl.TrustStorePwd",
        callbackMethodName4Dump="generateTemplate_truststore",
        desc="Path to trust store file. Auth the remote peer certificate when a truststore is provided, otherwise blindly trust all remote peer certificate")
protected volatile TrustManagerFactory tmf

Constructor Details

GRPCServerConfig

protected GRPCServerConfig()

Method Details

main

public static void main(String[] args)

reset

protected void reset()

Overrides:

reset in class BootConfig

generateTemplate_keystore

protected void generateTemplate_keystore(StringBuilder sb)

generateTemplate_truststore

protected void generateTemplate_truststore(StringBuilder sb)

preLoad

protected void preLoad(File cfgFile,
 boolean isReal,
 ConfigUtil helper,
 Properties props)

Overrides:

preLoad in class BootConfig

loadCustomizedConfigs

protected void loadCustomizedConfigs(File cfgFile,
 boolean isReal,
 ConfigUtil helper,
 Properties props)
                              throws IOException

Specified by:

loadCustomizedConfigs in class BootConfig

Throws:

IOException

shutdown

public void shutdown()

getBindingAddresses

public List<InetSocketAddress> getBindingAddresses()

isAutoStart

public boolean isAutoStart()

getCallerAddressFilterOption

public GeoIpUtil.CallerAddressFilterOption getCallerAddressFilterOption()

getCallerAddressFilterRegexPrefix

public String getCallerAddressFilterRegexPrefix()

getCallerAddressFilterWhitelist

public Set<String> getCallerAddressFilterWhitelist()

getCallerAddressFilterBlacklist

public Set<String> getCallerAddressFilterBlacklist()

getTpeThreadingMode

public BootConfig.ThreadingMode getTpeThreadingMode()

getTpeCore

public int getTpeCore()

getTpeMax

public int getTpeMax()

getTpeQueue

public int getTpeQueue()

getTpeKeepAliveSeconds

public long getTpeKeepAliveSeconds()

getTpe

public ThreadPoolExecutor getTpe()

getKmf

public KeyManagerFactory getKmf()

getTmf

public TrustManagerFactory getTmf()