Package com.bonitasoft.processbuilder.records

Record Class RestAuthConfig.OAuth2Password

java.lang.Object

java.lang.Record

com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2Password

Record Components:

tokenUrl - The token endpoint URL

clientId - The client ID

clientSecret - The client secret (optional for public clients)

username - The resource owner username

password - The resource owner password

scope - Optional scope(s) to request

All Implemented Interfaces:

RestAuthConfig

Enclosing interface:

RestAuthConfig

public static record RestAuthConfig.OAuth2Password(String tokenUrl, String clientId, String clientSecret, String username, String password, String scope)
extends Record
implements RestAuthConfig

OAuth 2.0 Resource Owner Password authentication configuration.

Nested Class Summary

Nested classes/interfaces inherited from interface com.bonitasoft.processbuilder.records.RestAuthConfig

RestAuthConfig.ApiKeyAuth, RestAuthConfig.BasicAuth, RestAuthConfig.BearerAuth, RestAuthConfig.CustomAuth, RestAuthConfig.NoAuth, RestAuthConfig.OAuth2ClientCredentials, RestAuthConfig.OAuth2Password

Constructor Summary

Constructors

Constructor	Description
OAuth2Password(String tokenUrl, String clientId, String clientSecret, String username, String password, String scope)	Creates an instance of a OAuth2Password record class.

Method Summary

Modifier and Type	Method	Description
String	clientId()	Returns the value of the clientId record component.
String	clientSecret()	Returns the value of the clientSecret record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Map<String,String>	getAuthHeaders()	Generates the HTTP headers required for this authentication.
RestAuthenticationType	getAuthType()	Gets the authentication type for this configuration.
String	getTokenRequestBody()	Gets the body parameters for the token request.
final int	hashCode()	Returns a hash code value for this object.
String	password()	Returns the value of the password record component.
String	scope()	Returns the value of the scope record component.
String	tokenUrl()	Returns the value of the tokenUrl record component.
final String	toString()	Returns a string representation of this record class.
String	username()	Returns the value of the username record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.bonitasoft.processbuilder.records.RestAuthConfig

getAuthQueryParams

Constructor Details

OAuth2Password

public OAuth2Password(String tokenUrl,
 String clientId,
 String clientSecret,
 String username,
 String password,
 String scope)

Creates an instance of a OAuth2Password record class.

Parameters:

tokenUrl - the value for the tokenUrl record component

clientId - the value for the clientId record component

clientSecret - the value for the clientSecret record component

username - the value for the username record component

password - the value for the password record component

scope - the value for the scope record component

Method Details

getAuthType

public RestAuthenticationType getAuthType()

Description copied from interface: RestAuthConfig

Gets the authentication type for this configuration.

Specified by:

getAuthType in interface RestAuthConfig

Returns:

The authentication type

getAuthHeaders

public Map<String,String> getAuthHeaders()

Description copied from interface: RestAuthConfig

Generates the HTTP headers required for this authentication.

Specified by:

getAuthHeaders in interface RestAuthConfig

Returns:

Map of header name to header value

getTokenRequestBody

public String getTokenRequestBody()

Gets the body parameters for the token request.

Returns:

Form parameters for token endpoint

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

tokenUrl

public String tokenUrl()

Returns the value of the tokenUrl record component.

Returns:

the value of the tokenUrl record component

clientId

public String clientId()

Returns the value of the clientId record component.

Returns:

the value of the clientId record component

clientSecret

public String clientSecret()

Returns the value of the clientSecret record component.

Returns:

the value of the clientSecret record component

username

public String username()

Returns the value of the username record component.

Returns:

the value of the username record component

password

public String password()

Returns the value of the password record component.

Returns:

the value of the password record component

scope

public String scope()

Returns the value of the scope record component.

Returns:

the value of the scope record component