Package ai.yda.framework.channel.rest.spring

Class RestSpringProperties

java.lang.Object
ai.yda.framework.channel.shared.RestChannelProperties
ai.yda.framework.channel.rest.spring.RestSpringProperties
@ConfigurationProperties("ai.yda.framework.channel.rest.spring") public class RestSpringProperties extends ai.yda.framework.channel.shared.RestChannelProperties
Provides configuration properties for the REST Spring Channel. This class holds the configurable properties used in the REST Channel. These properties can be customized through the application’s external configuration, such as a properties file, YAML file, or environment variables. The properties include settings like the endpoint's relative path and other configurations relevant to the REST API.

The properties are prefixed with CONFIG_PREFIX and can be customized by defining values under this prefix in the external configuration. Below are the properties that can be configured: 

 Example configuration in a YAML file:

 ai:
   yda:
     framework:
       channel:
         rest:
           spring:
             endpointRelativePath: /api/v1
             securityToken: your-security-token
Since:
0.1.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CONFIG_PREFIX
    The configuration prefix used to reference properties related to this Channel in application configurations.

    Fields inherited from class ai.yda.framework.channel.shared.RestChannelProperties

    DEFAULT_ENDPOINT_RELATIVE_PATH

  • Constructor Summary

    Constructors
    Constructor
    Description
    RestSpringProperties()
    Default constructor for RestSpringProperties.

  • Method Summary

    Methods inherited from class ai.yda.framework.channel.shared.RestChannelProperties

    getAllowedMethods, getAllowedOrigins, getCorsEnabled, getEndpointRelativePath, getSecurityToken, setAllowedMethods, setAllowedOrigins, setCorsEnabled, setEndpointRelativePath, setSecurityToken

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • CONFIG_PREFIX

      public static final String CONFIG_PREFIX
      The configuration prefix used to reference properties related to this Channel in application configurations. This prefix is used for binding properties within the particular namespace.
      See Also:

  • Constructor Details