方法详细信息

• forAnyOrigin

  public static CorsConfigBuilder forAnyOrigin()

  创建一个Builder实例，它的原点设置为'*'。

  结果

  Builder支持方法链接。

• forOrigin

  public static CorsConfigBuilder forOrigin(java.lang.String origin)

  用指定的原点创建一个CorsConfigBuilder实例。

  结果

  CorsConfigBuilder支持方法链接。

• forOrigins

  public static CorsConfigBuilder forOrigins(java.lang.String... origins)

  用指定的来源创建一个CorsConfigBuilder实例。

  结果

  CorsConfigBuilder支持方法链接。

• allowNullOrigin

  public CorsConfigBuilder allowNullOrigin()

  如果从本地文件系统加载资源，Web浏览器可能会将'Origin'请求标头设置为'null'。 调用此方法将启用成功的CORS响应，CORS响应头“Access-Control-Allow-Origin”的值为"null" 。

  结果

  CorsConfigBuilder支持方法链接。

• disable

  public CorsConfigBuilder disable()

  禁用CORS支持。

  结果

  CorsConfigBuilder支持方法链接。

• exposeHeaders

  public CorsConfigBuilder exposeHeaders(java.lang.String... headers)

  指定要显示给呼叫客户端的头文件。 在简单的CORS请求期间，浏览器只能使用某些响应头，例如使用：

    xhr.getResponseHeader("Content-Type"); 

  默认情况下可用的标题是：

  • 缓存控制
  • 内容语言
  • 内容类型
  • 过期
  • 上一次更改
  • 附注

  为了公开其他头文件，需要指定哪些方法是通过将头文件添加到CORS的Access-Control-Expose-Headers响应头中来实现的。

  参数

  headers - 要添加到“Access-Control-Expose-Headers”响应头中的值

  结果

  CorsConfigBuilder支持方法链接。

• exposeHeaders

  public CorsConfigBuilder exposeHeaders(java.lang.CharSequence... headers)

  指定要显示给呼叫客户端的头文件。 在简单的CORS请求期间，浏览器只能使用某些响应头，例如使用：

    xhr.getResponseHeader(HttpHeaderNames.CONTENT_TYPE); 

  默认情况下可用的标题是：

  • 缓存控制
  • 内容语言
  • 内容类型
  • 过期
  • 上一次更改
  • 附注

  为了公开其他头文件，需要指定哪些方法是通过将头文件添加到CORS的Access-Control-Expose-Headers响应头中来实现的。

  参数

  headers - 要添加到“Access-Control-Expose-Headers”响应标头的值

  结果

  CorsConfigBuilder支持方法链接。

• allowCredentials

  public CorsConfigBuilder allowCredentials()

  默认情况下，Cookie不包含在CORS请求中，但是这种方法将启用cookies以添加到CORS请求中。 调用这个方法会将CORS的Access-Control-Allow-Credentials响应头设置为true。 请注意，该cookie支持也需要在客户端启用。 客户需要选择通过以下方式发送cookie：

    xhr.withCredentials = true; 

  'withCredentials'的默认值为false，在这种情况下，不发送cookie。 如果将此设置为true，则会在交叉源请求中包含Cookie。

  结果

  CorsConfigBuilder支持方法链接。

• maxAge

  public CorsConfigBuilder maxAge(long max)

  当进行预检请求时，客户端必须执行两个请求，效率可能很低。 此设置将设置CORS的“Access-Control-Max-Age”响应标题，并启用指定时间的预检响应缓存。 在此期间，不会进行预检请求。

  参数

  max - 可以高速缓存预检响应的最长时间（以秒为单位）。

  结果

  CorsConfigBuilder支持方法链接。

• allowedRequestMethods

  public CorsConfigBuilder allowedRequestMethods(HttpMethod... methods)

  指定应该在CORS的“访问控制请求方法”响应头中返回的允许的HTTP请求方法集。

  参数

  methods - 应该允许的HttpMethod 。

  结果

  CorsConfigBuilder支持方法链接。

• allowedRequestHeaders

  public CorsConfigBuilder allowedRequestHeaders(java.lang.String... headers)

  指定CORS'Access-Control-Allow-Headers'响应头中应该返回的if头。 如果客户端在请求中指定了标头，例如通过调用：

    xhr.setRequestHeader('My-Custom-Header', "SomeValue"); 

  服务器将在预检请求的'Access-Control-Request-Headers'中接收上述标题名称。 然后，服务器将决定是否允许为真正的请求发送此头（请记住，预检不是真正的请求，而是请求服务器是否允许请求）。

  参数

  headers - 要添加到预检'Access-Control-Allow-Headers'响应标题中的标题。

  结果

  CorsConfigBuilder支持方法链接。

• allowedRequestHeaders

  public CorsConfigBuilder allowedRequestHeaders(java.lang.CharSequence... headers)

  指定CORS'Access-Control-Allow-Headers'响应头中应该返回的if头。 如果客户端在请求中指定了标头，例如通过调用：

    xhr.setRequestHeader('My-Custom-Header', "SomeValue"); 

  服务器将在预检请求的'Access-Control-Request-Headers'中接收上述标题名称。 然后，服务器将决定是否允许为真正的请求发送此头（请记住，预检不是真正的请求，而是请求服务器是否允许请求）。

  参数

  headers - 要添加到预检'Access-Control-Allow-Headers'响应标题中的标题。

  结果

  CorsConfigBuilder支持方法链接。

• preflightResponseHeader

  public CorsConfigBuilder preflightResponseHeader(java.lang.CharSequence name,
                                                   java.lang.Object... values)

  返回应该添加到CORS预检响应中的HTTP响应标头。 像负载均衡器这样的中介可能会要求CORS预检请求设置了某些标题。 这使得可以添加这样的头部。

  参数

  name - HTTP标头的名称。

  values - HTTP标头的值。

  结果

  CorsConfigBuilder支持方法链接。

• preflightResponseHeader

  public <T> CorsConfigBuilder preflightResponseHeader(java.lang.CharSequence name,
                                                       java.lang.Iterable<T> value)

  返回应该添加到CORS预检响应中的HTTP响应标头。 像负载均衡器这样的中介可能会要求CORS预检请求设置了某些标题。 这使得可以添加这样的头部。

  参数类型

  T - Iterable包含的值的类型。

  参数

  name - HTTP标头的名称。

  value - HTTP标头的值。

  结果

  CorsConfigBuilder支持方法链接。

• preflightResponseHeader

  public <T> CorsConfigBuilder preflightResponseHeader(java.lang.CharSequence name,
                                                       java.util.concurrent.Callable<T> valueGenerator)

  返回应该添加到CORS预检响应中的HTTP响应标头。 像负载均衡器这样的中介可能会要求CORS预检请求设置了某些标题。 这使得可以添加这样的头部。 一些值必须在创建HTTP响应时动态创建，例如'Date'响应头。 这可以通过使用Callable来完成，当创建HTTP响应时，Callable将调用其“调用”方法。

  参数类型

  T - Callable可以返回的值的类型。

  参数

  name - HTTP标题的名称。

  valueGenerator - 将在创建HTTP响应时调用的Callable。

  结果

  CorsConfigBuilder支持方法链接。

• noPreflightResponseHeaders

  public CorsConfigBuilder noPreflightResponseHeaders()

  指定不应将预检响应标题添加到预检响应。

  结果

  CorsConfigBuilder支持方法链接。

• shortCircuit

  public CorsConfigBuilder shortCircuit()

  指定CORS请求在进一步处理之前应该被拒绝。 在处理请求后设置CORS头。 这可能并不总是需要的，这个设置将检查Origin是否有效，如果它不是有效的，则不会进行进一步的处理，并且错误将被返回给呼叫客户端。

  结果

  CorsConfigBuilder支持方法链接。

• build

  public CorsConfig build()

  使用以前的方法调用指定的设置构建CorsConfig 。

  结果

  CorsConfig配置的CorsConfig实例。