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

Class AbstractCredentials

java.lang.Object

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

public abstract class AbstractCredentials
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AbstractCredentials(java.lang.String userId)

Method Summary

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

Method Detail

getUserId

public java.lang.String getUserId()

Returns the userId.

Returns:

the userId.

setAttribute

public void setAttribute(java.lang.String name,
                         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

public java.lang.Object getAttribute(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(java.lang.String name)

Removes an attribute from this credentials instance.

Parameters:

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

getAttributes

public 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(java.util.Map<java.lang.String,java.lang.Object> attributes)

Stores the attributes in this credentials instance.

Parameters:

attributes - The attributes to be stored