### Application Start Dependency Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/webApplication.adoc Specifies applications that must start before this application can begin starting. ```APIDOC ## startAfter ### Description Specifies applications that are required to start before this application can begin starting. ### Method Not Applicable (Configuration Schema) ### Endpoint Not Applicable (Configuration Schema) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **autoStart** (boolean) - Optional - Defaults to true. Indicates whether the dependent application should automatically start. ### Request Example ```json { "autoStart": true } ``` ### Response #### Success Response (200) - **message** (string) - Configuration applied successfully. #### Response Example ```json { "message": "Start after dependency configured successfully." } ``` ``` -------------------------------- ### Message-Driven Start at Application Start (ejb-jar-ext/message-driven/start-at-app-start) Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/webApplication.adoc Configuration to control whether a message-driven EJB starts upon application startup. ```APIDOC ## Message-Driven Start at Application Start (ejb-jar-ext/message-driven/start-at-app-start) ### Description Controls whether the bean starts at application start. ### Method N/A (Configuration Structure) ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body ##### Properties - **value** (boolean) - Optional - The value of the start at application start property. Defaults to `false`. ### Request Example ```json { "value": true } ``` ### Response #### Success Response (200) N/A (Configuration Structure) #### Response Example ```json { "value": true } ``` ``` -------------------------------- ### Session Bean - Start at Application Start Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/ejbApplication.adoc Controls whether a session bean starts automatically when the application starts. ```APIDOC ## EJB-JAR-EXT / SESSION / START-AT-APP-START ### Description Controls whether the bean starts at application start. ### Method Not Applicable (Configuration) ### Endpoint Not Applicable (Configuration) ### Parameters #### Request Body - **value** (boolean) - Optional - The value of the start at application start property. Default: `false` ``` -------------------------------- ### Message-Driven Bean Start at Application Start Setting Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/springBootApplication.adoc Configure whether a message-driven bean starts at application start. ```APIDOC ## Message-Driven Bean Start at Application Start Setting ### Description Controls whether the message-driven bean starts at application start. ### Method GET /openliberty/docs-generated/ejb-jar-ext/message-driven/start-at-app-start ### Endpoint /openliberty/docs-generated/ejb-jar-ext/message-driven/start-at-app-start ### Parameters #### Query Parameters - **value** (boolean) - Optional - Default: `false` - The value of the start at application start property. ### Request Example ```json { "value": true } ``` ### Response #### Success Response (200) - **value** (boolean) - The value of the start at application start property. #### Response Example ```json { "value": true } ``` ``` -------------------------------- ### Message-Driven Bean - Start at Application Start Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/ejbApplication.adoc Controls whether a message-driven bean starts automatically when the application starts. ```APIDOC ## EJB-JAR-EXT / MESSAGE-DRIVEN / START-AT-APP-START ### Description Controls whether the bean starts at application start. ### Method Not Applicable (Configuration) ### Endpoint Not Applicable (Configuration) ### Parameters #### Request Body - **value** (boolean) - Optional - The value of the start at application start property. Default: `false` ``` -------------------------------- ### Configure Package Library Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/oauthProvider.adoc Specifies the library for packages. For example, 'QGPL'. ```Java jdbc:db2://host:port/databaseName:packageLibrary=MYLIB; ``` -------------------------------- ### JDBC Driver: packageLibrary Property Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/databaseStore.adoc Specifies the library for packages used by the JDBC driver. This property accepts a string value, with 'QGPL' as an example. ```Java packageLibrary ``` -------------------------------- ### Configure Keystore Provider Type for WSS4J Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/wsSecurityProvider.adoc Specifies the provider used for loading keystores. Defaults to the installed provider. ```Java String keystoreProviderType = "org.apache.ws.security.crypto.merlin.keystore.provider"; ``` -------------------------------- ### Configure Wait to Accept Connections Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/pluginConfiguration.adoc Determines if the TCP Channel should delay accepting new connections until the server has fully started. If false, connections are closed until the server is ready. ```configuration +boolean +false+ +Queries whether this TCP Channel will delay accepting connections until the server starts. If false, connections are closed until the server starts. If true, the value for the acceptThread tcpOption is also set to true, and connections are delayed until the server starts.+ ``` -------------------------------- ### Configure Included Host Names Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/pluginConfiguration.adoc Specifies a comma-separated list of host names that are permitted to establish inbound connections. Host names are case-insensitive, and wildcards are allowed only at the start. ```configuration +A comma-separated list of host names that are allowed to make inbound connections on this endpoint. Host names are not case-sensitive and can start with an asterisk, which is used as a wildcard character. However, asterisks cannot be elsewhere in the host name. For example, *.abc.com is valid, but *.abc.* is not valid.+ ``` -------------------------------- ### Application Startup Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/jaasLoginModule.adoc Configures application startup behavior, including dependencies, classloaders, and context roots. ```APIDOC ## POST /openliberty/docs-generated/classProvider/startAfter ### Description Specifies applications that are required to start before this application can begin starting. ### Method POST ### Endpoint /openliberty/docs-generated/classProvider/startAfter ### Parameters #### Request Body - **autoStart** (boolean) - Optional - Indicates whether or not the server automatically starts the application. Defaults to true. - **classloaderRef** (string) - Optional - Defines the settings for an application classloader by referencing a top-level classloader element. - **context-root** (string) - Optional - The context root of an application. - **id** (string) - Required - A unique configuration ID for the application. - **location** (string) - Required - Location of an application expressed as an absolute path or a path relative to the server-level apps directory. - **name** (string) - Optional - The name of an application. - **startAfterRef** (string) - Optional - Specifies applications that are required to start before this application can begin starting, provided as a comma-separated list of references to top-level application elements. - **type** (string) - Optional - The type of application archive. - **useJandex** (boolean) - Optional - Enables use of Jandex index files if they are supplied in the application. ### Request Example ```json { "id": "myApp1", "location": "apps/myApp1.war", "autoStart": true, "startAfterRef": "myApp0", "context-root": "/app1" } ``` ### Response #### Success Response (200) - **message** (string) - Indicates successful configuration of application startup. #### Response Example ```json { "message": "Application startup configuration successful." } ``` ``` -------------------------------- ### Application Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/webApplication.adoc This section details the configuration of applications, including their classloaders, context roots, and startup dependencies. ```APIDOC ## Application Configuration ### Description Configures application-level settings, including classloader references, context roots, and startup order. ### Method Not applicable (Configuration Section) ### Endpoint Not applicable (Configuration Section) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **classloaderRef** (string) - Optional - A reference to top level classloader element. - **context-root** (string) - Optional - Context root of an application. - **id** (string) - Optional - A unique configuration ID. - **location** (string) - Required - Location of an application expressed as an absolute path or a path relative to the server-level apps directory. - **name** (string) - Optional - Name of an application. - **startAfterRef** (string) - Optional - Specifies applications that are required to start before this application can begin starting (comma-separated string). - **type** (string) - Optional - Type of application archive. - **useJandex** (boolean) - Optional - Enables use of Jandex index files if they are supplied in the application. ### Request Example ```json { "classloaderRef": "my-classloader", "context-root": "/myapp", "location": "/path/to/app.war", "name": "my-app", "startAfterRef": "other-app", "useJandex": true } ``` ### Response #### Success Response (200) - **Configuration details** (object) - Details of the application configuration. #### Response Example ```json { "message": "Application configuration updated successfully." } ``` ``` -------------------------------- ### Application Start-up Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/enterpriseApplication.adoc Configures application start-up properties, including auto-start behavior, classloader references, context roots, and dependencies on other applications. ```APIDOC ## Application Start-up Configuration ### Description Configures application start-up behavior and dependencies. ### Endpoint `/startAfter` ### Parameters #### Query Parameters - **autoStart** (boolean) - Optional - Indicates whether the server automatically starts the application. Defaults to `true`. - **classloaderRef** (string) - Optional - A reference to the top-level classloader element. - **context-root** (string) - Optional - The context root of the application. - **id** (string) - Required - A unique configuration ID. - **location** (string) - Required - Location of the application (absolute path or relative to `apps` directory). - **name** (string) - Optional - The name of the application. - **startAfterRef** (string) - Optional - A comma-separated list of application IDs that must start before this application. - **type** (string) - Optional - The type of the application archive. - **useJandex** (boolean) - Optional - Enables the use of Jandex index files. ### Request Example ```json { "id": "myAppId", "location": "/path/to/myApp.war", "autoStart": true, "startAfterRef": "otherAppId1,otherAppId2" } ``` ### Response (Success) Returns the configuration details of the application start-up settings. ``` -------------------------------- ### Application Deployment API Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/application.adoc Deploys and configures applications on the server. This includes setting properties like auto-start, classloader references, context roots, location, name, start-after dependencies, application type, and Jandex index usage. ```APIDOC ## POST /startAfter ### Description Deploys and configures an application on the server, specifying its properties and dependencies. ### Method POST ### Endpoint /startAfter ### Parameters #### Request Body - **autoStart** (boolean) - Optional - Indicates whether or not the server automatically starts the application. Defaults to true. - **classloaderRef** (string) - Optional - Defines the settings for an application classloader by referencing a top-level classloader element. - **context-root** (string) - Optional - The context root of the application. - **id** (string) - Optional - A unique configuration ID for the application. - **location** (string) - Required - The location of an application expressed as an absolute path or a path relative to the server-level apps directory. - **name** (string) - Optional - The name of the application. - **startAfterRef** (string) - Optional - A comma-separated string of references to top-level application elements that must start before this application can begin starting. - **type** (string) - Optional - The type of application archive. - **useJandex** (boolean) - Optional - Enables use of Jandex index files if they are supplied in the application. ### Request Example { "location": "/path/to/myApp.ear", "name": "MyApp", "autoStart": true, "context-root": "/myapp", "startAfterRef": "otherApp1,otherApp2" } ### Response #### Success Response (200) - **message** (string) - Indicates successful application deployment and configuration. #### Response Example { "message": "Application deployed and configured successfully." } ``` -------------------------------- ### Configure Task Start Timeout Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/managedExecutorService.adoc Specifies the maximum time allowed between task submission and task start. Tasks do not time out by default. If both a maximum wait for enqueue and a start timeout are configured, the start timeout should be larger. Updates to the start timeout apply to subsequent task submissions. The format is a positive integer followed by a time unit (h, m, s, ms), with support for multiple values (e.g., 1s500ms). ```XML ``` -------------------------------- ### Application Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/application.adoc This section describes the configuration of an application, including its properties, classloader, context root, and other settings. ```APIDOC ## Application Configuration ### Description Defines the properties of an application. ### Parameters #### Request Body - **autoStart** (boolean) - Optional - Indicates whether or not the server automatically starts the application. - **classloaderRef** (string) - Optional - Defines the settings for an application classloader. - **context-root** (string) - Optional - Context root of an application. - **id** (string) - Optional - A unique configuration ID. - **location** (string) - Required - Location of an application expressed as an absolute path or a path relative to the server-level apps directory. - **name** (string) - Optional - Name of an application. - **startAfterRef** (string) - Optional - Specifies applications that are required to start before this application can begin starting. - **type** (string) - Optional - Type of application archive. - **useJandex** (boolean) - Optional - Enables use of Jandex index files if they are supplied in the application. ``` -------------------------------- ### Configure Connection Acceptance Delay in Open Liberty Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/virtualHost.adoc Determines if the TCP Channel will delay accepting connections until the server starts. If false, connections are closed until the server starts. If true, connections are delayed until the server starts. The default value is false. ```properties waitToAccept=false ``` -------------------------------- ### Configure Connection Acceptance Delay in Open Liberty Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/wasJmsOutbound.adoc Determines if the TCP Channel will delay accepting connections until the server starts. If false, connections are closed until the server starts. If true, connections are delayed until the server starts, and the acceptThread tcpOption is also set to true. ```properties +waitToAccept+= ``` -------------------------------- ### classProvider > startAfter > classloader > privateLibrary > file Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/jaasLoginModule.adoc Add a JAR or ZIP file to include in the class path for this library. Classes and resources that are contained in the specified JAR or ZIP are available to load for this library. ```APIDOC ## classProvider > startAfter > classloader > privateLibrary > file ### Description Add a JAR or ZIP file to include in the class path for this library. Classes and resources that are contained in the specified JAR or ZIP are available to load for this library. ### Method N/A (Configuration Element) ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body - **id** (string) - Optional - A unique configuration ID. - **name** (Path to a file) - Required - The path to a file can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property. ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ``` -------------------------------- ### Open Liberty Start Timeout Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/managedExecutorService.adoc Configures the timeout duration for starting tasks. This setting specifies a period of time with millisecond precision. ```XML ``` -------------------------------- ### Web Application JSP and Servlet Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/springBootApplication.adoc Configuration for pre-compiling JSPs and enabling servlet serving by class name. ```APIDOC ## Web Application JSP Compilation Configuration ### Description Specifies whether JSP pages are compiled when the web application starts. ### Endpoint `/web-ext/pre-compile-jsps` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **pre-compile-jsps** (boolean) - Optional - Specifies whether JSP pages are compiled. ### Request Example ```json { "pre-compile-jsps": true } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. #### Response Example ```json { "status": "Configuration updated successfully" } ``` ## Web Application Servlet Serving Configuration ### Description Enables serving servlets by classname. ### Endpoint `/web-ext/enable-serving-servlets-by-class-name` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **enable-serving-servlets-by-class-name** (boolean) - Optional - Enables serving servlets by classname. ### Request Example ```json { "enable-serving-servlets-by-class-name": true } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. #### Response Example ```json { "status": "Configuration updated successfully" } ``` ``` -------------------------------- ### Configure JDBC Retrieve Messages From Server On Get Message Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/databaseStore.adoc Determines whether to retrieve messages from the server on get message for JDBC. This is a boolean property. ```Java retrieveMessagesFromServerOnGetMessage=true ``` -------------------------------- ### Application Bindings Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/webApplication.adoc Configure bindings for various application resources like data sources, EJB references, and environment entries. ```APIDOC ## Application Bindings Configuration ### Description Defines properties that apply to application bindings for data sources, EJB references, environment entries, and resource references. ### Method Not applicable (Configuration Section) ### Endpoint Not applicable (Configuration Section) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **data-source** (array) - Optional - Specifies the binding for a data source. - **binding-name** (string) - Optional - The data source binding name. - **id** (string) - Optional - A unique configuration ID. - **name** (string) - Optional - The data source name. - **ejb-ref** (array) - Optional - Specifies the binding for an EJB Reference. - **binding-name** (string) - Optional - The binding name for the EJB reference. - **id** (string) - Optional - A unique configuration ID. - **name** (string) - Optional - The name for the EJB reference. - **env-entry** (array) - Optional - Specifies the binding for an environment entry. - **binding-name** (string) - Optional - The binding name for the environment entry. - **id** (string) - Optional - A unique configuration ID. - **name** (string) - Optional - The name of the environment entry. - **value** (string) - Optional - The value of the environment entry. - **message-destination-ref** (array) - Optional - Specifies the binding for a message destination reference. - **binding-name** (string) - Optional - The binding name for the message destination reference. - **id** (string) - Optional - A unique configuration ID. - **name** (string) - Optional - The name for the message destination reference. - **resource-env-ref** (array) - Optional - Specifies the binding for a resource environment reference. - **binding-name** (string) - Optional - The binding name for the resource environment reference. - **id** (string) - Optional - A unique configuration ID. - **name** (string) - Optional - The name for the resource environment reference. - **resource-ref** (array) - Optional - Specifies the binding for a resource reference. - **binding-name** (string) - Optional - The binding name for the resource reference. - **id** (string) - Optional - A unique configuration ID. - **name** (string) - Optional - The name for the resource reference. - **authentication-alias** (object) - Optional - The authentication alias for the resource reference. - **nameRef** (string) - Optional - The authentication alias name. ### Request Example ```json { "data-source": [ { "binding-name": "jdbc/myDS", "name": "MyDataSource" } ], "ejb-ref": [ { "binding-name": "ejb/MyEJB", "name": "MyEjblet" } ], "resource-ref": [ { "binding-name": "jms/myQueue", "name": "MyQueueResource", "authentication-alias": { "nameRef": "my-auth-alias" } } ] } ``` ### Response #### Success Response (200) - **Configuration details** (object) - Details of the application bindings configuration. #### Response Example ```json { "message": "Application bindings configured successfully." } ``` ``` -------------------------------- ### Configure Executor Start Timeout Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/managedScheduledExecutorService.adoc Specifies a timeout duration for starting tasks. This configuration applies to the time allowed for a task to begin execution after being submitted. ```XML ``` -------------------------------- ### classProvider/application-ext Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/jaasLoginModule.adoc Defines properties to extend applications in OpenLiberty. ```APIDOC ## classProvider > application-ext ### Description Defines properties to extend applications. ### Method N/A (Configuration element) ### Endpoint N/A (Configuration element) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body - **shared-session-context** (boolean) - Optional - Indicates whether the session context is shared between modules. ### Request Example ```json { "shared-session-context": true } ``` ### Response #### Success Response (200) N/A (Configuration element) #### Response Example N/A (Configuration element) ``` -------------------------------- ### Web Application Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/jaasLoginModule.adoc Configure general web application settings such as context root, error pages, and request/response encoding. ```APIDOC ## POST /openliberty/docs-generated ### Description Configures web application extension properties. ### Method POST ### Endpoint /openliberty/docs-generated ### Parameters #### Request Body - **auto-encode-requests** (boolean) - Optional - Determines whether requests are automatically encoded. - **auto-encode-responses** (boolean) - Optional - Determines whether responses are automatically encoded. - **autoload-filters** (boolean) - Optional - Determines whether filters are loaded automatically. - **context-root** (string) - Optional - Defines the context root for a web application. - **default-error-page** (string) - Optional - Specifies a page to be used as the default error page for a web application. - **enable-directory-browsing** (boolean) - Optional - Specifies whether directory browsing is enabled for this web application. - **enable-file-serving** (boolean) - Optional - Specifies whether file serving is enabled for this web application. - **enable-serving-servlets-by-class-name** (boolean) - Optional - Enables serving servlets by classname. - **moduleName** (string) - Optional - The module name specifies the individual module that the binding or extension configuration applies to. - **pre-compile-jsps** (boolean) - Optional - Specifies whether JSP pages are compiled when the web application starts. ### Request Example ```json { "context-root": "/myapp", "pre-compile-jsps": true } ``` ### Response #### Success Response (200) - **message** (string) - Indicates the configuration was successful. #### Response Example ```json { "message": "Web application configuration updated successfully." } ``` ``` -------------------------------- ### Configure TCP Wait to Accept Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/httpEndpoint.adoc Determines if the TCP Channel delays accepting connections until the server starts. If false, connections are closed until the server starts. If true, acceptThread is also set to true. ```properties waitToAccept=true ``` -------------------------------- ### Configure EJB Initialization at Application Start Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/ejbContainer.adoc Specifies whether EJB types are initialized when applications start or when they are first used. This property does not apply to message-driven or startup singleton beans. This property is a boolean. ```xml ``` -------------------------------- ### Class Provider Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/application.adoc Configuration for class provider references, including auto-start, classloader references, location, and Jandex index usage. ```APIDOC ## Class Provider Configuration ### Description List of class provider references. When searching for classes or resources, this class loader will delegate to the specified class providers after searching its own class path. ### Method N/A (Configuration Element) ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ## Configuration Details: - **autoStart** (boolean) - Optional - Configures whether a resource adapter starts automatically upon deployment of the resource adapter or lazily upon injection or lookup of a resource. - **classloaderRef** (A reference to top level classloader element) - Optional - Defines the settings for an application classloader. - **id** (string) - Optional - A unique configuration ID. - **location** (string) - Required - Defines the path of the RAR file to install. - **useJandex** (boolean) - Optional - Enables use of Jandex index files if they are supplied in the application. ``` -------------------------------- ### Configure waitToAccept in Open Liberty Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/iiopEndpoint.adoc Determines if the TCP Channel delays accepting connections until the server starts. If false, connections are closed until the server starts. If true, acceptThread tcpOption is also set to true. ```xml ``` -------------------------------- ### Configure JDBC Driver Libraries Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/databaseStore.adoc Specifies the JARs and native files required for the JDBC driver. This includes visibility settings for API packages. ```XML ... spec,ibm-api,api,stable ``` -------------------------------- ### Configure TCP Wait to Accept Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/wsocOutbound.adoc Determines whether the TCP Channel delays accepting connections until the server has fully started. If false, connections are closed until the server starts; if true, connection acceptance is delayed, and the acceptThread option is also set to true. ```properties +waitToAccept+ boolean +false+ +Queries whether this TCP Channel will delay accepting connections until the server starts. If false, connections are closed until the server starts. If true, the value for the acceptThread tcpOption is also set to true, and connections are delayed until the server starts.+ ``` -------------------------------- ### classProvider/web-ext Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/classloader.adoc Extension properties for web applications. ```APIDOC ## classProvider > web-ext ### Description Extension properties for web applications. ### Parameters #### Request Body - **auto-encode-requests** (boolean) - Determines whether requests are automatically encoded. - **auto-encode-responses** (boolean) - Determines whether responses are automatically encoded. - **autoload-filters** (boolean) - Determines whether filters are loaded automatically. - **context-root** (string) - Defines the context root for a web application. - **default-error-page** (string) - Specifies a page to be used as the default error page for a web application. - **enable-directory-browsing** (boolean) - Specifies whether directory browsing is enabled for this web application. - **enable-file-serving** (boolean) - Specifies whether file serving is enabled for this web application. - **enable-serving-servlets-by-class-name** (boolean) - Enables serving servlets by classname. - **moduleName** (string) - The module name specifies the individual module that the binding or extension configuration applies to. - **pre-compile-jsps** (boolean) - Specifies whether JSP pages are compiled when the web application starts. ### Request Example ```json { "auto-encode-requests": true, "context-root": "/myapp", "enable-file-serving": true } ``` ### Response #### Success Response (200) (No specific response body structure defined, typically indicates successful configuration update) #### Response Example ```json { "message": "Web extension configuration updated" } ``` ``` -------------------------------- ### Configure Connection Acceptance Delay Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/wasJmsEndpoint.adoc Determines if the TCP Channel delays accepting connections until the server has fully started. If false, connections are closed until the server starts. If true, connections are delayed, and the 'acceptThread' tcpOption is also set to true. The default is false. ```properties waitToAccept=true ``` -------------------------------- ### Web Services Bindings Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/springBootApplication.adoc Configuration for web service bindings. ```APIDOC ## Web Services Bindings ### Description Web service bindings are used to customize web services endpoints and configure security settings for both web services providers and web service clients. ### Method N/A (Configuration) ### Endpoint N/A (Configuration) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A (Configuration specific details are nested) ### Request Example N/A (Configuration specific details are nested) ### Response #### Success Response (200) N/A (Configuration) #### Response Example N/A (Configuration) ``` -------------------------------- ### Custom Login Configuration Property Example Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/ejbApplication.adoc Defines a property for a custom login configuration. ```APIDOC ## managed-bean-bnd/interceptor/resource-ref/custom-login-configuration/property ### Description Defines a property for a custom login configuration. ### Method N/A (Configuration Structure) ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **description** (string) - Optional - A description of the property. - **id** (string) - Optional - A unique configuration ID. - **name** (string) - Optional - The name of the property. - **value** (string) - Optional - The value of the property. ### Request Example ```json { "description": "A description for this property.", "id": "prop1", "name": "property.name", "value": "property.value" } ``` ### Response #### Success Response (200) N/A (Configuration Structure) #### Response Example N/A ``` -------------------------------- ### Common Library Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/webApplication.adoc Configures a list of library references, allowing library class instances to be shared with other class loaders. Supports visibility, description, file set references, and unique IDs. ```APIDOC ## POST /config/classloader/commonLibrary ### Description List of library references. Library class instances are shared with other class loaders. ### Method POST ### Endpoint /config/classloader/commonLibrary ### Parameters #### Request Body - **apiTypeVisibility** (string) - Optional - Default: "spec,ibm-api,api,stable". The types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party. - **description** (string) - Optional - Description of shared library for administrators. - **filesetRef** (List of references to top level fileset elements (comma-separated string)) - Optional - Specifies a set of JAR or ZIP files to include in the class path for this library. - **id** (string) - Optional - A unique configuration ID. - **name** (string) - Optional - Name of shared library for administrators. ``` -------------------------------- ### classProvider > startAfter > classloader > privateLibrary > fileset Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/jaasLoginModule.adoc Specifies a set of JAR or ZIP files to include in the class path for this library ```APIDOC ## classProvider > startAfter > classloader > privateLibrary > fileset ### Description Specifies a set of JAR or ZIP files to include in the class path for this library ### Method N/A (Configuration Element) ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body - **caseSensitive** (boolean) - Optional - Boolean to indicate whether or not the search should be case sensitive (default: true). (Default: true) - **dir** (Path to a directory) - Optional - The base directory to search for files. (Default: ${server.config.dir}) - **excludes** (string) - Optional - The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded. - **id** (string) - Optional - A unique configuration ID. - **includes** (string) - Optional - The comma or space separated list of file name patterns to include in the search results (default: *). (Default: *) - **scanInterval** (A period of time with millisecond precision) - Optional - The scanning interval to determine whether files are added or removed from the fileset. The individual files are not scanned. The suffix for the interval of time is h-hour, m-minute, s-second, and ms-millisecond, for example, 2ms or 5s. The scanning interval is disabled by default and is disabled manually by setting the scan interval, scanInterval, to 0. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ``` -------------------------------- ### Configure SAML Token Replay Timeout Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/samlWebSso20.adoc This property is used to specify how long the Liberty SP should prevent token replay. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. ```XML ``` -------------------------------- ### Configure startTimeout for Task Initiation Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/managedScheduledExecutorService.adoc The startTimeout option specifies the maximum time allowed between task submission and task start. By default, tasks do not time out. It is recommended to set the start timeout longer than the maximum wait for enqueue if both are enabled. Updates to startTimeout apply to subsequent task submissions. Timeouts can be specified in hours (h), minutes (m), seconds (s), or milliseconds (ms), and multiple units can be combined. ```XML concurrent-1.0 ``` -------------------------------- ### classProvider/web-ext/resource-ref Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/classloader.adoc Properties for a resource reference. ```APIDOC ## classProvider > web-ext > resource-ref ### Description Properties for a resource reference. ### Parameters #### Request Body - **branch-coupling** (string) - Enum: LOOSE, TIGHT. Specifies whether loose or tight coupling is used. - **commit-priority** (int) - Default: 0. Defines the commit priority for the resource reference. - **id** (string) - A unique configuration ID. - **isolation-level** (string) - Enum: TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE. Defines the transaction isolation level. - **name** (string) - The name for the resource reference. ### Request Example ```json { "id": "resourceRef1", "name": "jdbc/myDB", "branch-coupling": "LOOSE", "isolation-level": "TRANSACTION_READ_COMMITTED" } ``` ### Response #### Success Response (200) (No specific response body structure defined, typically indicates successful configuration update) #### Response Example ```json { "message": "Resource reference configured" } ``` ``` -------------------------------- ### Resource Adapter Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/application.adoc Configuration options for resource adapters, including how to override the default identifier and control auto-start behavior. ```APIDOC ## Resource Adapter Configuration ### Description Overrides the default identifier for the resource adapter. The identifier is used in the name of the resource adapter's configuration properties element, which in turn is used in determining the name of configuration properties elements for any resources provided by the resource adapter. The resource adapter's configuration properties element name has the format, properties.., where is the name of the application and is the configured alias. If unspecified, the alias defaults to the module name of the resource adapter. Configures whether a resource adapter starts automatically upon deployment of the resource adapter or lazily upon injection or lookup of a resource. ### Parameters #### Request Body - **autoStart** (boolean) - Optional - Configures whether a resource adapter starts automatically upon deployment of the resource adapter or lazily upon injection or lookup of a resource. - **id** (string) - Required - Identifies the name of the embedded resource adapter module to which this configuration applies. - **contextServiceRef** (string) - Optional - A reference to top level contextService element. ### Request Example ```json { "autoStart": true, "id": "myResourceAdapter", "contextServiceRef": "myContextService" } ``` ### Response #### Success Response (200) (No specific success response fields are detailed in the provided text for this section.) #### Response Example ```json { "status": "success" } ``` ``` -------------------------------- ### Configure Member Connect Timeout Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/transaction.adoc Specifies the connection timeout for members in seconds. Example: 30s. ```Java jdbc:derby://host:port/databaseName:user=user;password=password;memberConnectTimeout=10s ``` -------------------------------- ### Configure Library Class Path with Folder Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/openidConnectProvider.adoc This configuration allows you to add a folder to the class path for a library. Classes and resources within the specified folder and its subfolders become available for loading. JAR and ZIP files within this folder are not directly added to the class path. ```XML /path/to/your/classes ``` -------------------------------- ### Configure JDBC retrieveMessagesFromServerOnGetMessage Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/dataSource.adoc Configures whether to retrieve messages from the server on get message for the JDBC connection. ```properties jdbcCollection.retrieveMessagesFromServerOnGetMessage=true ``` -------------------------------- ### Common Library Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/jaasLoginModule.adoc Manages shared libraries, specifying API visibility, description, and references to filesets. ```APIDOC ## Common Library Configuration ### Description List of library references. Library class instances are shared with other class loaders. ### Method N/A (Configuration element) ### Endpoint N/A (Configuration element) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body - **apiTypeVisibility** (string) - Optional - The types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party. (Default: spec,ibm-api,api,stable) - **description** (string) - Optional - Description of shared library for administrators - **filesetRef** (List of references to top level fileset elements (comma-separated string)) - Optional - Specifies a set of JAR or ZIP files to include in the class path for this library - **id** (string) - Required - A unique configuration ID. - **name** (string) - Optional - Name of shared library for administrators ### Request Example ```json { "id": "myCommonLibrary", "name": "SharedAppLibrary", "apiTypeVisibility": "spec,api", "filesetRef": "myFileset1,myFileset2" } ``` ### Response #### Success Response (200) N/A (Configuration element) #### Response Example ```json { "message": "Common library configured" } ``` ``` -------------------------------- ### Configure Encryption Keystore Provider Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/wsSecurityProvider.adoc Specifies the provider used to load keystores for encryption. Defaults to the installed provider. ```properties +org.apache.ws.security.crypto.merlin.keystore.provider+ = The provider used to load keystores. ``` -------------------------------- ### Application Client Bindings Configuration Source: https://github.com/openliberty/docs-generated/blob/vNext/modules/reference/pages/config/webApplication.adoc This section details configuration properties for application client bindings, including data sources, EJB references, environment entries, and message destination references. ```APIDOC ## Application Client Bindings Configuration ### Description Defines properties that apply to application clients. ### Endpoint `/application-client-bnd` ## Data Source ### Description Defines a data source for an application client. ### Endpoint `/application-client-bnd/data-source` ### Parameters #### Path Parameters - `data-source` (string) - Description of the data source. #### Request Body - **binding-name** (string) - Required - The data source binding name. - **id** (string) - Required - A unique configuration ID. - **name** (string) - Required - The data source name. ## EJB Reference ### Description EJB References in an application client. ### Endpoint `/application-client-bnd/ejb-ref` ### Parameters #### Path Parameters - `ejb-ref` (string) - Description of the EJB reference. #### Request Body - **binding-name** (string) - Required - The binding name for the EJB reference. - **id** (string) - Required - A unique configuration ID. - **name** (string) - Required - The name for the EJB reference. ## Environment Entry ### Description Defines an environment entry for an application client. ### Endpoint `/application-client-bnd/env-entry` ### Parameters #### Path Parameters - `env-entry` (string) - Description of the environment entry. #### Request Body - **binding-name** (string) - Required - The binding name for the environment entry. - **id** (string) - Required - A unique configuration ID. - **name** (string) - Required - The name of the environment entry. - **value** (string) - Required - The value of the environment entry. ## Message Destination Reference ### Description Message destination reference in an application client. ### Endpoint `/application-client-bnd/message-destination-ref` ### Parameters #### Path Parameters - `message-destination-ref` (string) - Description of the message destination reference. #### Request Body - **binding-name** (string) - Required - The binding name for the message destination reference. - **id** (string) - Required - A unique configuration ID. - **name** (string) - Required - The name of the message destination reference. ```