net.shibboleth.idp.attribute.consent

Class ConsentContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.attribute.consent.ConsentContext

All Implemented Interfaces:

Iterable<org.opensaml.messaging.context.BaseContext>

public final class ConsentContext
extends org.opensaml.messaging.context.BaseContext

Context used to collect data about the user's consent to release information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConsentContext.Consent Indicates the result of the consent engine's attempt to gain user consent.

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

org.opensaml.messaging.context.BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields

Modifier and Type	Field and Description
private ConsentContext.Consent	consentDecision The decision determined by the consent engine.
private Map<String,IdPAttribute>	consentedAttributes The attributes the consent engine has determined may be released.
private Map<String,IdPAttribute>	userAttributes Attributes about the user that are to be released with the user's consent.

Constructor Summary

Constructors

Constructor and Description
ConsentContext(Map<String,IdPAttribute> attributes) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ConsentContext.Consent	getConsentDecision() Gets the consent decision established by the user.
Map<String,IdPAttribute>	getConsentedIdPAttributes() Gets the attributes that may be released with the user's consent.
Map<String,IdPAttribute>	getUserIdPAttributes() Gets an unmodifiable map representing the information to be released about the user.
void	setConsentDecision(ConsentContext.Consent decision) Sets the consent decision established by the user.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, isAutoCreateSubcontexts, iterator, removeSubcontext, removeSubcontext, setAutoCreateSubcontexts, setParent

Methods inherited from class java.lang.Object

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

Field Detail

userAttributes

private Map<String,IdPAttribute> userAttributes

Attributes about the user that are to be released with the user's consent.

consentDecision

private ConsentContext.Consent consentDecision

The decision determined by the consent engine.

consentedAttributes

private Map<String,IdPAttribute> consentedAttributes

The attributes the consent engine has determined may be released.

Constructor Detail

ConsentContext

public ConsentContext(Map<String,IdPAttribute> attributes)

Constructor.

Parameters:

attributes - attributes about the user that are to be released with the user's consent, defensively copied

Method Detail

getConsentDecision

public ConsentContext.Consent getConsentDecision()

Gets the consent decision established by the user.

Returns:

consent decision established by the user

setConsentDecision

public void setConsentDecision(ConsentContext.Consent decision)

Sets the consent decision established by the user.

Parameters:

decision - consent decision established by the user

getUserIdPAttributes

public Map<String,IdPAttribute> getUserIdPAttributes()

Gets an unmodifiable map representing the information to be released about the user.

Returns:

unmodifiable map representing the information to be released about the user

getConsentedIdPAttributes

public Map<String,IdPAttribute> getConsentedIdPAttributes()

Gets the attributes that may be released with the user's consent.

Returns:

attributes that may be released with the user's consent, never null