Package io.fabric8.kubernetes.api.model.gatewayapi.v1

Class HTTPAuthConfig

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<HTTPAuthConfigBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class HTTPAuthConfig
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<HTTPAuthConfigBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    HTTPAuthConfig contains configuration for communication with HTTP-speaking backends.
    See Also:
    Serialized Form

    • Constructor Detail

      • HTTPAuthConfig

        public HTTPAuthConfig()
        No args constructor for use in serialization

    • Method Detail

      • getAllowedHeaders

        public List<String> getAllowedHeaders()
        AllowedRequestHeaders specifies what additional headers from the client request will be sent to the authorization server.


        The following headers must always be sent to the authorization server, regardless of this setting:


        * `Host` * `Method` * `Path` * `Content-Length` * `Authorization`


        If this list is empty, then only those headers must be sent.


        Note that `Content-Length` has a special behavior, in that the length sent must be correct for the actual request to the external authorization server - that is, it must reflect the actual number of bytes sent in the body of the request to the authorization server.


        So if the `forwardBody` stanza is unset, or `forwardBody.maxSize` is set to `0`, then `Content-Length` must be `0`. If `forwardBody.maxSize` is set to anything other than `0`, then the `Content-Length` of the authorization request must be set to the actual number of bytes forwarded.

      • setAllowedHeaders

        public void setAllowedHeaders​(List<String> allowedHeaders)
        AllowedRequestHeaders specifies what additional headers from the client request will be sent to the authorization server.


        The following headers must always be sent to the authorization server, regardless of this setting:


        * `Host` * `Method` * `Path` * `Content-Length` * `Authorization`


        If this list is empty, then only those headers must be sent.


        Note that `Content-Length` has a special behavior, in that the length sent must be correct for the actual request to the external authorization server - that is, it must reflect the actual number of bytes sent in the body of the request to the authorization server.


        So if the `forwardBody` stanza is unset, or `forwardBody.maxSize` is set to `0`, then `Content-Length` must be `0`. If `forwardBody.maxSize` is set to anything other than `0`, then the `Content-Length` of the authorization request must be set to the actual number of bytes forwarded.

      • getAllowedResponseHeaders

        public List<String> getAllowedResponseHeaders()
        AllowedResponseHeaders specifies what headers from the authorization response will be copied into the request to the backend.


        If this list is empty, then all headers from the authorization server except Authority or Host must be copied.

      • setAllowedResponseHeaders

        public void setAllowedResponseHeaders​(List<String> allowedResponseHeaders)
        AllowedResponseHeaders specifies what headers from the authorization response will be copied into the request to the backend.


        If this list is empty, then all headers from the authorization server except Authority or Host must be copied.

      • getPath

        public String getPath()
        Path sets the prefix that paths from the client request will have added when forwarded to the authorization server.


        When empty or unspecified, no prefix is added.


        Valid values are the same as the "value" regex for path values in the `match` stanza, and the validation regex will screen out invalid paths in the same way. Even with the validation, implementations MUST sanitize this input before using it directly.

      • setPath

        public void setPath​(String path)
        Path sets the prefix that paths from the client request will have added when forwarded to the authorization server.


        When empty or unspecified, no prefix is added.


        Valid values are the same as the "value" regex for path values in the `match` stanza, and the validation regex will screen out invalid paths in the same way. Even with the validation, implementations MUST sanitize this input before using it directly.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)