Package tech.lastbox.lastshield.security.core

Class CorsConfig

java.lang.Object
tech.lastbox.lastshield.security.core.CorsConfig
@Configuration public class CorsConfig extends Object
The CorsConfig class is responsible for configuring Cross-Origin Resource Sharing (CORS) settings for the application. It allows defining allowed origins, methods, headers, and whether credentials are allowed.

This configuration is used to control which domains can access resources in your application and how cross-origin requests are handled.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CorsConfig()
    Default constructor for the CorsConfig class.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.security.config.Customizer<org.springframework.security.config.annotation.web.configurers.CorsConfigurer<org.springframework.security.config.annotation.web.builders.HttpSecurity>>
    configure()
    Configures CORS settings for HTTP security by returning a Customizer that customizes the CorsConfigurer for HTTP security.
    void
    setAllowCredentials(Boolean allowCredentials)
    Sets whether credentials (cookies, HTTP authentication, etc.) are allowed in cross-origin requests.
    void
    setAllowedHeaders(String header)
    Sets the allowed headers for cross-origin requests.
    void
    setAllowedHeaders(List<String> allowedHeaders)
    Sets the allowed headers for cross-origin requests.
    void
    setAllowedMethods(String method)
    Sets the allowed HTTP methods for cross-origin requests.
    void
    setAllowedMethods(List<String> allowedMethods)
    Sets the allowed HTTP methods for cross-origin requests.
    void
    setAllowedOrigins(String origin)
    Sets the allowed origins for cross-origin requests.
    void
    setAllowedOrigins(List<String> allowedOrigins)
    Sets the allowed origins for cross-origin requests.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CorsConfig

      public CorsConfig()
      Default constructor for the CorsConfig class. This constructor is used to instantiate the CorsConfig class.

  • Method Details

    • configure

      @Bean public org.springframework.security.config.Customizer<org.springframework.security.config.annotation.web.configurers.CorsConfigurer<org.springframework.security.config.annotation.web.builders.HttpSecurity>> configure()
      Configures CORS settings for HTTP security by returning a Customizer that customizes the CorsConfigurer for HTTP security. This method is invoked to apply CORS configurations, such as allowed origins, methods, headers, and credentials, to the HTTP security configuration.

      If the attributes allowedOrigins, allowedMethods, allowedHeaders, or allowCredentials are not set, default values will be applied, effectively allowing unrestricted CORS access.

      The returned Customizer is used to configure the CorsConfigurer as part of the security filter chain, enabling fine-grained control over cross-origin request handling in the application.

      Returns:
      a Customizer that applies CORS settings to HTTP security.

    • setAllowedOrigins

      public void setAllowedOrigins(String origin)
      Sets the allowed origins for cross-origin requests.
      Parameters:
      origin - a single allowed origin to be added to the list.

    • setAllowedOrigins

      public void setAllowedOrigins(List<String> allowedOrigins)
      Sets the allowed origins for cross-origin requests.
      Parameters:
      allowedOrigins - a list of allowed origins for cross-origin requests.

    • setAllowedMethods

      public void setAllowedMethods(String method)
      Sets the allowed HTTP methods for cross-origin requests.
      Parameters:
      method - a single allowed HTTP method (e.g., GET, POST) to be added to the list.

    • setAllowedMethods

      public void setAllowedMethods(List<String> allowedMethods)
      Sets the allowed HTTP methods for cross-origin requests.
      Parameters:
      allowedMethods - a list of allowed HTTP methods (e.g., GET, POST, PUT, DELETE).

    • setAllowedHeaders

      public void setAllowedHeaders(String header)
      Sets the allowed headers for cross-origin requests.
      Parameters:
      header - a single allowed header to be added to the list.

    • setAllowedHeaders

      public void setAllowedHeaders(List<String> allowedHeaders)
      Sets the allowed headers for cross-origin requests.
      Parameters:
      allowedHeaders - a list of allowed headers for cross-origin requests.

    • setAllowCredentials

      public void setAllowCredentials(Boolean allowCredentials)
      Sets whether credentials (cookies, HTTP authentication, etc.) are allowed in cross-origin requests.
      Parameters:
      allowCredentials - true to allow credentials, false to disallow credentials.