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:

java.io.Serializable, Credentials

public abstract class AbstractCredentials
extends java.lang.Object
implements Credentials

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractCredentials(@NotNull java.lang.String userId)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCredentials

public AbstractCredentials(@NotNull
                           @NotNull java.lang.String userId)

Method Detail

getUserId

@NotNull
public @NotNull java.lang.String getUserId()

Returns the userId.

Returns:

the userId.

setAttribute

public void setAttribute(@NotNull
                         @NotNull java.lang.String name,
                         @Nullable
                         @Nullable java.lang.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 java.lang.Object getAttribute(@NotNull
                                               @NotNull java.lang.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 java.lang.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 java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Returns:

an immutable map containing the attributes available to this credentials instance

setAttributes

public void setAttributes(@NotNull
                          @NotNull java.util.Map<java.lang.String,java.lang.Object> attributes)

Stores the attributes in this credentials instance.

Parameters:

attributes - The attributes to be stored