Class CorsPolicy.Builder

  • Enclosing class:
    CorsPolicy

    public static class CorsPolicy.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • allowedOrigins

        public CorsPolicy.Builder allowedOrigins​(List<String> allowedOrigins)
        The list of allowed origins that the CORS handler will use to respond to CORS requests.

        The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. ‘*’ will match any origins, and ‘null’ will match queries from ‘file:’ origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.

        Parameters:
        allowedOrigins - the value to set
        Returns:
        this builder
      • allowedMethods

        public CorsPolicy.Builder allowedMethods​(List<String> allowedMethods)
        The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header.

        ‘*’ will allow all methods.

        Parameters:
        allowedMethods - the value to set
        Returns:
        this builder
      • allowedHeaders

        public CorsPolicy.Builder allowedHeaders​(List<String> allowedHeaders)
        The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header.

        ‘*’ will allow all headers.

        Parameters:
        allowedHeaders - the value to set
        Returns:
        this builder
      • exposedHeaders

        public CorsPolicy.Builder exposedHeaders​(List<String> exposedHeaders)
        The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header.

        ‘*’ will expose all headers.

        Parameters:
        exposedHeaders - the value to set
        Returns:
        this builder
      • isAllowCredentialsEnabled

        public CorsPolicy.Builder isAllowCredentialsEnabled​(Boolean isAllowCredentialsEnabled)
        Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
        Parameters:
        isAllowCredentialsEnabled - the value to set
        Returns:
        this builder
      • maxAgeInSeconds

        public CorsPolicy.Builder maxAgeInSeconds​(Integer maxAgeInSeconds)
        The time in seconds for the client to cache preflight responses.

        This is sent as the Access-Control-Max-Age if greater than 0.

        Parameters:
        maxAgeInSeconds - the value to set
        Returns:
        this builder