Package springfox.documentation.service

Class OAuth2Scheme

java.lang.Object

springfox.documentation.service.SecurityScheme

springfox.documentation.service.OAuth2Scheme

public class OAuth2Scheme
extends SecurityScheme

Field Summary

Fields

Modifier and Type	Field	Description
static OAuth2SchemeBuilder	OAUTH2_AUTHORIZATION_CODE_FLOW_BUILDER
static OAuth2SchemeBuilder	OAUTH2_CLIENT_CREDENTIALS_FLOW_BUILDER
static OAuth2SchemeBuilder	OAUTH2_IMPLICIT_FLOW_BUILDER
static OAuth2SchemeBuilder	OAUTH2_PASSWORD_FLOW_BUILDER

Constructor Summary

Constructors

Constructor	Description
OAuth2Scheme(java.lang.String name, java.lang.String flowType, java.lang.String description, java.lang.String authorizationUrl, java.lang.String tokenUrl, java.lang.String refreshUrl, java.util.List<AuthorizationScope> scopes, java.util.List<VendorExtension> extensions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAuthorizationUrl()
java.lang.String	getFlowType()
java.lang.String	getRefreshUrl()
java.util.List<AuthorizationScope>	getScopes()
java.lang.String	getTokenUrl()

Methods inherited from class springfox.documentation.service.SecurityScheme

addValidVendorExtensions, getDescription, getName, getType, getVendorExtensions

Methods inherited from class java.lang.Object

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

Field Detail

OAUTH2_IMPLICIT_FLOW_BUILDER

public static final OAuth2SchemeBuilder OAUTH2_IMPLICIT_FLOW_BUILDER

OAUTH2_PASSWORD_FLOW_BUILDER

public static final OAuth2SchemeBuilder OAUTH2_PASSWORD_FLOW_BUILDER

OAUTH2_CLIENT_CREDENTIALS_FLOW_BUILDER

public static final OAuth2SchemeBuilder OAUTH2_CLIENT_CREDENTIALS_FLOW_BUILDER

OAUTH2_AUTHORIZATION_CODE_FLOW_BUILDER

public static final OAuth2SchemeBuilder OAUTH2_AUTHORIZATION_CODE_FLOW_BUILDER

Constructor Detail

OAuth2Scheme

public OAuth2Scheme(java.lang.String name,
                    java.lang.String flowType,
                    java.lang.String description,
                    java.lang.String authorizationUrl,
                    java.lang.String tokenUrl,
                    java.lang.String refreshUrl,
                    java.util.List<AuthorizationScope> scopes,
                    java.util.List<VendorExtension> extensions)

Method Detail

getFlowType

public java.lang.String getFlowType()

getAuthorizationUrl

public java.lang.String getAuthorizationUrl()

getTokenUrl

public java.lang.String getTokenUrl()

getRefreshUrl

public java.lang.String getRefreshUrl()

getScopes

public java.util.List<AuthorizationScope> getScopes()