Modifier and Type	Class and Description
public static enum	SecurityScheme.In In is a REQUIRED property that specifies the location of the API key.
public static enum	SecurityScheme.Type Type is a REQUIRED property that specifies the type of SecurityScheme instance.

Method Summary

Modifier and Type	Method and Description
public default SecurityScheme	Returns: SecurityScheme instance with the set bearerFormat property bearerFormat(String a hint to the client to identify how the bearer token is formatted bearerFormat) bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.
public default SecurityScheme	Returns: SecurityScheme instance with the set description property description(String short description of the SecuirtyScheme instance description) A short description for security schema.
public default SecurityScheme	Returns: SecurityScheme instance with the set flows property flows(OAuthFlows an object containing configuration information for the flow types supported flows) Flows is a REQUIRED property.
public String	Returns: String bearerFormat getBearerFormat() bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.
public String	Returns: String description getDescription() A short description for security schema.
public OAuthFlows	Returns: OAuthFlows flows getFlows() Flows is a REQUIRED property.
public SecurityScheme.In	Returns: In in getIn() In is a REQUIRED property that indicates the location of the API key.
public String	Returns: String name getName() Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
public String	Returns: String openIdConnectUrl getOpenIdConnectUrl() openIdConnectUrl is a REQUIRED property.
public String	Returns: String scheme getScheme() Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
public SecurityScheme.Type	Returns: Type type getType() Type is a REQUIRED property that specifies the type of SecurityScheme instance.
public default SecurityScheme	Returns: SecurityScheme instance with the set in property in(SecurityScheme.In the location of the API key in) In is a REQUIRED property that indicates the location of the API key.
public default SecurityScheme	Returns: SecurityScheme instance with the set name property name(String the name of the header, query or cookie parameter to be used name) Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
public default SecurityScheme	Returns: SecurityScheme instance with the set openIdConnectUrl property openIdConnectUrl(String a URL where OAuth2 configuration values are stored openIdConnectUrl) penIdConnectUrl is a REQUIRED property.
public default SecurityScheme	Returns: SecurityScheme instance with the set scheme property scheme(String the name of the HTTP Authorization scheme to be used in the Authorization header scheme) Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
public void	setBearerFormat(String a hint to the client to identify how the bearer token is formatted bearerFormat) bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.
public void	setDescription(String short description of the SecuirtyScheme instance description) A short description for security schema.
public void	setFlows(OAuthFlows an object containing configuration information for the flow types supported flows) Flows is a REQUIRED property.
public void	setIn(SecurityScheme.In the location of the API key in) In is a REQUIRED property that indicates the location of the API key.
public void	setName(String the name of the header, query or cookie parameter to be used name) Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
public void	setOpenIdConnectUrl(String a URL where OAuth2 configuration values are stored openIdConnectUrl) openIdConnectUrl is a REQUIRED property.
public void	setScheme(String the name of the HTTP Authorization scheme to be used in the Authorization header scheme) Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
public void	setType(SecurityScheme.Type the type of SecurityScheme instance type) Type is a REQUIRED property that specifies the type of SecurityScheme instance.
public default SecurityScheme	Returns: SecurityScheme instance with the set type property type(SecurityScheme.Type the type of SecurityScheme instance type) Type is a REQUIRED property that specifies the type of SecurityScheme instance.

Inherited from org.eclipse.microprofile.openapi.models.Extensible:: addExtension extensions getExtensions removeExtension setExtensions
Inherited from org.eclipse.microprofile.openapi.models.Reference:: getRef ref setRef

Method Detail

bearerFormat	back to summary
public default SecurityScheme bearerFormat(String bearerFormat) bearerFormat is intended as a hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. This method sets the bearerFormat property of SecurityScheme instance to the given String argument and returns the modified instance. Parameters bearerFormat:String a hint to the client to identify how the bearer token is formatted Returns:SecurityScheme SecurityScheme instance with the set bearerFormat property

bearerFormat

back to summary

public default SecurityScheme bearerFormat(String bearerFormat)

bearerFormat is intended as a hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.

This method sets the bearerFormat property of SecurityScheme instance to the given String argument and returns the modified instance.

Parameters

bearerFormat:String: a hint to the client to identify how the bearer token is formatted

Returns:SecurityScheme

SecurityScheme instance with the set bearerFormat property

description	back to summary
public default SecurityScheme description(String description) A short description for security schema. This method sets the description property of SecurityScheme instance and returns the modified instance. Parameters description:String short description of the SecuirtyScheme instance Returns:SecurityScheme SecurityScheme instance with the set description property

description

back to summary

public default SecurityScheme description(String description)

A short description for security schema.

This method sets the description property of SecurityScheme instance and returns the modified instance.

Parameters

description:String: short description of the SecuirtyScheme instance

Returns:SecurityScheme

SecurityScheme instance with the set description property

flows	back to summary
public default SecurityScheme flows(OAuthFlows flows) Flows is a REQUIRED property. Flows is an object containing configuration information for the flow types supported. This method sets the flows property of SecurityScheme instance to the given OAuthFlows argument and returns the modified instance. Parameters flows:OAuthFlows an object containing configuration information for the flow types supported Returns:SecurityScheme SecurityScheme instance with the set flows property

flows

back to summary

public default SecurityScheme flows(OAuthFlows flows)

Flows is a REQUIRED property.

Flows is an object containing configuration information for the flow types supported.

This method sets the flows property of SecurityScheme instance to the given OAuthFlows argument and returns the modified instance.

Parameters

flows:OAuthFlows: an object containing configuration information for the flow types supported

Returns:SecurityScheme

SecurityScheme instance with the set flows property

getBearerFormat	back to summary
public String getBearerFormat() bearerFormat is intended as a hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. This method returns the bearerFormat property from SecurityScheme instance. Returns:String String bearerFormat

getBearerFormat

back to summary

public String getBearerFormat()

This method returns the bearerFormat property from SecurityScheme instance.

Returns:String: String bearerFormat

getDescription	back to summary
public String getDescription() A short description for security schema. This method returns the description property from SecurityScheme instance. Returns:String String description

getDescription

back to summary

public String getDescription()

A short description for security schema.

This method returns the description property from SecurityScheme instance.

Returns:String: String description

getFlows	back to summary
public OAuthFlows getFlows() Flows is a REQUIRED property. Flows is an object containing configuration information for the flow types supported. This method returns the flows property from SecurityScheme instance. Returns:OAuthFlows OAuthFlows flows

getFlows

back to summary

public OAuthFlows getFlows()

Flows is a REQUIRED property.

Flows is an object containing configuration information for the flow types supported.

This method returns the flows property from SecurityScheme instance.

Returns:OAuthFlows: OAuthFlows flows

getIn	back to summary
public SecurityScheme.In getIn() In is a REQUIRED property that indicates the location of the API key. Valid values are "query", "header", "cookie". This method returns the in property from SecurityScheme instance. Returns:SecurityScheme.In In in

getIn

back to summary

public SecurityScheme.In getIn()

In is a REQUIRED property that indicates the location of the API key. Valid values are "query", "header", "cookie".

This method returns the in property from SecurityScheme instance.

Returns:SecurityScheme.In: In in

getName	back to summary
public String getName() Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used. This method returns the name property from SecurityScheme instance. Returns:String String name

getName

back to summary

public String getName()

Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.

This method returns the name property from SecurityScheme instance.

Returns:String: String name

getOpenIdConnectUrl	back to summary
public String getOpenIdConnectUrl() openIdConnectUrl is a REQUIRED property. This property allows to discover OAuth2 configuration values. openIdConnectUrl MUST be in a form of a URL. This method returns the openIdConnectUrl property from SecurityScheme instance. Returns:String String openIdConnectUrl

getOpenIdConnectUrl

back to summary

public String getOpenIdConnectUrl()

openIdConnectUrl is a REQUIRED property.

This property allows to discover OAuth2 configuration values. openIdConnectUrl MUST be in a form of a URL.

This method returns the openIdConnectUrl property from SecurityScheme instance.

Returns:String: String openIdConnectUrl

getScheme	back to summary
public String getScheme() Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235. This method returns the scheme property from SecurityScheme instance. Returns:String String scheme

getScheme

back to summary

public String getScheme()

Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.

This method returns the scheme property from SecurityScheme instance.

Returns:String: String scheme

getType	back to summary
public SecurityScheme.Type getType() Type is a REQUIRED property that specifies the type of SecurityScheme instance. This method returns the type property from SecurityScheme instance. Returns:SecurityScheme.Type Type type

getType

back to summary

public SecurityScheme.Type getType()

Type is a REQUIRED property that specifies the type of SecurityScheme instance.

This method returns the type property from SecurityScheme instance.

Returns:SecurityScheme.Type: Type type

in	back to summary
public default SecurityScheme in(SecurityScheme.In in) In is a REQUIRED property that indicates the location of the API key. Valid values are "query", "header", "cookie". This method sets the in property of SecurityScheme instance to the given In argument and returns the modified instance. Parameters in:SecurityScheme.In the location of the API key Returns:SecurityScheme SecurityScheme instance with the set in property

back to summary

public default SecurityScheme in(SecurityScheme.In in)

In is a REQUIRED property that indicates the location of the API key. Valid values are "query", "header", "cookie".

This method sets the in property of SecurityScheme instance to the given In argument and returns the modified instance.

Parameters

in:SecurityScheme.In: the location of the API key

Returns:SecurityScheme

SecurityScheme instance with the set in property

name	back to summary
public default SecurityScheme name(String name) Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used. This method sets the name property of SecurityScheme instance to the given String argument and returns the modified instance. Parameters name:String the name of the header, query or cookie parameter to be used Returns:SecurityScheme SecurityScheme instance with the set name property

name

back to summary

public default SecurityScheme name(String name)

Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.

This method sets the name property of SecurityScheme instance to the given String argument and returns the modified instance.

Parameters

name:String: the name of the header, query or cookie parameter to be used

Returns:SecurityScheme

SecurityScheme instance with the set name property

openIdConnectUrl	back to summary
public default SecurityScheme openIdConnectUrl(String openIdConnectUrl) penIdConnectUrl is a REQUIRED property. This property allows to discover OAuth2 configuration values. openIdConnectUrl MUST be in a form of a URL. This method sets the openIdConnectUrl property of SecurityScheme instance to the given String argument and returns the modified instance. Parameters openIdConnectUrl:String a URL where OAuth2 configuration values are stored Returns:SecurityScheme SecurityScheme instance with the set openIdConnectUrl property

openIdConnectUrl

back to summary

public default SecurityScheme openIdConnectUrl(String openIdConnectUrl)

penIdConnectUrl is a REQUIRED property.

This property allows to discover OAuth2 configuration values. openIdConnectUrl MUST be in a form of a URL.

This method sets the openIdConnectUrl property of SecurityScheme instance to the given String argument and returns the modified instance.

Parameters

openIdConnectUrl:String: a URL where OAuth2 configuration values are stored

Returns:SecurityScheme

SecurityScheme instance with the set openIdConnectUrl property

scheme	back to summary
public default SecurityScheme scheme(String scheme) Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235. This method sets the scheme property of SecurityScheme instance to the given String argument and returns the modified instance. Parameters scheme:String the name of the HTTP Authorization scheme to be used in the Authorization header Returns:SecurityScheme SecurityScheme instance with the set scheme property

scheme

back to summary

public default SecurityScheme scheme(String scheme)

Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.

This method sets the scheme property of SecurityScheme instance to the given String argument and returns the modified instance.

Parameters

scheme:String: the name of the HTTP Authorization scheme to be used in the Authorization header

Returns:SecurityScheme

SecurityScheme instance with the set scheme property

setBearerFormat	back to summary
public void setBearerFormat(String bearerFormat) bearerFormat is intended as a hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. This method sets the bearerFormat property of SecurityScheme instance to the given String argument. Parameters bearerFormat:String a hint to the client to identify how the bearer token is formatted

setBearerFormat

back to summary

public void setBearerFormat(String bearerFormat)

This method sets the bearerFormat property of SecurityScheme instance to the given String argument.

Parameters

bearerFormat:String: a hint to the client to identify how the bearer token is formatted

setDescription	back to summary
public void setDescription(String description) A short description for security schema. This method sets the description property of SecurityScheme instance. Parameters description:String short description of the SecuirtyScheme instance

setDescription

back to summary

public void setDescription(String description)

A short description for security schema.

This method sets the description property of SecurityScheme instance.

Parameters

description:String: short description of the SecuirtyScheme instance

setFlows	back to summary
public void setFlows(OAuthFlows flows) Flows is a REQUIRED property. Flows is an object containing configuration information for the flow types supported. This method sets the flows property of SecurityScheme instance to the given OAuthFlows argument. Parameters flows:OAuthFlows an object containing configuration information for the flow types supported

setFlows

back to summary

public void setFlows(OAuthFlows flows)

Flows is a REQUIRED property.

Flows is an object containing configuration information for the flow types supported.

This method sets the flows property of SecurityScheme instance to the given OAuthFlows argument.

Parameters

flows:OAuthFlows: an object containing configuration information for the flow types supported

setIn	back to summary
public void setIn(SecurityScheme.In in) In is a REQUIRED property that indicates the location of the API key. Valid values are "query", "header", "cookie". The method sets the in property of SecurityScheme instance to the given In argument. Parameters in:SecurityScheme.In the location of the API key

setIn

back to summary

public void setIn(SecurityScheme.In in)

In is a REQUIRED property that indicates the location of the API key. Valid values are "query", "header", "cookie".

The method sets the in property of SecurityScheme instance to the given In argument.

Parameters

in:SecurityScheme.In: the location of the API key

setName	back to summary
public void setName(String name) Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used. This method sets the name property of SecurityScheme instance to the parameter. Parameters name:String the name of the header, query or cookie parameter to be used

setName

back to summary

public void setName(String name)

Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.

This method sets the name property of SecurityScheme instance to the parameter.

Parameters

name:String: the name of the header, query or cookie parameter to be used

setOpenIdConnectUrl	back to summary
public void setOpenIdConnectUrl(String openIdConnectUrl) openIdConnectUrl is a REQUIRED property. This property allows to discover OAuth2 configuration values. openIdConnectUrl MUST be in a form of a URL. This method sets the openIdConnectUrl property of a SecurityScheme instance to the given String argument. Parameters openIdConnectUrl:String a URL where OAuth2 configuration values are stored

setOpenIdConnectUrl

back to summary

public void setOpenIdConnectUrl(String openIdConnectUrl)

openIdConnectUrl is a REQUIRED property.

This property allows to discover OAuth2 configuration values. openIdConnectUrl MUST be in a form of a URL.

This method sets the openIdConnectUrl property of a SecurityScheme instance to the given String argument.

Parameters

openIdConnectUrl:String: a URL where OAuth2 configuration values are stored

setScheme	back to summary
public void setScheme(String scheme) Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235. This method sets the scheme property of SecurityScheme instance to the given String argument. Parameters scheme:String the name of the HTTP Authorization scheme to be used in the Authorization header

setScheme

back to summary

public void setScheme(String scheme)

Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.

This method sets the scheme property of SecurityScheme instance to the given String argument.

Parameters

scheme:String: the name of the HTTP Authorization scheme to be used in the Authorization header

setType	back to summary
public void setType(SecurityScheme.Type type) Type is a REQUIRED property that specifies the type of SecurityScheme instance. This method sets the type property of SecurityScheme instance to the given Type argument. Parameters type:SecurityScheme.Type the type of SecurityScheme instance

setType

back to summary

public void setType(SecurityScheme.Type type)

Type is a REQUIRED property that specifies the type of SecurityScheme instance.

This method sets the type property of SecurityScheme instance to the given Type argument.

Parameters

type:SecurityScheme.Type: the type of SecurityScheme instance

type	back to summary
public default SecurityScheme type(SecurityScheme.Type type) Type is a REQUIRED property that specifies the type of SecurityScheme instance. This method sets the type property of SecurityScheme instance to the given Type argument and returns the modified instance. Parameters type:SecurityScheme.Type the type of SecurityScheme instance Returns:SecurityScheme SecurityScheme instance with the set type property

type

back to summary

public default SecurityScheme type(SecurityScheme.Type type)

Type is a REQUIRED property that specifies the type of SecurityScheme instance.

This method sets the type property of SecurityScheme instance to the given Type argument and returns the modified instance.

Parameters

type:SecurityScheme.Type: the type of SecurityScheme instance

Returns:SecurityScheme

SecurityScheme instance with the set type property

org.eclipse.microprofile.openapi.models.security back to summary

public final Enum SecurityScheme.In

Class Inheritance

extends Enum<SecurityScheme.In>

java.lang.Object
java.lang.Enum
org.eclipse.microprofile.openapi.models.security.SecurityScheme.In

In is a REQUIRED property that specifies the location of the API key.

This class is used in getIn and setIn to get or set the in of SecurityScheme object to one of the enum constants listed.

Field Summary

Modifier and Type	Field and Description
public static final SecurityScheme.In	COOKIE
public static final SecurityScheme.In	HEADER
public static final SecurityScheme.In	QUERY
private final String	value

Constructor Summary

Access	Constructor and Description
private	In(String value)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static SecurityScheme.In	valueOf(String name)
public static SecurityScheme.In[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

HEADER	back to summary
public static final SecurityScheme.In HEADER

QUERY	back to summary
public static final SecurityScheme.In QUERY

value	back to summary
private final String value

Constructor Detail

In	back to summary
private In(String value)

Method Detail

toString	back to summary
public String toString() Overrides java.lang.Enum.toString. Doc from java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. Returns:String the name of this enum constant Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static SecurityScheme.In valueOf(String name)

values	back to summary
public static SecurityScheme.In[] values()

org.eclipse.microprofile.openapi.models.security back to summary

public final Enum SecurityScheme.Type

Class Inheritance

extends Enum<SecurityScheme.Type>

java.lang.Object
java.lang.Enum
org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type

Type is a REQUIRED property that specifies the type of SecurityScheme instance.

This class is used in getType and setType to get or set the type of SecurityScheme object to one of the valid values.

Field Summary

Modifier and Type	Field and Description
public static final SecurityScheme.Type	APIKEY
public static final SecurityScheme.Type	HTTP
public static final SecurityScheme.Type	MUTUALTLS
public static final SecurityScheme.Type	OAUTH2
public static final SecurityScheme.Type	OPENIDCONNECT
private final String	value

Constructor Summary

Access	Constructor and Description
private	Type(String value)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static SecurityScheme.Type	valueOf(String name)
public static SecurityScheme.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

APIKEY	back to summary
public static final SecurityScheme.Type APIKEY

HTTP	back to summary
public static final SecurityScheme.Type HTTP

MUTUALTLS	back to summary
public static final SecurityScheme.Type MUTUALTLS

OAUTH2	back to summary
public static final SecurityScheme.Type OAUTH2

OPENIDCONNECT	back to summary
public static final SecurityScheme.Type OPENIDCONNECT

value	back to summary
private final String value

Constructor Detail

Type	back to summary
private Type(String value)

Method Detail

toString	back to summary
public String toString() Overrides java.lang.Enum.toString. Doc from java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. Returns:String the name of this enum constant Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static SecurityScheme.Type valueOf(String name)

values	back to summary
public static SecurityScheme.Type[] values()

public Interface SecurityScheme

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum SecurityScheme.In

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SecurityScheme.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail