Class Config

java.lang.Object
com.oracle.coherence.rag.api.Config

@ApplicationScoped @Path("/api/_config") public class Config extends Object
REST API endpoint for managing Coherence configuration properties.

This JAX-RS resource provides HTTP endpoints for retrieving and updating configuration properties in the Coherence RAG framework. It enables dynamic configuration management through a RESTful interface, allowing clients to read and modify configuration values at runtime.

The configuration management is backed by Coherence's distributed configuration capabilities, ensuring that configuration changes are propagated across all cluster members.

Available endpoints:

  • GET /api/_config/{property} - Retrieve a configuration property value
  • PUT /api/_config/{property} - Set a configuration property value

Since:
25.09
Author:
Aleks Seovic 2025.07.04
  • Constructor Details

    • Config

      public Config()
  • Method Details

    • get

      @GET @Path("{property}") @Produces("text/plain") public jakarta.ws.rs.core.Response get(@PathParam("property") String property)
      Retrieves the value of a configuration property.

      This endpoint returns the current value of the specified configuration property. If the property does not exist, a 404 Not Found response is returned.

      Parameters:
      property - the name of the configuration property to retrieve
      Returns:
      a Response containing the property value as plain text, or 404 Not Found if the property does not exist
    • set

      @PUT @Path("{property}") @Consumes("text/plain") @Produces("text/plain") public jakarta.ws.rs.core.Response set(@PathParam("property") String property, String value)
      Sets the value of a configuration property.

      This endpoint updates the specified configuration property with a new value. The change is propagated across all cluster members and takes effect immediately.

      Parameters:
      property - the name of the configuration property to set
      value - the new value to assign to the property
      Returns:
      a Response containing the previous property value as plain text, or null if the property was not previously set