Package com.adobe.granite.auth.saml.spi

Class SamlCredentials

java.lang.Object

com.adobe.granite.auth.saml.spi.SamlCredentials

All Implemented Interfaces:

Serializable, Credentials

public class SamlCredentials
extends Object
implements Credentials

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SamlCredentials(String userId, String idp, boolean idpNameInUserId)

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	getIdp()
String	getIdWithIdp(String id)
@NotNull Set<String>	getSamlGroupIds()
@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	setSamlGroups(@NotNull Set<String> samlGroupIds)

Methods inherited from class java.lang.Object

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

Constructor Details

SamlCredentials

public SamlCredentials(String userId,
 String idp,
 boolean idpNameInUserId)

Method Details

getIdp

@NotNull
public @NotNull String getIdp()

getSamlGroupIds

@NotNull
public @NotNull Set<String> getSamlGroupIds()

setSamlGroups

public void setSamlGroups(@NotNull
 @NotNull Set<String> samlGroupIds)

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

getIdWithIdp

public String getIdWithIdp(String id)