io.stargate.auth

Class ImmutableAuthenticationSubject.Builder

java.lang.Object

io.stargate.auth.ImmutableAuthenticationSubject.Builder

Enclosing class:

ImmutableAuthenticationSubject

@NotThreadSafe
public static final class ImmutableAuthenticationSubject.Builder
extends Object

Builds instances of type ImmutableAuthenticationSubject. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
ImmutableAuthenticationSubject	build() Builds a new ImmutableAuthenticationSubject.
ImmutableAuthenticationSubject.Builder	customProperties(Map<String,? extends String> entries) Sets or replaces all mappings from the specified map as entries for the customProperties map.
ImmutableAuthenticationSubject.Builder	from(AuthenticationSubject instance) Fill a builder with attribute values from the provided AuthenticationSubject instance.
ImmutableAuthenticationSubject.Builder	isFromExternalAuth(boolean isFromExternalAuth) Initializes the value for the isFromExternalAuth attribute.
ImmutableAuthenticationSubject.Builder	putAllCustomProperties(Map<String,? extends String> entries) Put all mappings from the specified map as entries to customProperties map.
ImmutableAuthenticationSubject.Builder	putCustomProperties(Map.Entry<String,? extends String> entry) Put one entry to the customProperties map.
ImmutableAuthenticationSubject.Builder	putCustomProperties(String key, String value) Put one entry to the customProperties map.
ImmutableAuthenticationSubject.Builder	roleName(String roleName) Initializes the value for the roleName attribute.
ImmutableAuthenticationSubject.Builder	token(String token) Initializes the value for the token attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableAuthenticationSubject.Builder from(AuthenticationSubject instance)

Fill a builder with attribute values from the provided AuthenticationSubject instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

token

@CanIgnoreReturnValue
public final ImmutableAuthenticationSubject.Builder token(@Nullable
                                                                                String token)

Initializes the value for the token attribute.

Parameters:

token - The value for token (can be null)

Returns:

this builder for use in a chained invocation

roleName

@CanIgnoreReturnValue
public final ImmutableAuthenticationSubject.Builder roleName(String roleName)

Initializes the value for the roleName attribute.

Parameters:

roleName - The value for roleName

Returns:

this builder for use in a chained invocation

isFromExternalAuth

@CanIgnoreReturnValue
public final ImmutableAuthenticationSubject.Builder isFromExternalAuth(boolean isFromExternalAuth)

Initializes the value for the isFromExternalAuth attribute.

Parameters:

isFromExternalAuth - The value for isFromExternalAuth

Returns:

this builder for use in a chained invocation

putCustomProperties

@CanIgnoreReturnValue
public final ImmutableAuthenticationSubject.Builder putCustomProperties(String key,
                                                                                              String value)

Put one entry to the customProperties map.

Parameters:

key - The key in the customProperties map

value - The associated value in the customProperties map

Returns:

this builder for use in a chained invocation

putCustomProperties

@CanIgnoreReturnValue
public final ImmutableAuthenticationSubject.Builder putCustomProperties(Map.Entry<String,? extends String> entry)

Put one entry to the customProperties map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

customProperties

@CanIgnoreReturnValue
public final ImmutableAuthenticationSubject.Builder customProperties(Map<String,? extends String> entries)

Sets or replaces all mappings from the specified map as entries for the customProperties map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the customProperties map

Returns:

this builder for use in a chained invocation

putAllCustomProperties

@CanIgnoreReturnValue
public final ImmutableAuthenticationSubject.Builder putAllCustomProperties(Map<String,? extends String> entries)

Put all mappings from the specified map as entries to customProperties map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the customProperties map

Returns:

this builder for use in a chained invocation

build

public ImmutableAuthenticationSubject build()

Builds a new ImmutableAuthenticationSubject.

Returns:

An immutable instance of AuthenticationSubject

Throws:

IllegalStateException - if any required attributes are missing