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,String> customProperties) Initializes the value for the customProperties attribute.
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	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

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.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

token

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

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

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

customProperties

public final ImmutableAuthenticationSubject.Builder customProperties(Map<String,String> customProperties)

Initializes the value for the customProperties attribute.

Parameters:

customProperties - The value for customProperties

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