FastLaneConfig (JEAF Fast Lane API 1.5.3 API)

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
public @interface FastLaneConfig

Field Summary

Fields
Modifier and Type	Fields and Description
`static String`	`DEFAULT_CONTEXT_PATH` Default value for context path.
`static boolean`	`DEFAULT_GRACEFUL_SHUTDOWN` By default a graceful shutdown is enabled.
`static int`	`DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT` Default timeout for graceful shutdown.
`static int`	`DEFAULT_HTTP_IO_IDLE_TIMEOUT` Default value for HTTP I/O timeout of the HTTP connector.
`static int`	`DEFAULT_INITIAL_QUEUE_SIZE` Default value for initial queue size.
`static int`	`DEFAULT_INPUT_BUFFER_SIZE` Default size of input buffer when JEAF Fast Lane reads data from incoming requests
`static boolean`	`DEFAULT_JMX_ENABLED` By default JMX is disabled for security reasons.
`static boolean`	`DEFAULT_MANAGAMENT_INTERFACE_ENABLED` By default management interface is enabled.
`static String`	`DEFAULT_MANAGEMENT_PATH` Default path for management interface.
`static int`	`DEFAULT_MANAGEMENT_PORT` Default port that is used for the management interface.
`static int`	`DEFAULT_MAX_MANAGEMENT_THREADS` Default value for maximum threads of management container.
`static int`	`DEFAULT_MAX_QUEUE_SIZE` Maximum size of queue that is used to store requested until they are really processed. 0 means that the initial size is also the maximum. -1 means that queue is unlimited.
`static int`	`DEFAULT_MIN_MANAGEMENT_THREADS` Default value for minimum threads of management container.
`static int`	`DEFAULT_OUTPUT_BUFFER_SIZE` Default size of output buffer when JEAF Fast Lane writes data as response.
`static int`	`DEFAULT_PORT` Default port that is used if nothing else is configured.
`static int`	`DEFAULT_QUEUE_GROW_SIZE` Default value for grow size of queue.
`static boolean`	`DEFAULT_REST_ENABLED` By default REST services are enabled.
`static String`	`DEFAULT_REST_PATH` Default value for REST root path.
`static boolean`	`DEFAULT_SEND_SERVER_VERSION` By default information about server version is not send in response header for security reasons.
`static boolean`	`DEFAULT_SEND_X_POWERED_BY` By default information about server version is not send in response header for security reasons.
`static boolean`	`DEFAULT_STOP_SERVER_ON_ERROR` By default JEAF Fast Lane server will be stopped in case that a java.lang.Error occurs.
`static boolean`	`DEFAULT_STOP_SERVER_ON_RUNTIME_EXCEPTION` By default an uncaught runtime exception will not cause the server to stop.
`static int`	`DEFAULT_THREAD_IDLE_TIMEOUT` Default thread idle timeout.
`static boolean`	`DEFAULT_TRACE_UNCAUGHT__RUNTIME_EXCEPTIONS` By default uncaught runtime exceptions will be traced.
`static boolean`	`DEFAULT_TRACE_UNCAUGHT_ERRORS` By default java.lang.Error will be traced.
`static boolean`	`DEFAULT_WEB_SERVLET_ENABLED` By default Web Servlets are enabled.
`static int`	`DEFAULT_WORKLOAD_MAX_THREADS` Default value for maximum threads of workload container.
`static int`	`DEFAULT_WORKLOAD_MIN_THREADS` Default value for minimum threads of workload container.
`static String`	`FAST_LANE_CONFIG_PATH` Path under which the configuration file is stored.
`static String`	`FAST_LANE_CONFIG_RESOURCE_NAME` Name of the resource that contains the name of the class with the @ToolsConfig annotation.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`String`	`contextPath` Context path of the workload container.
`boolean`	`enableJMX` Defines if JMX should be enabled or not.
`boolean`	`enableManagementInterface` Enables management interface.
`boolean`	`enableREST` Enables the REST interface so that REST service can be used.
`boolean`	`enableWebServlets` Enables the servlet interface so that Web Servlets can be used.
`boolean`	`gracefulShutdown` Enables graceful shutdown behavior.
`int`	`gracefulShutdownTimeout` Timeout for graceful shutdown.
`int`	`httpIOIdleTimeout` HTTP I/O timeout of the HTTP connector.
`int`	`initialQueueSize` Initial size of queue that is used to store requests until they are really processed.
`int`	`inputBufferSize` Size of input buffer that is used when request data is read.
`String`	`managementPath` Context path under which the management interface will be available.
`int`	`managementPort` Port under which the management interface is accessible.
`int`	`maxManagementThreads` Maximum amount of threads that are used for requests to the management interface.
`int`	`maxQueueSize` Maximum size of queue that is used to store requested until they are really processed.
`int`	`maxThreads` Maximum amount of threads that are used by the workload container.
`int`	`minManagementThreads` Minimum amount of threads that are used for requests to the management interface.
`int`	`minThreads` Minimum amount of threads that are used by the workload container.
`int`	`outputBufferSize` Size of output buffer that is used when response data is written.
`int`	`port` Port that is used to server requests by the so called workload container.
`int`	`queueGrowSize` Size of which the request queue should be increased until the maximum is reached.
`String`	`restPath` Root path under which REST resources will be available.
`boolean`	`sendServerVersion` Enables sending the server version as a response header field.
`boolean`	`sendXPoweredBy` Enables sending the server version as a response header field.
`ServletMapping[]`	`servletMappings` Optional additional URL mappings for servlets.
`boolean`	`stopServerOnError` Defines if JEAF Fast Lane server should be stopped when a `Error` occurs.
`boolean`	`stopServerOnRuntimeException` Defines if JEAF Fast Lane server should be stopped when a `RuntimeException` occurs.
`int`	`threadIdleTimeout` Idle time after which a thread will be stopped and removed from pool.
`boolean`	`traceUncaughtErrors` Defines if uncaught `Error` should be traced.
`boolean`	`traceUncaughtRuntimeExceptions` Defines if uncaught `RuntimeException` should be traced.

- Field Detail
  - FAST_LANE_CONFIG_RESOURCE_NAME
```
public static final String FAST_LANE_CONFIG_RESOURCE_NAME
```
    Name of the resource that contains the name of the class with the @ToolsConfig annotation.
- - FAST_LANE_CONFIG_PATH
```
public static final String FAST_LANE_CONFIG_PATH
```
    Path under which the configuration file is stored.
- - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    Default port that is used if nothing else is configured.
- - DEFAULT_THREAD_IDLE_TIMEOUT
```
public static final int DEFAULT_THREAD_IDLE_TIMEOUT
```
    Default thread idle timeout.
- - DEFAULT_WORKLOAD_MIN_THREADS
```
public static final int DEFAULT_WORKLOAD_MIN_THREADS
```
    Default value for minimum threads of workload container.
- - DEFAULT_WORKLOAD_MAX_THREADS
```
public static final int DEFAULT_WORKLOAD_MAX_THREADS
```
    Default value for maximum threads of workload container.
- - DEFAULT_MANAGEMENT_PORT
```
public static final int DEFAULT_MANAGEMENT_PORT
```
    Default port that is used for the management interface.
- - DEFAULT_MIN_MANAGEMENT_THREADS
```
public static final int DEFAULT_MIN_MANAGEMENT_THREADS
```
    Default value for minimum threads of management container.
- - DEFAULT_MAX_MANAGEMENT_THREADS
```
public static final int DEFAULT_MAX_MANAGEMENT_THREADS
```
    Default value for maximum threads of management container.
- - DEFAULT_INITIAL_QUEUE_SIZE
```
public static final int DEFAULT_INITIAL_QUEUE_SIZE
```
    Default value for initial queue size.
- - DEFAULT_MAX_QUEUE_SIZE
```
public static final int DEFAULT_MAX_QUEUE_SIZE
```
    Maximum size of queue that is used to store requested until they are really processed. 0 means that the initial size is also the maximum. -1 means that queue is unlimited. It strong recommended to not use this as it might crash the whole server in case of high loads or DoS attacks.
- - DEFAULT_QUEUE_GROW_SIZE
```
public static final int DEFAULT_QUEUE_GROW_SIZE
```
    Default value for grow size of queue. Size by which the queue is increased when it get's to small.
- - DEFAULT_INPUT_BUFFER_SIZE
```
public static final int DEFAULT_INPUT_BUFFER_SIZE
```
    Default size of input buffer when JEAF Fast Lane reads data from incoming requests
- - DEFAULT_OUTPUT_BUFFER_SIZE
```
public static final int DEFAULT_OUTPUT_BUFFER_SIZE
```
    Default size of output buffer when JEAF Fast Lane writes data as response.
- - DEFAULT_CONTEXT_PATH
```
public static final String DEFAULT_CONTEXT_PATH
```
    Default value for context path.
- - DEFAULT_REST_PATH
```
public static final String DEFAULT_REST_PATH
```
    Default value for REST root path.
- - DEFAULT_REST_ENABLED
```
public static final boolean DEFAULT_REST_ENABLED
```
    By default REST services are enabled.
- - DEFAULT_WEB_SERVLET_ENABLED
```
public static final boolean DEFAULT_WEB_SERVLET_ENABLED
```
    By default Web Servlets are enabled.
- - DEFAULT_MANAGEMENT_PATH
```
public static final String DEFAULT_MANAGEMENT_PATH
```
    Default path for management interface.
- - DEFAULT_MANAGAMENT_INTERFACE_ENABLED
```
public static final boolean DEFAULT_MANAGAMENT_INTERFACE_ENABLED
```
    By default management interface is enabled.
- - DEFAULT_HTTP_IO_IDLE_TIMEOUT
```
public static final int DEFAULT_HTTP_IO_IDLE_TIMEOUT
```
    Default value for HTTP I/O timeout of the HTTP connector. This timeout comes into play if a client does not consume further response data for a certain amount of time.
- - DEFAULT_SEND_SERVER_VERSION
```
public static final boolean DEFAULT_SEND_SERVER_VERSION
```
    By default information about server version is not send in response header for security reasons.
- - DEFAULT_SEND_X_POWERED_BY
```
public static final boolean DEFAULT_SEND_X_POWERED_BY
```
    By default information about server version is not send in response header for security reasons.
- - DEFAULT_GRACEFUL_SHUTDOWN
```
public static final boolean DEFAULT_GRACEFUL_SHUTDOWN
```
    By default a graceful shutdown is enabled. This allows to process and complete already processed request but new request will not be accepted.
- - DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT
```
public static final int DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT
```
    Default timeout for graceful shutdown. This timeout defines the time that is waited at a maximum until already processed request will be finished.
- - DEFAULT_STOP_SERVER_ON_ERROR
```
public static final boolean DEFAULT_STOP_SERVER_ON_ERROR
```
    By default JEAF Fast Lane server will be stopped in case that a java.lang.Error occurs.
- - DEFAULT_TRACE_UNCAUGHT_ERRORS
```
public static final boolean DEFAULT_TRACE_UNCAUGHT_ERRORS
```
    By default java.lang.Error will be traced.
- - DEFAULT_STOP_SERVER_ON_RUNTIME_EXCEPTION
```
public static final boolean DEFAULT_STOP_SERVER_ON_RUNTIME_EXCEPTION
```
    By default an uncaught runtime exception will not cause the server to stop.
- - DEFAULT_TRACE_UNCAUGHT__RUNTIME_EXCEPTIONS
```
public static final boolean DEFAULT_TRACE_UNCAUGHT__RUNTIME_EXCEPTIONS
```
    By default uncaught runtime exceptions will be traced.
- - DEFAULT_JMX_ENABLED
```
public static final boolean DEFAULT_JMX_ENABLED
```
    By default JMX is disabled for security reasons.
- Element Detail
  - port
```
public abstract int port
```
    Port that is used to server requests by the so called workload container. The workload container is used to server all kinds of non-management requests.
    
    Default:
    
    8090
- - minThreads
```
public abstract int minThreads
```
    Minimum amount of threads that are used by the workload container.
    
    Default:
    
    10
- - maxThreads
```
public abstract int maxThreads
```
    Maximum amount of threads that are used by the workload container.
    
    Default:
    
    50
- - enableREST
```
public abstract boolean enableREST
```
    Enables the REST interface so that REST service can be used.
    
    Default:
    
    true
- - enableWebServlets
```
public abstract boolean enableWebServlets
```
    Enables the servlet interface so that Web Servlets can be used.
    
    Default:
    
    true
- - enableManagementInterface
```
public abstract boolean enableManagementInterface
```
    Enables management interface.
    
    Default:
    
    true
- - managementPort
```
public abstract int managementPort
```
    Port under which the management interface is accessible.
    
    Default:
    
    8091
- - minManagementThreads
```
public abstract int minManagementThreads
```
    Minimum amount of threads that are used for requests to the management interface.
    
    Default:
    
    1
- - maxManagementThreads
```
public abstract int maxManagementThreads
```
    Maximum amount of threads that are used for requests to the management interface.
    
    Default:
    
    8
- - threadIdleTimeout
```
public abstract int threadIdleTimeout
```
    Idle time after which a thread will be stopped and removed from pool. Timeout is defined in milliseconds.
    
    Default:
    
    300000
- - initialQueueSize
```
public abstract int initialQueueSize
```
    Initial size of queue that is used to store requests until they are really processed.
    
    Default:
    
    100
- - maxQueueSize
```
public abstract int maxQueueSize
```
    Maximum size of queue that is used to store requested until they are really processed.
    - 0 means that the initial size is also the maximum.
    - -1 means that queue is unlimited. It strong recommended to not use this as it might crash the whole server in case of high loads or DoS attacks.
    Default:
    
    0
- - queueGrowSize
```
public abstract int queueGrowSize
```
    Size of which the request queue should be increased until the maximum is reached.
    
    Default:
    
    100
- - inputBufferSize
```
public abstract int inputBufferSize
```
    Size of input buffer that is used when request data is read.
    
    Default:
    
    8192
- - outputBufferSize
```
public abstract int outputBufferSize
```
    Size of output buffer that is used when response data is written.
    
    Default:
    
    32768
- - contextPath
```
public abstract String contextPath
```
    Context path of the workload container.
    
    Default:
    
    "/*"
- - restPath
```
public abstract String restPath
```
    Root path under which REST resources will be available.
    
    Default:
    
    "/rest/*"
- - managementPath
```
public abstract String managementPath
```
    Context path under which the management interface will be available.
    
    Default:
    
    "/*"
- - httpIOIdleTimeout
```
public abstract int httpIOIdleTimeout
```
    HTTP I/O timeout of the HTTP connector. This timeout comes into play if a client does not consume further response data for a certain amount of time.
    
    Default:
    
    30000
- - sendServerVersion
```
public abstract boolean sendServerVersion
```
    Enables sending the server version as a response header field. It's recommended to not enable this info for security reasons.
    
    Default:
    
    false
- - sendXPoweredBy
```
public abstract boolean sendXPoweredBy
```
    Enables sending the server version as a response header field. It's recommended to not enable this info for security reasons.
    
    Default:
    
    false
- - gracefulShutdown
```
public abstract boolean gracefulShutdown
```
    Enables graceful shutdown behavior. Graceful shutdown means that request that are already processed will be finished but new ones will not be accepted.
    
    Default:
    
    true
- - gracefulShutdownTimeout
```
public abstract int gracefulShutdownTimeout
```
    Timeout for graceful shutdown. If this timeout is exceeded then running threads will be killed.
    
    Default:
    
    30000
- - stopServerOnError
```
public abstract boolean stopServerOnError
```
    Defines if JEAF Fast Lane server should be stopped when a Error occurs.
    
    Default:
    
    true
- - traceUncaughtErrors
```
public abstract boolean traceUncaughtErrors
```
    Defines if uncaught Error should be traced.
    
    Default:
    
    true
- - stopServerOnRuntimeException
```
public abstract boolean stopServerOnRuntimeException
```
    Defines if JEAF Fast Lane server should be stopped when a RuntimeException occurs.
    
    Default:
    
    false
- - traceUncaughtRuntimeExceptions
```
public abstract boolean traceUncaughtRuntimeExceptions
```
    Defines if uncaught RuntimeException should be traced.
    
    Default:
    
    true
- - enableJMX
```
public abstract boolean enableJMX
```
    Defines if JMX should be enabled or not. By default JMX is disabled to prevent security issues.
    
    Default:
    
    false
- - servletMappings
```
public abstract ServletMapping[] servletMappings
```
    Optional additional URL mappings for servlets. Servlet mappings are an addition to what is already configured in the @WebServlet annotation.
    
    Default:
    
    {}

Annotation Type FastLaneConfig

Field Summary

Optional Element Summary

Field Detail

FAST_LANE_CONFIG_RESOURCE_NAME

FAST_LANE_CONFIG_PATH

DEFAULT_PORT

DEFAULT_THREAD_IDLE_TIMEOUT

DEFAULT_WORKLOAD_MIN_THREADS

DEFAULT_WORKLOAD_MAX_THREADS

DEFAULT_MANAGEMENT_PORT

DEFAULT_MIN_MANAGEMENT_THREADS

DEFAULT_MAX_MANAGEMENT_THREADS

DEFAULT_INITIAL_QUEUE_SIZE

DEFAULT_MAX_QUEUE_SIZE

DEFAULT_QUEUE_GROW_SIZE

DEFAULT_INPUT_BUFFER_SIZE

DEFAULT_OUTPUT_BUFFER_SIZE

DEFAULT_CONTEXT_PATH

DEFAULT_REST_PATH

DEFAULT_REST_ENABLED

DEFAULT_WEB_SERVLET_ENABLED

DEFAULT_MANAGEMENT_PATH

DEFAULT_MANAGAMENT_INTERFACE_ENABLED

DEFAULT_HTTP_IO_IDLE_TIMEOUT

DEFAULT_SEND_SERVER_VERSION

DEFAULT_SEND_X_POWERED_BY

DEFAULT_GRACEFUL_SHUTDOWN

DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT

DEFAULT_STOP_SERVER_ON_ERROR

DEFAULT_TRACE_UNCAUGHT_ERRORS

DEFAULT_STOP_SERVER_ON_RUNTIME_EXCEPTION

DEFAULT_TRACE_UNCAUGHT__RUNTIME_EXCEPTIONS

DEFAULT_JMX_ENABLED

Element Detail

port

minThreads

maxThreads

enableREST

enableWebServlets

enableManagementInterface

managementPort

minManagementThreads

maxManagementThreads

threadIdleTimeout

initialQueueSize

maxQueueSize

queueGrowSize

inputBufferSize

outputBufferSize

contextPath

restPath

managementPath

httpIOIdleTimeout

sendServerVersion

sendXPoweredBy

gracefulShutdown

gracefulShutdownTimeout

stopServerOnError

traceUncaughtErrors

stopServerOnRuntimeException

traceUncaughtRuntimeExceptions

enableJMX

servletMappings