Package com.anaptecs.jeaf.fastlane.annotations

Annotation Type FastLaneConfig

  • @Retention(RUNTIME)
@Target(TYPE)
@Documented
public @interface FastLaneConfig

    • Field Detail

      • FAST_LANE_CONFIG_RESOURCE_NAME

        static final java.lang.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

        static final java.lang.String FAST_LANE_CONFIG_PATH
        Path under which the configuration file is stored.

      • DEFAULT_PORT

        static final int DEFAULT_PORT
        Default port that is used if nothing else is configured.

      • DEFAULT_THREAD_IDLE_TIMEOUT

        static final int DEFAULT_THREAD_IDLE_TIMEOUT
        Default thread idle timeout.

      • DEFAULT_WORKLOAD_MIN_THREADS

        static final int DEFAULT_WORKLOAD_MIN_THREADS
        Default value for minimum threads of workload container.

      • DEFAULT_WORKLOAD_MAX_THREADS

        static final int DEFAULT_WORKLOAD_MAX_THREADS
        Default value for maximum threads of workload container.

      • DEFAULT_MANAGEMENT_PORT

        static final int DEFAULT_MANAGEMENT_PORT
        Default port that is used for the management interface.

      • DEFAULT_MIN_MANAGEMENT_THREADS

        static final int DEFAULT_MIN_MANAGEMENT_THREADS
        Default value for minimum threads of management container.

      • DEFAULT_MAX_MANAGEMENT_THREADS

        static final int DEFAULT_MAX_MANAGEMENT_THREADS
        Default value for maximum threads of management container.

      • DEFAULT_INITIAL_QUEUE_SIZE

        static final int DEFAULT_INITIAL_QUEUE_SIZE
        Default value for initial queue size.

      • DEFAULT_MAX_QUEUE_SIZE

        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

        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

        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

        static final int DEFAULT_OUTPUT_BUFFER_SIZE
        Default size of output buffer when JEAF Fast Lane writes data as response.

      • DEFAULT_CONTEXT_PATH

        static final java.lang.String DEFAULT_CONTEXT_PATH
        Default value for context path.

      • DEFAULT_REST_PATH

        static final java.lang.String DEFAULT_REST_PATH
        Default value for REST root path.

      • DEFAULT_REST_ENABLED

        static final boolean DEFAULT_REST_ENABLED
        By default REST services are enabled.

      • DEFAULT_WEB_SERVLET_ENABLED

        static final boolean DEFAULT_WEB_SERVLET_ENABLED
        By default Web Servlets are enabled.

      • DEFAULT_MANAGEMENT_PATH

        static final java.lang.String DEFAULT_MANAGEMENT_PATH
        Default path for management interface.

      • DEFAULT_MANAGAMENT_INTERFACE_ENABLED

        static final boolean DEFAULT_MANAGAMENT_INTERFACE_ENABLED
        By default management interface is enabled.

      • DEFAULT_HTTP_IO_IDLE_TIMEOUT

        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

        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

        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

        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

        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

        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

        static final boolean DEFAULT_TRACE_UNCAUGHT_ERRORS
        By default java.lang.Error will be traced.

      • DEFAULT_STOP_SERVER_ON_RUNTIME_EXCEPTION

        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

        static final boolean DEFAULT_TRACE_UNCAUGHT__RUNTIME_EXCEPTIONS
        By default uncaught runtime exceptions will be traced.

      • DEFAULT_JMX_ENABLED

        static final boolean DEFAULT_JMX_ENABLED
        By default JMX is disabled for security reasons.

    • Element Detail

      • port

        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

        int minThreads
        Minimum amount of threads that are used by the workload container.
        Default:
        10

      • maxThreads

        int maxThreads
        Maximum amount of threads that are used by the workload container.
        Default:
        50

      • enableREST

        boolean enableREST
        Enables the REST interface so that REST service can be used.
        Default:
        true

      • enableWebServlets

        boolean enableWebServlets
        Enables the servlet interface so that Web Servlets can be used.
        Default:
        true

      • enableManagementInterface

        boolean enableManagementInterface
        Enables management interface.
        Default:
        true

      • managementPort

        int managementPort
        Port under which the management interface is accessible.
        Default:
        8091

      • minManagementThreads

        int minManagementThreads
        Minimum amount of threads that are used for requests to the management interface.
        Default:
        1

      • maxManagementThreads

        int maxManagementThreads
        Maximum amount of threads that are used for requests to the management interface.
        Default:
        8

      • threadIdleTimeout

        int threadIdleTimeout
        Idle time after which a thread will be stopped and removed from pool. Timeout is defined in milliseconds.
        Default:
        300000

      • initialQueueSize

        int initialQueueSize
        Initial size of queue that is used to store requests until they are really processed.
        Default:
        100

      • maxQueueSize

        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

        int queueGrowSize
        Size of which the request queue should be increased until the maximum is reached.
        Default:
        100

      • inputBufferSize

        int inputBufferSize
        Size of input buffer that is used when request data is read.
        Default:
        8192

      • outputBufferSize

        int outputBufferSize
        Size of output buffer that is used when response data is written.
        Default:
        32768

      • contextPath

        java.lang.String contextPath
        Context path of the workload container.
        Default:
        "/*"

      • restPath

        java.lang.String restPath
        Root path under which REST resources will be available.
        Default:
        "/rest/*"

      • managementPath

        java.lang.String managementPath
        Context path under which the management interface will be available.
        Default:
        "/*"

      • httpIOIdleTimeout

        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

        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

        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

        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

        int gracefulShutdownTimeout
        Timeout for graceful shutdown. If this timeout is exceeded then running threads will be killed.
        Default:
        30000

      • stopServerOnError

        boolean stopServerOnError
        Defines if JEAF Fast Lane server should be stopped when a Error occurs.
        Default:
        true

      • traceUncaughtErrors

        boolean traceUncaughtErrors
        Defines if uncaught Error should be traced.
        Default:
        true

      • stopServerOnRuntimeException

        boolean stopServerOnRuntimeException
        Defines if JEAF Fast Lane server should be stopped when a RuntimeException occurs.
        Default:
        false

      • traceUncaughtRuntimeExceptions

        boolean traceUncaughtRuntimeExceptions
        Defines if uncaught RuntimeException should be traced.
        Default:
        true

      • enableJMX

        boolean enableJMX
        Defines if JMX should be enabled or not. By default JMX is disabled to prevent security issues.
        Default:
        false

      • servletMappings

        ServletMapping[] servletMappings
        Optional additional URL mappings for servlets. Servlet mappings are an addition to what is already configured in the @WebServlet annotation.
        Default:
        {}