org.apache.jackrabbit.oak.spi.security.authentication.credentials

Class SimpleCredentialsSupport

java.lang.Object

org.apache.jackrabbit.oak.spi.security.authentication.credentials.SimpleCredentialsSupport

All Implemented Interfaces:

CredentialsSupport

public final class SimpleCredentialsSupport
extends Object
implements CredentialsSupport

Implementation of the CredentialsSupport interface that handles SimpleCredentials.

Method Summary

Modifier and Type	Method and Description
@NotNull Map<String,?>	getAttributes(@NotNull Credentials credentials) Obtains the attributes as present with the specified Credentials.
@NotNull ImmutableSet<Class>	getCredentialClasses() Returns all credentials classes supported by this implementation.
static CredentialsSupport	getInstance()
@Nullable String	getUserId(@NotNull Credentials credentials) Retrieves the user identifier from the specified Credentials.
boolean	setAttributes(@NotNull Credentials credentials, @NotNull Map<String,?> attributes) Writes the attributes to the specified Credentials.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static CredentialsSupport getInstance()

getCredentialClasses

@NotNull
public @NotNull ImmutableSet<Class> getCredentialClasses()

Description copied from interface: CredentialsSupport

Returns all credentials classes supported by this implementation.

Specified by:

getCredentialClasses in interface CredentialsSupport

Returns:

the supported credentials classes.

getUserId

@Nullable
public @Nullable String getUserId(@NotNull
                                            @NotNull Credentials credentials)

Description copied from interface: CredentialsSupport

Retrieves the user identifier from the specified Credentials. If the specified credentials are not supported or don't contain any user id information this method will return null.

Specified by:

getUserId in interface CredentialsSupport

Parameters:

credentials - The credentials as passed to the repository login.

Returns:

The user id present in the given Credentials or null.

getAttributes

@NotNull
public @NotNull Map<String,?> getAttributes(@NotNull
                                                     @NotNull Credentials credentials)

Description copied from interface: CredentialsSupport

Obtains the attributes as present with the specified Credentials. If the specified credentials are not supported or don't contain any attributes this method will return an empty Map.

Specified by:

getAttributes in interface CredentialsSupport

Parameters:

credentials - The credentials as passed to the repository login.

Returns:

The credential attributes or an empty Map.

setAttributes

public boolean setAttributes(@NotNull
                             @NotNull Credentials credentials,
                             @NotNull
                             @NotNull Map<String,?> attributes)

Description copied from interface: CredentialsSupport

Writes the attributes to the specified Credentials. If the specified credentials are not supported or doesn't allow to write attributes this method will return false.

Specified by:

setAttributes in interface CredentialsSupport

Parameters:

credentials - The credentials as passed to the repository login.

attributes - The attributes to be written to the given credentials.

Returns:

true, if the attributes were set; false otherwise.