Package springfox.documentation.swagger.web

Class SecurityConfigurationBuilder

  • public class SecurityConfigurationBuilder
extends java.lang.Object

    • Method Detail

      • clientId

        public SecurityConfigurationBuilder clientId​(java.lang.String clientId)
        Parameters:
        clientId - Default clientId.
        Returns:
        this

      • clientSecret

        public SecurityConfigurationBuilder clientSecret​(java.lang.String clientSecret)
        Parameters:
        clientSecret - Default clientSecret.
        Returns:
        this

      • realm

        public SecurityConfigurationBuilder realm​(java.lang.String realm)
        Parameters:
        realm - Realm query parameter (for oauth1) added to authorizationUrl and tokenUrl.
        Returns:
        this

      • appName

        public SecurityConfigurationBuilder appName​(java.lang.String appName)
        Parameters:
        appName - Application name, displayed in authorization popup.
        Returns:
        this

      • scopeSeparator

        public SecurityConfigurationBuilder scopeSeparator​(java.lang.String scopeSeparator)
        Parameters:
        scopeSeparator - Scope separator for passing scopes, encoded before calling, default value is a space (encoded value %20).
        Returns:
        this

      • additionalQueryStringParams

        public SecurityConfigurationBuilder additionalQueryStringParams​(java.util.Map<java.lang.String,​java.lang.Object> additionalQueryStringParams)
        Parameters:
        additionalQueryStringParams - Additional query parameters added to authorizationUrl and tokenUrl.
        Returns:
        this

      • useBasicAuthenticationWithAccessCodeGrant

        public SecurityConfigurationBuilder useBasicAuthenticationWithAccessCodeGrant​(java.lang.Boolean useBasicAuthenticationWithAccessCodeGrant)
        Parameters:
        useBasicAuthenticationWithAccessCodeGrant - Only activated for the accessCode flow. During the authorization_code request to the tokenUrl, pass the Client Password using the HTTP Basic Authentication scheme (Authorization header with Basic base64encoded[client_id:client_secret]). The default is false.
        Returns:
        this

      • enableCsrfSupport

        public SecurityConfigurationBuilder enableCsrfSupport​(java.lang.Boolean enableCsrfSupport)
        Parameters:
        enableCsrfSupport - Try to find csrf token and add it to the header of all requests by patching the requestInterceptor.
        Returns:
        this