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

Class AbstractCredentials

java.lang.Object

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

All Implemented Interfaces:

Serializable, Credentials

public abstract class AbstractCredentials
extends Object
implements Credentials

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	attributes
protected String	userId

Constructor Summary

Constructors

Constructor	Description
AbstractCredentials(@NotNull String userId)

Method Summary

Modifier and Type	Method	Description
@Nullable Object	getAttribute(@NotNull String name)	Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
@NotNull Map<String,Object>	getAttributes()
@NotNull String	getUserId()	Returns the userId.
void	removeAttribute(@NotNull String name)	Removes an attribute from this credentials instance.
void	setAttribute(@NotNull String name, @Nullable Object value)	Stores an attribute in this credentials instance.
void	setAttributes(@NotNull Map<String,Object> attributes)	Stores the attributes in this credentials instance.

Methods inherited from class java.lang.Object

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

Field Detail

attributes

protected final Map<String,Object> attributes

userId

protected final String userId

Constructor Detail

AbstractCredentials

public AbstractCredentials(@NotNull
                           @NotNull String userId)

Method Detail

getUserId

@NotNull
public @NotNull String getUserId()

Returns the userId.

Returns:

the userId.

setAttribute

public void setAttribute(@NotNull
                         @NotNull String name,
                         @Nullable
                         @Nullable Object value)

Stores an attribute in this credentials instance. If the specified value is null the attribute will be removed.

Parameters:

name - a String specifying the name of the attribute

value - the Object to be stored

getAttribute

@Nullable
public @Nullable Object getAttribute(@NotNull
                                     @NotNull String name)

Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

Parameters:

name - a String specifying the name of the attribute

Returns:

an Object containing the value of the attribute, or null if the attribute does not exist

removeAttribute

public void removeAttribute(@NotNull
                            @NotNull String name)

Removes an attribute from this credentials instance.

Parameters:

name - a String specifying the name of the attribute to remove

getAttributes

@NotNull
public @NotNull Map<String,Object> getAttributes()

Returns:

an immutable map containing the attributes available to this credentials instance

setAttributes

public void setAttributes(@NotNull
                          @NotNull Map<String,Object> attributes)

Stores the attributes in this credentials instance.

Parameters:

attributes - The attributes to be stored