io.muserver.openapi

Class SecuritySchemeObject

java.lang.Object

io.muserver.openapi.SecuritySchemeObject

public class SecuritySchemeObject
extends Object

See Also:

SecuritySchemeObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
String	bearerFormat Deprecated. use bearerFormat() instead
String	description Deprecated. use description() instead
OAuthFlowsObject	flows Deprecated. use flows() instead
String	in Deprecated. use in() instead
String	name Deprecated. use name() instead
URI	openIdConnectUrl Deprecated. use openIdConnectUrl() instead
String	scheme Deprecated. use scheme() instead
String	type Deprecated. use type() instead

Method Summary

Modifier and Type	Method and Description
String	bearerFormat()
String	description()
OAuthFlowsObject	flows()
String	in()
String	name()
URI	openIdConnectUrl()
String	scheme()
String	type()
static List<String>	validTypes()
void	writeJson(Writer writer) Writes this object as a JSON Object

Methods inherited from class java.lang.Object

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

Field Detail

type

@Deprecated
public final String type

Deprecated. use type() instead

description

@Deprecated
public final String description

Deprecated. use description() instead

name

@Deprecated
public final String name

Deprecated. use name() instead

in

@Deprecated
public final String in

Deprecated. use in() instead

scheme

@Deprecated
public final String scheme

Deprecated. use scheme() instead

bearerFormat

@Deprecated
public final String bearerFormat

Deprecated. use bearerFormat() instead

flows

@Deprecated
public final OAuthFlowsObject flows

Deprecated. use flows() instead

openIdConnectUrl

@Deprecated
public final URI openIdConnectUrl

Deprecated. use openIdConnectUrl() instead

Method Detail

writeJson

public void writeJson(Writer writer)
               throws IOException

Writes this object as a JSON Object

Parameters:

writer - The writer to write to

Throws:

IOException - Thrown if the writer throws this while writing

type

public String type()

Returns:

the value described by SecuritySchemeObjectBuilder.withType(java.lang.String)

description

public String description()

Returns:

the value described by SecuritySchemeObjectBuilder.withDescription(java.lang.String)

name

public String name()

Returns:

the value described by SecuritySchemeObjectBuilder.withName(java.lang.String)

in

public String in()

Returns:

the value described by SecuritySchemeObjectBuilder.withIn(java.lang.String)

scheme

public String scheme()

Returns:

the value described by SecuritySchemeObjectBuilder.withScheme(java.lang.String)

bearerFormat

public String bearerFormat()

Returns:

the value described by SecuritySchemeObjectBuilder.withBearerFormat(java.lang.String)

flows

public OAuthFlowsObject flows()

Returns:

the value described by SecuritySchemeObjectBuilder.withFlows(io.muserver.openapi.OAuthFlowsObject)

openIdConnectUrl

public URI openIdConnectUrl()

Returns:

the value described by SecuritySchemeObjectBuilder.withOpenIdConnectUrl(java.net.URI)

validTypes

public static List<String> validTypes()

Returns:

The types allowed to be passed to SecuritySchemeObjectBuilder.withType(String)