Package springfox.documentation.swagger.web

Class SecurityConfiguration

java.lang.Object

springfox.documentation.swagger.web.SecurityConfiguration

public class SecurityConfiguration
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
SecurityConfiguration(java.lang.String clientId, java.lang.String clientSecret, java.lang.String realm, java.lang.String appName, java.lang.String scopeSeparator, java.util.Map<java.lang.String,java.lang.Object> additionalQueryStringParams, java.lang.Boolean useBasicAuthenticationWithAccessCodeGrant, java.lang.Boolean enableCsrfSupport)	Default constructor
SecurityConfiguration(java.lang.String clientId, java.lang.String clientSecret, java.lang.String realm, java.lang.String appName, java.lang.String apiKey, ApiKeyVehicle apiKeyVehicle, java.lang.String apiKeyName, java.lang.String scopeSeparator)	Deprecated.

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalQueryStringParams()
java.lang.String	getApiKey()	Deprecated.
java.lang.String	getApiKeyName()	Deprecated.
java.lang.String	getApiKeyVehicle()	Deprecated.
java.lang.String	getAppName()
java.lang.String	getClientId()
java.lang.String	getClientSecret()
java.lang.Boolean	getEnableCsrfSupport()
java.lang.String	getRealm()
java.lang.Boolean	getUseBasicAuthenticationWithAccessCodeGrant()
java.lang.String	scopeSeparator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityConfiguration

@Deprecated
public SecurityConfiguration(java.lang.String clientId,
                             java.lang.String clientSecret,
                             java.lang.String realm,
                             java.lang.String appName,
                             java.lang.String apiKey,
                             ApiKeyVehicle apiKeyVehicle,
                             java.lang.String apiKeyName,
                             java.lang.String scopeSeparator)

Deprecated.

Parameters:

clientId - - client id

clientSecret - - client secret

realm - - realm

appName - - application name

apiKey - - api key

apiKeyVehicle - - how the api key is transmitted

apiKeyName - - name of the api key

scopeSeparator - - scope separator

Since:

2.8.0. Use the SecurityConfigurationBuilder instead

SecurityConfiguration

public SecurityConfiguration(java.lang.String clientId,
                             java.lang.String clientSecret,
                             java.lang.String realm,
                             java.lang.String appName,
                             java.lang.String scopeSeparator,
                             java.util.Map<java.lang.String,java.lang.Object> additionalQueryStringParams,
                             java.lang.Boolean useBasicAuthenticationWithAccessCodeGrant,
                             java.lang.Boolean enableCsrfSupport)

Default constructor

Parameters:

clientId - Default clientId.

clientSecret - Default clientSecret.

realm - Realm query parameter (for oauth1) added to authorizationUrl and tokenUrl.

appName - Application name, displayed in authorization popup.

scopeSeparator - Scope separator for passing scopes, encoded before calling, default value is a space (encoded value %20).

additionalQueryStringParams - Additional query parameters added to authorizationUrl and tokenUrl.

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.

enableCsrfSupport - Enable csrf support, default is false.

Method Detail

getApiKey

@Deprecated
public java.lang.String getApiKey()

Deprecated.

Returns:

apiKey

Since:

2.8.0

getApiKeyName

@Deprecated
public java.lang.String getApiKeyName()

Deprecated.

Returns:

apiKeyName

Since:

2.8.0

getApiKeyVehicle

@Deprecated
public java.lang.String getApiKeyVehicle()

Deprecated.

Returns:

apiKeyVehicle - header, cookie etc.

Since:

2.8.0

getClientId

public java.lang.String getClientId()

getClientSecret

public java.lang.String getClientSecret()

getRealm

public java.lang.String getRealm()

getAppName

public java.lang.String getAppName()

scopeSeparator

public java.lang.String scopeSeparator()

getAdditionalQueryStringParams

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalQueryStringParams()

getUseBasicAuthenticationWithAccessCodeGrant

public java.lang.Boolean getUseBasicAuthenticationWithAccessCodeGrant()

getEnableCsrfSupport

public java.lang.Boolean getEnableCsrfSupport()