net.shibboleth.idp.attribute.consent

Class User

java.lang.Object

net.shibboleth.idp.attribute.consent.User

@NotThreadSafe
public class User
extends Object

Represents the current user.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	globalConsent Whether the user has given global consent or not.
private String	id The users id.
private Map<String,Collection<AttributeRelease>>	releases A map of attribute releases.

Constructor Summary

Constructors

Constructor and Description
User(String userId, boolean globalConsentGiven) Constructs a @see User.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<AttributeRelease>	getAttributeReleases(String relyingPartyId) Gets the attribute releases for a specific relying party.
String	getId() Gets the userId.
boolean	hasApprovedAttributes(String relyingPartyId, Collection<net.shibboleth.idp.attribute.IdPAttribute> attributes) Checks if the user has given (in past) attribute release consent to all released attributes.
boolean	hasGlobalConsent() Gets the global consent flag.
void	setAttributeReleases(String relyingPartyId, Collection<AttributeRelease> attributeReleases) Sets the attribute releases for a specific relying party.
void	setGlobalConsent(boolean globalConsentGiven) Sets the global consent flag.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

private final String id

The users id.

globalConsent

private boolean globalConsent

Whether the user has given global consent or not.

releases

private final Map<String,Collection<AttributeRelease>> releases

A map of attribute releases. The key represents the entityId for which the attribute releases approval was given. The value contains a collection of @see AttributeRelease.

Constructor Detail

User

public User(String userId,
    boolean globalConsentGiven)

Constructs a @see User.

Parameters:

userId - The id of the user.

globalConsentGiven - If user has given global consent or not.

Method Detail

hasGlobalConsent

public boolean hasGlobalConsent()

Gets the global consent flag.

Returns:

Returns the global consent flag.

setGlobalConsent

public void setGlobalConsent(boolean globalConsentGiven)

Sets the global consent flag.

Parameters:

globalConsentGiven - The global consent flag to set.

getId

public String getId()

Gets the userId.

Returns:

The id of the user.

setAttributeReleases

public void setAttributeReleases(String relyingPartyId,
                        Collection<AttributeRelease> attributeReleases)

Sets the attribute releases for a specific relying party.

Parameters:

relyingPartyId - The id of the relying party for which the attribute releases should be set

attributeReleases - Collection of @see AttributeRelease to set

getAttributeReleases

public Collection<AttributeRelease> getAttributeReleases(String relyingPartyId)

Gets the attribute releases for a specific relying party.

Parameters:

relyingPartyId - The id of the relying party for which the attribute releases should be returned

Returns:

Collection of @see AttributeRelease

hasApprovedAttributes

public boolean hasApprovedAttributes(String relyingPartyId,
                            Collection<net.shibboleth.idp.attribute.IdPAttribute> attributes)

Checks if the user has given (in past) attribute release consent to all released attributes.

Parameters:

relyingPartyId - The id of the relying party for which the attribute releases should be checked

attributes - Collection of @see Attribute, the attributes which are going to be released

Returns:

true if the user has given attribute release consent to all attributes.

toString

public String toString()

Overrides:

toString in class Object