Package org.springdoc.core

Class SwaggerUiOAuthProperties

  • @Lazy(false)
@Configuration(proxyBeanMethods=false)
@ConfigurationProperties(prefix="springdoc.swagger-ui.oauth")
@ConditionalOnProperty(name="springdoc.swagger-ui.enabled",
                       matchIfMissing=true)
@ConditionalOnBean(SpringDocConfiguration.class)
public class SwaggerUiOAuthProperties
extends Object
    Please refer to the swagger configuration.md to get the idea what each parameter does.
    Author:
    bnasslahsen

    • Constructor Detail

      • SwaggerUiOAuthProperties

        public SwaggerUiOAuthProperties()

    • Method Detail

      • getConfigParameters

        public Map<String,​Object> getConfigParameters()
        Gets config parameters.
        Returns:
        the config parameters

      • getClientId

        public String getClientId()
        Gets client id.
        Returns:
        the client id

      • setClientId

        public void setClientId​(String clientId)
        Sets client id.
        Parameters:
        clientId - the client id

      • getClientSecret

        public String getClientSecret()
        Gets client secret.
        Returns:
        the client secret

      • setClientSecret

        public void setClientSecret​(String clientSecret)
        Sets client secret.
        Parameters:
        clientSecret - the client secret

      • getRealm

        public String getRealm()
        Gets realm.
        Returns:
        the realm

      • setRealm

        public void setRealm​(String realm)
        Sets realm.
        Parameters:
        realm - the realm

      • getAppName

        public String getAppName()
        Gets app name.
        Returns:
        the app name

      • setAppName

        public void setAppName​(String appName)
        Sets app name.
        Parameters:
        appName - the app name

      • getScopeSeparator

        public String getScopeSeparator()
        Gets scope separator.
        Returns:
        the scope separator

      • setScopeSeparator

        public void setScopeSeparator​(String scopeSeparator)
        Sets scope separator.
        Parameters:
        scopeSeparator - the scope separator

      • getAdditionalQueryStringParams

        public Map<String,​String> getAdditionalQueryStringParams()
        Gets additional query string params.
        Returns:
        the additional query string params

      • setAdditionalQueryStringParams

        public void setAdditionalQueryStringParams​(Map<String,​String> additionalQueryStringParams)
        Sets additional query string params.
        Parameters:
        additionalQueryStringParams - the additional query string params

      • getUseBasicAuthenticationWithAccessCodeGrant

        public String getUseBasicAuthenticationWithAccessCodeGrant()
        Gets use basic authentication with access code grant.
        Returns:
        the use basic authentication with access code grant

      • setUseBasicAuthenticationWithAccessCodeGrant

        public void setUseBasicAuthenticationWithAccessCodeGrant​(String useBasicAuthenticationWithAccessCodeGrant)
        Sets use basic authentication with access code grant.
        Parameters:
        useBasicAuthenticationWithAccessCodeGrant - the use basic authentication with access code grant

      • getUsePkceWithAuthorizationCodeGrant

        public Boolean getUsePkceWithAuthorizationCodeGrant()
        Gets use pkce with authorization code grant.
        Returns:
        the use pkce with authorization code grant

      • setUsePkceWithAuthorizationCodeGrant

        public void setUsePkceWithAuthorizationCodeGrant​(Boolean usePkceWithAuthorizationCodeGrant)
        Sets use pkce with authorization code grant.
        Parameters:
        usePkceWithAuthorizationCodeGrant - the use pkce with authorization code grant

      • getScopes

        public List<String> getScopes()
        Get the pre-selected scopes during authentication.
        Returns:
        the pre-selected scopes during authentication

      • setScopes

        public void setScopes​(List<String> scopes)
        Sets the pre-selected scopes during authentication.
        Parameters:
        scopes - the pre-selected scopes during authentication