Module io.helidon.security
Package io.helidon.security

Class OutboundSecurityResponse.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • build

        public OutboundSecurityResponse build()
        Build identity propagation response based on this builder.
        Returns:
        identity propagation response

      • statusCode

        public T statusCode​(int statusCode)
        Set a status code for failed statuses. This is expected to use HTTP status codes. If an integration is done with a non-http protocol, you must map these status codes appropriately.
        Parameters:
        statusCode - HTTP status code
        Returns:
        updated builder instance

      • status

        public T status​(SecurityResponse.SecurityStatus status)
        Set security status of this security response.
        Parameters:
        status - Status to set
        Returns:
        updated builder instance

      • description

        public T description​(String description)
        Set description of this security response failure.
        Parameters:
        description - Description to provide to called in case of failed security, or null if no information can be provided
        Returns:
        updated builder instance

      • throwable

        public T throwable​(Throwable exception)
        Set throwable causing failure of the security request.
        Parameters:
        exception - Exception that caused failure
        Returns:
        updated builder instance

      • requestHeaders

        public T requestHeaders​(Map<String,​List<String>> headers)
        Set additional/replacement headers for request.
        Parameters:
        headers - map with headers
        Returns:
        updated builder instance

      • requestHeader

        public T requestHeader​(String header,
                       String value)
        Add a single-value header. Note that if method requestHeaders(Map) is called after this method, it will remove changes by this method.
        Parameters:
        header - header name
        value - header value
        Returns:
        this instance

      • requestHeader

        public T requestHeader​(String header,
                       List<String> values)
        Add a multi-value header. Note that if method requestHeaders(Map) is called after this method, it may remove changes by this method.
        Parameters:
        header - header name
        values - header values
        Returns:
        this instance

      • responseHeaders

        public T responseHeaders​(Map<String,​List<String>> headers)
        Set additional/replacement headers for request.
        Parameters:
        headers - map with headers
        Returns:
        updated builder instance

      • responseHeader

        public T responseHeader​(String header,
                        String value)
        Add a single-value header. Note that if method responseHeaders(Map) is called after this method, it will remove changes by this method.
        Parameters:
        header - header name
        value - header value
        Returns:
        this instance

      • responseHeader

        public T responseHeader​(String header,
                        List<String> values)
        Add a multi-value header. Note that if method responseHeaders(Map) is called after this method, it may remove changes by this method.
        Parameters:
        header - header name
        values - header values
        Returns:
        this instance