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.-
Method Summary
Modifier and TypeMethodDescriptiongetAttributes
(@NotNull Credentials credentials) Obtains the attributes as present with the specifiedCredentials
.Returns allcredentials
classes supported by this implementation.@Nullable String
getUserId
(@NotNull Credentials credentials) Retrieves the user identifier from the specifiedCredentials
.boolean
setAttributes
(@NotNull Credentials credentials, @NotNull Map<String, ?> attributes) Writes the attributes to the specifiedCredentials
.
-
Method Details
-
getCredentialClasses
Returns allcredentials
classes supported by this implementation.- Returns:
- the supported
credentials
classes.
-
getUserId
Retrieves the user identifier from the specifiedCredentials
. If the specified credentials are not supported or don't contain any user id information this method will returnnull
.- Parameters:
credentials
- The credentials as passed to the repository login.- Returns:
- The user id present in the given
Credentials
ornull
.
-
getAttributes
Obtains the attributes as present with the specifiedCredentials
. If the specified credentials are not supported or don't contain any attributes this method will return an emptyMap
.- Parameters:
credentials
- The credentials as passed to the repository login.- Returns:
- The credential attributes or an empty
Map
.
-
setAttributes
boolean setAttributes(@NotNull @NotNull Credentials credentials, @NotNull @NotNull Map<String, ?> attributes) Writes the attributes to the specifiedCredentials
. If the specified credentials are not supported or doesn't allow to write attributes this method will returnfalse
.- 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.
-