SecurityScheme (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.dto.swagger.SwaggerElement
- - org.apache.juneau.dto.swagger.SecurityScheme

```
@Bean(properties="type,description,name,in,flow,authorizationUrl,tokenUrl,scopes,*")
public class SecurityScheme
extends SwaggerElement
```
Allows the definition of a security scheme that can be used by the operations.
Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code).
Example:

// Basic authentication sample { "type": "basic" } // API key sample { "type": "apiKey", "name": "api_key", "in": "header" } // Implicit OAuth2 sample { "type": "oauth2", "authorizationUrl": "http://swagger.io/api/oauth/dialog", "flow": "implicit", "scopes": { "write:pets": "modify pets in your account", "read:pets": "read your pets" } }

See Also:
- Overview > juneau-dto > Swagger

Constructor Summary

Constructors
Constructor and Description

SecurityScheme()

Constructors
Constructor and Description
`SecurityScheme()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SecurityScheme`	`addScopes(Map<String,String> values)` Adds one or more values to the scopes property.
`SecurityScheme`	`authorizationUrl(Object value)` Same as `setAuthorizationUrl(String)`.
`SecurityScheme`	`description(Object value)` Same as `setDescription(String)`.
`SecurityScheme`	`flow(Object value)` Same as `setFlow(String)`.
`<T> T`	`get(String property, Class<T> type)` Generic property getter.
`String`	`getAuthorizationUrl()` Bean property getter: authorizationUrl.
`String`	`getDescription()` Bean property getter: description.
`String`	`getFlow()` Bean property getter: flow.
`String`	`getIn()` Bean property getter: in.
`String`	`getName()` Bean property getter: name.
`Map<String,String>`	`getScopes()` Bean property getter: scopes.
`String`	`getTokenUrl()` Bean property getter: tokenUrl.
`String`	`getType()` Bean property getter: type.
`SecurityScheme`	`in(Object value)` Same as `setIn(String)`.
`SecurityScheme`	`name(Object value)` Same as `setName(String)`.
`SecurityScheme`	`scopes(Object... values)` Adds one or more values to the enum property.
`SecurityScheme`	`set(String property, Object value)` Generic property setter.
`SecurityScheme`	`setAuthorizationUrl(String value)` Bean property setter: authorizationUrl.
`SecurityScheme`	`setDescription(String value)` Bean property setter: description.
`SecurityScheme`	`setFlow(String value)` Bean property setter: flow.
`SecurityScheme`	`setIn(String value)` Bean property setter: in.
`SecurityScheme`	`setName(String value)` Bean property setter: name.
`SecurityScheme`	`setScopes(Map<String,String> value)` Bean property setter: scopes.
`SecurityScheme`	`setTokenUrl(String value)` Bean property setter: tokenUrl.
`SecurityScheme`	`setType(String value)` Bean property setter: type.
`protected SecurityScheme`	`strict()` Sets strict mode on this bean.
`SecurityScheme`	`tokenUrl(Object value)` Same as `setTokenUrl(String)`.
`SecurityScheme`	`type(Object value)` Same as `setType(String)`.

Methods inherited from class org.apache.juneau.dto.swagger.SwaggerElement
getExtraProperties, isStrict, strict, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SecurityScheme
```
public SecurityScheme()
```
- Method Detail
  - strict
```
protected SecurityScheme strict()
```
    Description copied from class: SwaggerElement
    
    Sets strict mode on this bean.
    
    Overrides:
    
    strict in class SwaggerElement
    
    Returns:
    
    This object (for method chaining).
  - getType
```
public String getType()
```
    Bean property getter: type.
    The type of the security scheme.
    
    Returns:
    
    The property value, or null if it is not set.
  - setType
```
public SecurityScheme setType(String value)
```
    Bean property setter: type.
    The type of the security scheme.
    Valid values are .
    Parameters:
    value - The new value for this property.
    Valid values:
    
    "basic"
    "apiKey"
    "oauth2"
    
    Property value is required.
    Returns:
    
    This object (for method chaining).
  - type
```
public SecurityScheme type(Object value)
```
    Same as setType(String).
    Parameters:
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Valid values:
    
    "basic"
    "apiKey"
    "oauth2"
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - getDescription
```
public String getDescription()
```
    Bean property getter: description.
    A short description for security scheme.
    
    Returns:
    
    The property value, or null if it is not set.
  - setDescription
```
public SecurityScheme setDescription(String value)
```
    Bean property setter: description.
    A short description for security scheme.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - description
```
public SecurityScheme description(Object value)
```
    Same as setDescription(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getName
```
public String getName()
```
    Bean property getter: name.
    The name of the header or query parameter to be used.
    
    Returns:
    
    The property value, or null if it is not set.
  - setName
```
public SecurityScheme setName(String value)
```
    Bean property setter: name.
    The name of the header or query parameter to be used.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - name
```
public SecurityScheme name(Object value)
```
    Same as setName(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getIn
```
public String getIn()
```
    Bean property getter: in.
    The location of the API key.
    
    Returns:
    
    The property value, or null if it is not set.
  - setIn
```
public SecurityScheme setIn(String value)
```
    Bean property setter: in.
    The location of the API key.
    Parameters:
    value - The new value for this property.
    Valid values:
    
    "query"
    "header"
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - in
```
public SecurityScheme in(Object value)
```
    Same as setIn(String).
    Parameters:
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Valid values:
    
    "query"
    "header"
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - getFlow
```
public String getFlow()
```
    Bean property getter: flow.
    The flow used by the OAuth2 security scheme.
    
    Returns:
    
    The property value, or null if it is not set.
  - setFlow
```
public SecurityScheme setFlow(String value)
```
    Bean property setter: flow.
    The flow used by the OAuth2 security scheme.
    Parameters:
    value - The new value for this property.
    Valid values:
    
    "implicit"
    "password"
    "application"
    "accessCode"
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - flow
```
public SecurityScheme flow(Object value)
```
    Same as setFlow(String).
    Parameters:
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Valid values:
    
    "implicit"
    "password"
    "application"
    "accessCode"
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - getAuthorizationUrl
```
public String getAuthorizationUrl()
```
    Bean property getter: authorizationUrl.
    The authorization URL to be used for this flow.
    
    Returns:
    
    The property value, or null if it is not set.
  - setAuthorizationUrl
```
public SecurityScheme setAuthorizationUrl(String value)
```
    Bean property setter: authorizationUrl.
    The authorization URL to be used for this flow.
    
    Parameters:
    
    value - The new value for this property.
    This SHOULD be in the form of a URL.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - authorizationUrl
```
public SecurityScheme authorizationUrl(Object value)
```
    Same as setAuthorizationUrl(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    This SHOULD be in the form of a URL.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getTokenUrl
```
public String getTokenUrl()
```
    Bean property getter: tokenUrl.
    The token URL to be used for this flow.
    
    Returns:
    
    The property value, or null if it is not set.
  - setTokenUrl
```
public SecurityScheme setTokenUrl(String value)
```
    Bean property setter: tokenUrl.
    The token URL to be used for this flow.
    
    Parameters:
    
    value - The new value for this property.
    This SHOULD be in the form of a URL.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - tokenUrl
```
public SecurityScheme tokenUrl(Object value)
```
    Same as setTokenUrl(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    This SHOULD be in the form of a URL.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getScopes
```
public Map<String,String> getScopes()
```
    Bean property getter: scopes.
    The available scopes for the OAuth2 security scheme.
    
    Returns:
    
    The property value, or null if it is not set.
  - setScopes
```
public SecurityScheme setScopes(Map<String,String> value)
```
    Bean property setter: scopes.
    The available scopes for the OAuth2 security scheme.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addScopes
```
public SecurityScheme addScopes(Map<String,String> values)
```
    Adds one or more values to the scopes property.
    
    Parameters:
    
    values - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - scopes
```
public SecurityScheme scopes(Object... values)
```
    Adds one or more values to the enum property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Map<String,HeaderInfo|String>
    String - JSON object representation of Map<String,HeaderInfo>
    Example:
    
    scopes("{name:'value'}");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - get
```
public <T> T get(String property,
                 Class<T> type)
```
    Description copied from class: SwaggerElement
    
    Generic property getter.
    Can be used to retrieve non-standard Swagger fields such as "$ref".
    
    Overrides:
    
    get in class SwaggerElement
    
    Parameters:
    
    property - The property name to retrieve.
    
    type - The datatype to cast the value to.
    
    Returns:
    
    The property value, or null if the property does not exist or is not set.
  - set
```
public SecurityScheme set(String property,
                          Object value)
```
    Description copied from class: SwaggerElement
    
    Generic property setter.
    Can be used to set non-standard Swagger fields such as "$ref".
    
    Overrides:
    
    set in class SwaggerElement
    
    Parameters:
    
    property - The property name to set.
    
    value - The new value for the property.
    
    Returns:
    
    This object (for method chaining).

Class SecurityScheme

Example:

See Also:

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.dto.swagger.SwaggerElement

Methods inherited from class java.lang.Object

Constructor Detail

SecurityScheme

Method Detail

strict

getType

setType

type

getDescription

setDescription

description

getName

setName

name

getIn

setIn

in

getFlow

setFlow

flow

getAuthorizationUrl

setAuthorizationUrl

authorizationUrl

getTokenUrl

setTokenUrl

tokenUrl

getScopes

setScopes

addScopes

scopes

Example:

get

set