ConfigManager (Deep Java Library 0.11.0

java.lang.Object
- ai.djl.serving.util.ConfigManager

public final class ConfigManager
extends java.lang.Object

A class that hold configuration information.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`dumpConfigurations()` Prints out this configuration.
`int`	`getBatchSize()` Returns the default batchSize for workers.
`Connector`	`getConnector(Connector.ConnectorType type)` Returns the models server socket connector.
`java.lang.String`	`getCorsAllowedHeaders()` Returns the CORS allowed headers setting.
`java.lang.String`	`getCorsAllowedMethods()` Returns the CORS allowed method setting.
`java.lang.String`	`getCorsAllowedOrigin()` Returns the CORS allowed origin setting.
`int`	`getDefaultWorkers()` Returns the default number of workers for a new registered model.
`static ConfigManager`	`getInstance()` Returns the singleton `ConfigManager` instance.
`int`	`getIoRatio()` Returns the native IO ratio.
`int`	`getJobQueueSize()` Returns the default job queue size.
`java.lang.String`	`getLoadModels()` Returns the model urls that to be loaded at startup.
`int`	`getMaxBatchDelay()` Returns the default maxBatchDelay for the working queue.
`int`	`getMaxIdleTime()` Returns the default max idle time for workers.
`int`	`getMaxRequestSize()` Returns the maximum allowed request size in bytes.
`static java.lang.String`	`getModelServerHome()` Returns the model server home directory.
`java.nio.file.Path`	`getModelStore()` Returns the model store location.
`java.lang.String`	`getModelUrlPattern()` Returns the allowed model url pattern regex.
`int`	`getNettyClientThreads()` Returns the configured netty client threads.
`int`	`getNettyThreads()` Returns the configured netty threads.
`int`	`getNumberOfGpu()` Returns the number of GPUs to be used.
`java.nio.file.Path`	`getPluginFolder()` return the folder where the model search for plugins.
`java.lang.String`	`getProperty(java.lang.String key, java.lang.String def)` Returns the value with the specified key in this configuration.
`io.netty.handler.ssl.SslContext`	`getSslContext()` Returns a `SSLContext` instance.
`static void`	`init(Arguments args)` Initialize the global `ConfigManager` instance.
`boolean`	`isDebug()` Returns if debug is enabled.
`boolean`	`useNativeIo()` Returns if use netty native IO.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - init
```
public static void init(Arguments args)
```
    Initialize the global ConfigManager instance.
    
    Parameters:
    
    args - the command line arguments
  - getInstance
```
public static ConfigManager getInstance()
```
    Returns the singleton ConfigManager instance.
    
    Returns:
    
    the singleton ConfigManager instance
  - isDebug
```
public boolean isDebug()
```
    Returns if debug is enabled.
    
    Returns:
    
    true if debug is enabled
  - getConnector
```
public Connector getConnector(Connector.ConnectorType type)
```
    Returns the models server socket connector.
    
    Parameters:
    
    type - the type of connector
    
    Returns:
    
    the Connector
  - getNettyThreads
```
public int getNettyThreads()
```
    Returns the configured netty threads.
    
    Returns:
    
    the configured netty threads
  - getNettyClientThreads
```
public int getNettyClientThreads()
```
    Returns the configured netty client threads.
    
    Returns:
    
    the configured netty client threads
  - getJobQueueSize
```
public int getJobQueueSize()
```
    Returns the default job queue size.
    
    Returns:
    
    the default job queue size
  - getMaxIdleTime
```
public int getMaxIdleTime()
```
    Returns the default max idle time for workers.
    
    Returns:
    
    the default max idle time
  - getBatchSize
```
public int getBatchSize()
```
    Returns the default batchSize for workers.
    
    Returns:
    
    the default max idle time
  - getMaxBatchDelay
```
public int getMaxBatchDelay()
```
    Returns the default maxBatchDelay for the working queue.
    
    Returns:
    
    the default max batch delay
  - getNumberOfGpu
```
public int getNumberOfGpu()
```
    Returns the number of GPUs to be used.
    
    Returns:
    
    the number of GPUs to be used
  - getDefaultWorkers
```
public int getDefaultWorkers()
```
    Returns the default number of workers for a new registered model.
    
    Returns:
    
    the default number of workers for a new registered model
  - getModelServerHome
```
public static java.lang.String getModelServerHome()
```
    Returns the model server home directory.
    
    Returns:
    
    the model server home directory
  - getModelStore
```
public java.nio.file.Path getModelStore()
```
    Returns the model store location.
    
    Returns:
    
    the model store location
  - getModelUrlPattern
```
public java.lang.String getModelUrlPattern()
```
    Returns the allowed model url pattern regex.
    
    Returns:
    
    the allowed model url pattern regex
  - getLoadModels
```
public java.lang.String getLoadModels()
```
    Returns the model urls that to be loaded at startup.
    
    Returns:
    
    the model urls that to be loaded at startup
  - getCorsAllowedOrigin
```
public java.lang.String getCorsAllowedOrigin()
```
    Returns the CORS allowed origin setting.
    
    Returns:
    
    the CORS allowed origin setting
  - getCorsAllowedMethods
```
public java.lang.String getCorsAllowedMethods()
```
    Returns the CORS allowed method setting.
    
    Returns:
    
    the CORS allowed method setting
  - getCorsAllowedHeaders
```
public java.lang.String getCorsAllowedHeaders()
```
    Returns the CORS allowed headers setting.
    
    Returns:
    
    the CORS allowed headers setting
  - getPluginFolder
```
public java.nio.file.Path getPluginFolder()
```
    return the folder where the model search for plugins.
    
    Returns:
    
    the configured plugin folder or the default folder.
  - getSslContext
```
public io.netty.handler.ssl.SslContext getSslContext()
                                              throws java.io.IOException,
                                                     java.security.GeneralSecurityException
```
    Returns a SSLContext instance.
    
    Returns:
    
    a SSLContext instance
    
    Throws:
    
    java.io.IOException - if failed to read certificate file
    
    java.security.GeneralSecurityException - if failed to initialize SSLContext
  - getProperty
```
public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String def)
```
    Returns the value with the specified key in this configuration.
    
    Parameters:
    
    key - the key
    
    def - a default value
    
    Returns:
    
    the value with the specified key in this configuration
  - dumpConfigurations
```
public java.lang.String dumpConfigurations()
```
    Prints out this configuration.
    
    Returns:
    
    a string representation of this configuration
  - useNativeIo
```
public boolean useNativeIo()
```
    Returns if use netty native IO.
    
    Returns:
    
    true if use netty native IO
  - getIoRatio
```
public int getIoRatio()
```
    Returns the native IO ratio.
    
    Returns:
    
    the native IO ratio
  - getMaxRequestSize
```
public int getMaxRequestSize()
```
    Returns the maximum allowed request size in bytes.
    
    Returns:
    
    the maximum allowed request size in bytes

Class ConfigManager

Method Summary

Methods inherited from class java.lang.Object

Method Detail

init

getInstance

isDebug

getConnector

getNettyThreads

getNettyClientThreads

getJobQueueSize

getMaxIdleTime

getBatchSize

getMaxBatchDelay

getNumberOfGpu

getDefaultWorkers

getModelServerHome

getModelStore

getModelUrlPattern

getLoadModels

getCorsAllowedOrigin

getCorsAllowedMethods

getCorsAllowedHeaders

getPluginFolder

getSslContext

getProperty

dumpConfigurations

useNativeIo

getIoRatio

getMaxRequestSize