config.io_helidon_cors_CrossOriginConfig.adoc Maven / Gradle / Ivy
///////////////////////////////////////////////////////////////////////////////
Copyright (c) 2024 Oracle and/or its affiliates.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
///////////////////////////////////////////////////////////////////////////////
ifndef::rootdir[:rootdir: {docdir}/..]
:description: Configuration of io.helidon.cors.CrossOriginConfig
:keywords: helidon, config, io.helidon.cors.CrossOriginConfig
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.cors.CrossOriginConfig
include::{rootdir}/includes/attributes.adoc[]
= CrossOriginConfig (cors) Configuration
// tag::config[]
Type: link:{javadoc-base-url}/io.helidon.cors/io/helidon/cors/CrossOriginConfig.html[io.helidon.cors.CrossOriginConfig]
== Configuration options
.Optional configuration options
[cols="3,3a,2,5a"]
|===
|key |type |default value |description
|`allow-credentials` |boolean |`false` |Sets the allow credentials flag.
|`allow-headers` |string[] |`*` |Sets the allow headers.
|`allow-methods` |string[] |`*` |Sets the allow methods.
|`allow-origins` |string[] |`*` |Sets the allowOrigins.
|`enabled` |boolean |`true` |Sets whether this config should be enabled or not.
|`expose-headers` |string[] |{nbsp} |Sets the expose headers.
|`max-age-seconds` |long |`3600` |Sets the maximum age.
|`path-pattern` |string |`{+}` |Updates the path prefix for this cross-origin config.
|===
// end::config[]