OauthDefinition (Serverless Workflow

java.lang.Object
- io.serverlessworkflow.api.auth.OauthDefinition

All Implemented Interfaces:: Serializable

public class OauthDefinition
extends Object
implements Serializable

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OauthDefinition.GrantType

Nested Classes
Modifier and Type	Class and Description
`static class`	`OauthDefinition.GrantType`

Constructor Summary

Constructors
Constructor and Description
`OauthDefinition()` No args constructor for use in serialization
`OauthDefinition(OauthDefinition.GrantType grantType, String clientId)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`getAudiences()` Array containing strings or workflow expressions.
`String`	`getAuthority()` String or a workflow expression.
`String`	`getClientId()` String or a workflow expression.
`String`	`getClientSecret()` Workflow secret or a workflow expression.
`OauthDefinition.GrantType`	`getGrantType()` Defines the grant type (Required)
`Map<String,String>`	`getMetadata()` Metadata
`String`	`getPassword()` String or a workflow expression.
`String`	`getRequestedIssuer()` String or a workflow expression.
`String`	`getRequestedSubject()` String or a workflow expression.
`List<String>`	`getScopes()` Array containing strings or workflow expressions.
`String`	`getSubjectToken()` String or a workflow expression.
`String`	`getUsername()` String or a workflow expression.
`void`	`setAudiences(List<String> audiences)` Array containing strings or workflow expressions.
`void`	`setAuthority(String authority)` String or a workflow expression.
`void`	`setClientId(String clientId)` String or a workflow expression.
`void`	`setClientSecret(String clientSecret)` Workflow secret or a workflow expression.
`void`	`setGrantType(OauthDefinition.GrantType grantType)` Defines the grant type (Required)
`void`	`setMetadata(Map<String,String> metadata)` Metadata
`void`	`setPassword(String password)` String or a workflow expression.
`void`	`setRequestedIssuer(String requestedIssuer)` String or a workflow expression.
`void`	`setRequestedSubject(String requestedSubject)` String or a workflow expression.
`void`	`setScopes(List<String> scopes)` Array containing strings or workflow expressions.
`void`	`setSubjectToken(String subjectToken)` String or a workflow expression.
`void`	`setUsername(String username)` String or a workflow expression.
`OauthDefinition`	`withAudiences(List<String> audiences)`
`OauthDefinition`	`withAuthority(String authority)`
`OauthDefinition`	`withClientId(String clientId)`
`OauthDefinition`	`withClientSecret(String clientSecret)`
`OauthDefinition`	`withGrantType(OauthDefinition.GrantType grantType)`
`OauthDefinition`	`withMetadata(Map<String,String> metadata)`
`OauthDefinition`	`withPassword(String password)`
`OauthDefinition`	`withRequestedIssuer(String requestedIssuer)`
`OauthDefinition`	`withRequestedSubject(String requestedSubject)`
`OauthDefinition`	`withScopes(List<String> scopes)`
`OauthDefinition`	`withSubjectToken(String subjectToken)`
`OauthDefinition`	`withUsername(String username)`

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

- Constructor Detail
  - OauthDefinition
```
public OauthDefinition()
```
    No args constructor for use in serialization
  - OauthDefinition
```
public OauthDefinition(OauthDefinition.GrantType grantType,
                       String clientId)
```
    Parameters:
    
    clientId -
    
    grantType -
- Method Detail
  - getAuthority
```
public String getAuthority()
```
    String or a workflow expression. Contains the authority information
  - setAuthority
```
public void setAuthority(String authority)
```
    String or a workflow expression. Contains the authority information
  - withAuthority
```
public OauthDefinition withAuthority(String authority)
```
  - getGrantType
```
public OauthDefinition.GrantType getGrantType()
```
    Defines the grant type (Required)
  - setGrantType
```
public void setGrantType(OauthDefinition.GrantType grantType)
```
    Defines the grant type (Required)
  - withGrantType
```
public OauthDefinition withGrantType(OauthDefinition.GrantType grantType)
```
  - getClientId
```
public String getClientId()
```
    String or a workflow expression. Contains the client identifier (Required)
  - setClientId
```
public void setClientId(String clientId)
```
    String or a workflow expression. Contains the client identifier (Required)
  - withClientId
```
public OauthDefinition withClientId(String clientId)
```
  - getClientSecret
```
public String getClientSecret()
```
    Workflow secret or a workflow expression. Contains the client secret
  - setClientSecret
```
public void setClientSecret(String clientSecret)
```
    Workflow secret or a workflow expression. Contains the client secret
  - withClientSecret
```
public OauthDefinition withClientSecret(String clientSecret)
```
  - getScopes
```
public List<String> getScopes()
```
    Array containing strings or workflow expressions. Contains the OAuth2 scopes
  - setScopes
```
public void setScopes(List<String> scopes)
```
    Array containing strings or workflow expressions. Contains the OAuth2 scopes
  - withScopes
```
public OauthDefinition withScopes(List<String> scopes)
```
  - getUsername
```
public String getUsername()
```
    String or a workflow expression. Contains the user name. Used only if grantType is 'resourceOwner'
  - setUsername
```
public void setUsername(String username)
```
    String or a workflow expression. Contains the user name. Used only if grantType is 'resourceOwner'
  - withUsername
```
public OauthDefinition withUsername(String username)
```
  - getPassword
```
public String getPassword()
```
    String or a workflow expression. Contains the user password. Used only if grantType is 'resourceOwner'
  - setPassword
```
public void setPassword(String password)
```
    String or a workflow expression. Contains the user password. Used only if grantType is 'resourceOwner'
  - withPassword
```
public OauthDefinition withPassword(String password)
```
  - getAudiences
```
public List<String> getAudiences()
```
    Array containing strings or workflow expressions. Contains the OAuth2 audiences
  - setAudiences
```
public void setAudiences(List<String> audiences)
```
    Array containing strings or workflow expressions. Contains the OAuth2 audiences
  - withAudiences
```
public OauthDefinition withAudiences(List<String> audiences)
```
  - getSubjectToken
```
public String getSubjectToken()
```
    String or a workflow expression. Contains the subject token
  - setSubjectToken
```
public void setSubjectToken(String subjectToken)
```
    String or a workflow expression. Contains the subject token
  - withSubjectToken
```
public OauthDefinition withSubjectToken(String subjectToken)
```
  - getRequestedSubject
```
public String getRequestedSubject()
```
    String or a workflow expression. Contains the requested subject
  - setRequestedSubject
```
public void setRequestedSubject(String requestedSubject)
```
    String or a workflow expression. Contains the requested subject
  - withRequestedSubject
```
public OauthDefinition withRequestedSubject(String requestedSubject)
```
  - getRequestedIssuer
```
public String getRequestedIssuer()
```
    String or a workflow expression. Contains the requested issuer
  - setRequestedIssuer
```
public void setRequestedIssuer(String requestedIssuer)
```
    String or a workflow expression. Contains the requested issuer
  - withRequestedIssuer
```
public OauthDefinition withRequestedIssuer(String requestedIssuer)
```
  - getMetadata
```
public Map<String,String> getMetadata()
```
    Metadata
  - setMetadata
```
public void setMetadata(Map<String,String> metadata)
```
    Metadata
  - withMetadata
```
public OauthDefinition withMetadata(Map<String,String> metadata)
```

Class OauthDefinition

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OauthDefinition

OauthDefinition

Method Detail

getAuthority

setAuthority

withAuthority

getGrantType

setGrantType

withGrantType

getClientId

setClientId

withClientId

getClientSecret

setClientSecret

withClientSecret

getScopes

setScopes

withScopes

getUsername

setUsername

withUsername

getPassword

setPassword

withPassword

getAudiences

setAudiences

withAudiences

getSubjectToken

setSubjectToken

withSubjectToken

getRequestedSubject

setRequestedSubject

withRequestedSubject

getRequestedIssuer

setRequestedIssuer

withRequestedIssuer

getMetadata

setMetadata

withMetadata