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

Interface CredentialsSupport

All Known Implementing Classes:

CompositeCredentialsSupport, SimpleCredentialsSupport

public interface CredentialsSupport

Simple helper interface that allows to easily plug support for additional or custom Credentials implementations during authentication.

See Also:

AbstractLoginModule.getSupportedCredentials(), SimpleCredentialsSupport

Method Summary

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

Method Detail

getCredentialClasses

@Nonnull
Set<Class> getCredentialClasses()

Returns all credentials classes supported by this implementation.

Returns:

the supported credentials classes.

getUserId

@CheckForNull
String getUserId(@Nonnull
                               Credentials credentials)

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.

Parameters:

credentials - The credentials as passed to the repository login.

Returns:

The user id present in the given Credentials or null.

getAttributes

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

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.

Parameters:

credentials - The credentials as passed to the repository login.

Returns:

The credential attributes or an empty Map.

setAttributes

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

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.

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.