Package io.micronaut.http.server.cors

Class CorsOriginConfiguration

  • public class CorsOriginConfiguration
extends java.lang.Object
    Stores configuration for CORS.
    Since:
    1.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.util.List<java.lang.String> ANY
      Constant to represent any value.
      static java.util.List<io.micronaut.http.HttpMethod> ANY_METHOD
      Constant to represent any method.

    • Field Detail

      • ANY

        public static final java.util.List<java.lang.String> ANY
        Constant to represent any value.

      • ANY_METHOD

        public static final java.util.List<io.micronaut.http.HttpMethod> ANY_METHOD
        Constant to represent any method.

    • Constructor Detail

      • CorsOriginConfiguration

        public CorsOriginConfiguration()

    • Method Detail

      • getAllowedOrigins

        public java.util.List<java.lang.String> getAllowedOrigins()
        Returns:
        The allowed origins

      • setAllowedOrigins

        public void setAllowedOrigins​(@Nullable
                              java.util.List<java.lang.String> allowedOrigins)
        Sets the allowed origins.
        Parameters:
        allowedOrigins - The allow origins

      • getAllowedOriginsRegex

        @NonNull
public java.util.Optional<java.lang.String> getAllowedOriginsRegex()
        Returns:
        a regular expression for matching Allowed Origins.

      • setAllowedOriginsRegex

        public void setAllowedOriginsRegex​(java.lang.String allowedOriginsRegex)
        Sets a regular expression for matching Allowed Origins.
        Parameters:
        allowedOriginsRegex - a regular expression for matching Allowed Origins.

      • getAllowedMethods

        public java.util.List<io.micronaut.http.HttpMethod> getAllowedMethods()
        Returns:
        The allowed methods

      • setAllowedMethods

        public void setAllowedMethods​(@Nullable
                              java.util.List<io.micronaut.http.HttpMethod> allowedMethods)
        Sets the allowed methods.
        Parameters:
        allowedMethods - The allowed methods

      • getAllowedHeaders

        public java.util.List<java.lang.String> getAllowedHeaders()
        Returns:
        The allowed headers

      • setAllowedHeaders

        public void setAllowedHeaders​(@Nullable
                              java.util.List<java.lang.String> allowedHeaders)
        Sets the allowed headers.
        Parameters:
        allowedHeaders - The allowed headers

      • getExposedHeaders

        public java.util.List<java.lang.String> getExposedHeaders()
        Returns:
        The exposed headers

      • setExposedHeaders

        public void setExposedHeaders​(@Nullable
                              java.util.List<java.lang.String> exposedHeaders)
        Sets the exposed headers.
        Parameters:
        exposedHeaders - The exposed headers

      • isAllowCredentials

        public boolean isAllowCredentials()
        Returns:
        Whether to allow credentials

      • setAllowCredentials

        public void setAllowCredentials​(boolean allowCredentials)
        Sets whether to allow credentials.
        Parameters:
        allowCredentials - The credentials

      • getMaxAge

        public java.lang.Long getMaxAge()
        Returns:
        The max age. A value of -1 indicates no max age

      • setMaxAge

        public void setMaxAge​(@Nullable
                      java.lang.Long maxAge)
        Sets the max age.
        Parameters:
        maxAge - The max age