Package com.bonitasoft.processbuilder.records

Record Class RestAuthConfig.BasicAuth

java.lang.Object

java.lang.Record

com.bonitasoft.processbuilder.records.RestAuthConfig.BasicAuth

Record Components:

username - The username

password - The password

preemptive - Whether to send credentials without waiting for 401

All Implemented Interfaces:

RestAuthConfig

Enclosing interface:

RestAuthConfig

public static record RestAuthConfig.BasicAuth(String username, String password, boolean preemptive)
extends Record
implements RestAuthConfig

HTTP Basic 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
BasicAuth(String username, String password, boolean preemptive)	Creates an instance of a BasicAuth record class.

Method Summary

Modifier and Type	Method	Description
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.
final int	hashCode()	Returns a hash code value for this object.
String	password()	Returns the value of the password record component.
boolean	preemptive()	Returns the value of the preemptive 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

BasicAuth

public BasicAuth(String username,
 String password,
 boolean preemptive)

Creates an instance of a BasicAuth record class.

Parameters:

username - the value for the username record component

password - the value for the password record component

preemptive - the value for the preemptive 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

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

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

preemptive

public boolean preemptive()

Returns the value of the preemptive record component.

Returns:

the value of the preemptive record component