Package springfox.documentation.service

Class SecurityScheme

java.lang.Object

springfox.documentation.service.SecurityScheme

Direct Known Subclasses:

ApiKey, BasicAuth, HttpAuthenticationScheme, OAuth, OAuth2Scheme, OpenIdConnectScheme

public abstract class SecurityScheme
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SecurityScheme(java.lang.String name, java.lang.String type)
	SecurityScheme(java.lang.String name, java.lang.String type, java.lang.String description, java.util.List<VendorExtension> extensions)

Method Summary

Modifier and Type	Method	Description
protected void	addValidVendorExtensions(java.util.List<VendorExtension> vendorExtensions)
java.lang.String	getDescription()
java.lang.String	getName()
java.lang.String	getType()
java.util.List<VendorExtension>	getVendorExtensions()

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityScheme

protected SecurityScheme(java.lang.String name,
                         java.lang.String type)

SecurityScheme

public SecurityScheme(java.lang.String name,
                      java.lang.String type,
                      java.lang.String description,
                      java.util.List<VendorExtension> extensions)

Method Detail

getType

public java.lang.String getType()

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getVendorExtensions

public java.util.List<VendorExtension> getVendorExtensions()

addValidVendorExtensions

protected void addValidVendorExtensions(java.util.List<VendorExtension> vendorExtensions)