Index (Shibboleth IdP :: Consent Engine Implementation 3.0.0-alpha2 API)

A C D F G H I J L M N P R S T U V

A

alwaysRequireConsent - Variable in class net.shibboleth.idp.attribute.consent.ConsentEngineImpl: Determines if user consent is required always.
attributeBlacklist - Variable in class net.shibboleth.idp.attribute.consent.ConsentEngineImpl: A collection of attribute ids which are blacklisted.
attributeId - Variable in class net.shibboleth.idp.attribute.consent.AttributeRelease: The attribute id.
AttributeRelease - Class in net.shibboleth.idp.attribute.consent: Represents an attribute release.
AttributeRelease(String, String, DateTime) - Constructor for class net.shibboleth.idp.attribute.consent.AttributeRelease: Constructs a @see AttributeRelease.
AttributeRelease(IdPAttribute, DateTime) - Constructor for class net.shibboleth.idp.attribute.consent.AttributeRelease: Constructs a @see AttributeRelease.
attributeReleaseMapper - Variable in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: The attribute release mapper.
attributeReleasePartition - Variable in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: The attribute release partition.
attributeReleaseTable - Variable in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: The name of the attribute release table.
ATTRIBUTES_KEY - Static variable in class net.shibboleth.idp.attribute.consent.ConsentServlet: Key for the current attribute release.
attributeSortOrder - Variable in class net.shibboleth.idp.attribute.consent.ConsentServlet: The specified attribute sort order.

C

cacheManager - Variable in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: The cache manager.
CacheStorage - Class in net.shibboleth.idp.attribute.consent.storage: Cache implementation.
CacheStorage() - Constructor for class net.shibboleth.idp.attribute.consent.storage.CacheStorage
consentDate - Variable in class net.shibboleth.idp.attribute.consent.AttributeRelease: A timestamp when consent for this attribute release was given.
ConsentEngineImpl - Class in net.shibboleth.idp.attribute.consent: Implements ConsentEngine.
ConsentEngineImpl() - Constructor for class net.shibboleth.idp.attribute.consent.ConsentEngineImpl
ConsentHelper - Class in net.shibboleth.idp.attribute.consent: Consent helper class.
ConsentHelper() - Constructor for class net.shibboleth.idp.attribute.consent.ConsentHelper: Default constructor.
ConsentHelper.SortedAttributeSet - Class in net.shibboleth.idp.attribute.consent: A sorted set of attributes.
ConsentHelper.SortedAttributeSet(List<String>, Collection<IdPAttribute>) - Constructor for class net.shibboleth.idp.attribute.consent.ConsentHelper.SortedAttributeSet: Constructs a new sorted set of attributes.
ConsentServlet - Class in net.shibboleth.idp.attribute.consent: Consent servlet which control the consent UI.
ConsentServlet() - Constructor for class net.shibboleth.idp.attribute.consent.ConsentServlet
ConsentServlet.DisplayAttribute - Class in net.shibboleth.idp.attribute.consent: Aggregation class for an attribute.
ConsentServlet.DisplayAttribute(IdPAttribute, Locale) - Constructor for class net.shibboleth.idp.attribute.consent.ConsentServlet.DisplayAttribute: Constructs a display attribute from an attribute and defined locale.
contains(IdPAttribute) - Method in class net.shibboleth.idp.attribute.consent.AttributeRelease: Checks if an @see AttributeRelease contains a given @see Attribute.
containsAttributeRelease(String, String, String) - Method in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: Checks if the storage contains a attribute release for a specific user, relying party and attribute.
containsAttributeRelease(String, String, String) - Method in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: Checks if the storage contains a attribute release for a specific user, relying party and attribute.
containsAttributeRelease(String, String, String) - Method in interface net.shibboleth.idp.attribute.consent.storage.Storage: Checks if the storage contains a attribute release for a specific user, relying party and attribute.
containsUser(String) - Method in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: Checks if the storage contains a user.
containsUser(String) - Method in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: Checks if the storage contains a user.
containsUser(String) - Method in interface net.shibboleth.idp.attribute.consent.storage.Storage: Checks if the storage contains a user.
createAttributeRelease(String, String, AttributeRelease) - Method in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: Creates an attribute releases for a specific user and relying party.
createAttributeRelease(String, String, AttributeRelease) - Method in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: Creates an attribute releases for a specific user and relying party.
createAttributeRelease(String, String, AttributeRelease) - Method in interface net.shibboleth.idp.attribute.consent.storage.Storage: Creates an attribute releases for a specific user and relying party.
createAttributeReleases(Collection<IdPAttribute>, DateTime) - Static method in class net.shibboleth.idp.attribute.consent.AttributeRelease: Creates a collection of @see AttributeRelease.
createDisplayAttributes(Collection<IdPAttribute>, Locale) - Method in class net.shibboleth.idp.attribute.consent.ConsentServlet: Creates a list of display attributes using a specific locale.
createUser(String, String) - Method in class net.shibboleth.idp.attribute.consent.ConsentEngineImpl: Creates a user and attaches her the already given attribute release consents for a specific relying party.
createUser(User) - Method in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: Creates a user.
createUser(User) - Method in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: Creates a user.
createUser(User) - Method in interface net.shibboleth.idp.attribute.consent.storage.Storage: Creates a user.

D

deleteAttributeReleases(String, String) - Method in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: Deletes the attribute releases from the storage for a specific user and relying party.
deleteAttributeReleases(String, String) - Method in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: Deletes the attribute releases from the storage for a specific user and relying party.
deleteAttributeReleases(String, String) - Method in interface net.shibboleth.idp.attribute.consent.storage.Storage: Deletes the attribute releases from the storage for a specific user and relying party.
description - Variable in class net.shibboleth.idp.attribute.consent.ConsentServlet.DisplayAttribute: The description of the attribute.
determineConsent(ConsentContext) - Method in class net.shibboleth.idp.attribute.consent.ConsentEngineImpl
doGet(HttpServletRequest, HttpServletResponse) - Method in class net.shibboleth.idp.attribute.consent.ConsentServlet
doPost(HttpServletRequest, HttpServletResponse) - Method in class net.shibboleth.idp.attribute.consent.ConsentServlet

F

findUserId(String, Collection<IdPAttribute>) - Static method in class net.shibboleth.idp.attribute.consent.ConsentHelper: Searches the user identification attribute in the collection of released attributes and returns its value as user id.

G

getAttributeConsumingService(String) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Gets the attribute consuming service for a specific relying party.
getAttributeDescription(IdPAttribute, Locale) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Gets the localized description of an attribute.
getAttributeId() - Method in class net.shibboleth.idp.attribute.consent.AttributeRelease: Gets the attribute id.
getAttributeName(IdPAttribute, Locale) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Gets the localized name of an attribute.
getAttributeReleases(String) - Method in class net.shibboleth.idp.attribute.consent.User: Gets the attribute releases for a specific relying party.
getAvailableDescriptionLocales(List<ServiceDescription>) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Gets all available locales for relying party descriptions.
getAvailableNameLocales(List<ServiceName>) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Gets all available locales for relying party names.
getConsentContext(HttpServletRequest) - Static method in class net.shibboleth.idp.attribute.consent.ConsentHelper: Gets the consent context from the HTTP request.
getDate() - Method in class net.shibboleth.idp.attribute.consent.AttributeRelease: Gets the timestamp when consent for this attribute release was given.
getDescription() - Method in class net.shibboleth.idp.attribute.consent.ConsentServlet.DisplayAttribute: Gets the description.
getId() - Method in class net.shibboleth.idp.attribute.consent.User: Gets the userId.
getName() - Method in class net.shibboleth.idp.attribute.consent.ConsentServlet.DisplayAttribute: Gets the name.
getRelyingParty(ConsentContext) - Static method in class net.shibboleth.idp.attribute.consent.ConsentHelper: Retrieves the entityId of the relying party.
getRelyingPartyDescription(String, Locale) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Gets the localized description of a relying party.
getRelyingPartyDescription(List<ServiceDescription>, Locale) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Gets the localized name of a list of service descriptions.
getRelyingPartyName(String, Locale) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Gets the localized name of a relying party.
getRelyingPartyName(List<ServiceName>, Locale) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Gets the localized name of a list of service names.
getRequest(ConsentContext) - Static method in class net.shibboleth.idp.attribute.consent.ConsentHelper: Gets the HTTP request from the consent context.
getResponse(ConsentContext) - Static method in class net.shibboleth.idp.attribute.consent.ConsentHelper: Gets the HTTP response from the consent context.
getServiceDescriptions(String) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Gets a list of all service descriptions for a relying party.
getServiceNames(String) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Gets a list of all service names for a relying party.
getValues() - Method in class net.shibboleth.idp.attribute.consent.ConsentServlet.DisplayAttribute: Gets the values.
getValuesHash() - Method in class net.shibboleth.idp.attribute.consent.AttributeRelease: Gets the hash value of the attribute values.
globalConsent - Variable in class net.shibboleth.idp.attribute.consent.User: Whether the user has given global consent or not.
globalConsentEnabled - Variable in class net.shibboleth.idp.attribute.consent.ConsentServlet: Whether global consent is enabled or not.

H

hasApprovedAttributes(String, Collection<IdPAttribute>) - Method in class net.shibboleth.idp.attribute.consent.User: Checks if the user has given (in past) attribute release consent to all released attributes.
hasGlobalConsent() - Method in class net.shibboleth.idp.attribute.consent.User: Gets the global consent flag.
hashAttributeValues(IdPAttribute) - Static method in class net.shibboleth.idp.attribute.consent.ConsentHelper: Hashes the values of a given @see Attribute.

I

id - Variable in class net.shibboleth.idp.attribute.consent.User: The users id.
initialize() - Method in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: Initializes the cache storage.
isConsentRevocationRequested(ConsentContext) - Static method in class net.shibboleth.idp.attribute.consent.ConsentHelper: Checks if consent revocation is requested.

J

JDBCStorage - Class in net.shibboleth.idp.attribute.consent.storage: JDBC implementation.
JDBCStorage() - Constructor for class net.shibboleth.idp.attribute.consent.storage.JDBCStorage
JDBCStorage.AttributeReleaseMapper - Class in net.shibboleth.idp.attribute.consent.storage: AttributeRelease row mapper.
JDBCStorage.AttributeReleaseMapper() - Constructor for class net.shibboleth.idp.attribute.consent.storage.JDBCStorage.AttributeReleaseMapper
JDBCStorage.UserMapper - Class in net.shibboleth.idp.attribute.consent.storage: User row mapper.
JDBCStorage.UserMapper() - Constructor for class net.shibboleth.idp.attribute.consent.storage.JDBCStorage.UserMapper
jdbcTemplate - Variable in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: The JDBC template.

L

localeEnforcement - Variable in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Whether the preferred is enforced or not.
localizationHelper - Variable in class net.shibboleth.idp.attribute.consent.ConsentServlet: The LocalizationHelper which is used.
LocalizationHelper - Class in net.shibboleth.idp.attribute.consent: Localization helper class.
LocalizationHelper() - Constructor for class net.shibboleth.idp.attribute.consent.LocalizationHelper
logger - Variable in class net.shibboleth.idp.attribute.consent.ConsentEngineImpl: Class logger.
LOGGER - Static variable in class net.shibboleth.idp.attribute.consent.ConsentHelper: Class logger.
logger - Variable in class net.shibboleth.idp.attribute.consent.ConsentServlet: Class logger.
logger - Variable in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Class logger.

M

mapRow(ResultSet, int) - Method in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage.AttributeReleaseMapper
mapRow(ResultSet, int) - Method in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage.UserMapper
metadataResolver - Variable in class net.shibboleth.idp.attribute.consent.LocalizationHelper: The MetadataProvider used for resolving localized information.

N

name - Variable in class net.shibboleth.idp.attribute.consent.ConsentServlet.DisplayAttribute: The name of the attribute.
net.shibboleth.idp.attribute.consent - package net.shibboleth.idp.attribute.consent
net.shibboleth.idp.attribute.consent.storage - package net.shibboleth.idp.attribute.consent.storage

P

preferredLocale - Variable in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Preferred locale.

R

readAttributeReleases(String, String) - Method in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: Reads the attribute releases from the storage for a specific user and relying party.
readAttributeReleases(String, String) - Method in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: Reads the attribute releases from the storage for a specific user and relying party.
readAttributeReleases(String, String) - Method in interface net.shibboleth.idp.attribute.consent.storage.Storage: Reads the attribute releases from the storage for a specific user and relying party.
readUser(String) - Method in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: Reads a user from the storage.
readUser(String) - Method in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: Reads a user from the storage.
readUser(String) - Method in interface net.shibboleth.idp.attribute.consent.storage.Storage: Reads a user from the storage.
releases - Variable in class net.shibboleth.idp.attribute.consent.User: A map of attribute releases.
RELYINGPARTYID_KEY - Static variable in class net.shibboleth.idp.attribute.consent.ConsentServlet: Key for the current relying party id.
relyingPartyWhiteBlackList - Variable in class net.shibboleth.idp.attribute.consent.ConsentEngineImpl: A collection of relying party ids which are white- or blacklisted.
relyingPartyWhiteBlackListIsBlacklist - Variable in class net.shibboleth.idp.attribute.consent.ConsentEngineImpl: Whether the relyingPartyWhiteBlackList is treated as blacklist or not (whitelist).
removeBlacklistedAttributes(Collection<String>, Collection<IdPAttribute>) - Static method in class net.shibboleth.idp.attribute.consent.ConsentHelper: Removes blacklisted attributes from the attributes which will be released.

S

selectLocale(Collection<Locale>, Locale) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Selects the right locale from a collection of available locales.
serialVersionUID - Static variable in class net.shibboleth.idp.attribute.consent.ConsentHelper.SortedAttributeSet: The serial version UID.
serialVersionUID - Static variable in class net.shibboleth.idp.attribute.consent.ConsentServlet: Serial version UID.
setAttributeReleases(String, Collection<AttributeRelease>) - Method in class net.shibboleth.idp.attribute.consent.User: Sets the attribute releases for a specific relying party.
setDataSource(DataSource) - Method in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: Sets the data source.
setGlobalConsent(boolean) - Method in class net.shibboleth.idp.attribute.consent.User: Sets the global consent flag.
setLocaleEnforcement(boolean) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Sets or unsets locale enforcement.
setMetadataProvider(MetadataResolver) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Sets the metadata provider.
setPreferredLocale(Locale) - Method in class net.shibboleth.idp.attribute.consent.LocalizationHelper: Sets the preferred locale.
showAttributeReleaseView(ConsentContext, User, String, Collection<IdPAttribute>) - Method in class net.shibboleth.idp.attribute.consent.ConsentEngineImpl: Forwards to the attribute release view.
skipRelyingParty(Collection<String>, boolean, String) - Static method in class net.shibboleth.idp.attribute.consent.ConsentHelper: Checks if user consent for a specific relying party should be skipped.
sortAttributes(List<String>, Collection<IdPAttribute>) - Static method in class net.shibboleth.idp.attribute.consent.ConsentHelper: Sorts the released attributes according the specified sort order.
storage - Variable in class net.shibboleth.idp.attribute.consent.ConsentEngineImpl: The Storage instance which is used.
storage - Variable in class net.shibboleth.idp.attribute.consent.ConsentServlet: The Storage instance which is used.
Storage - Interface in net.shibboleth.idp.attribute.consent.storage: Storage interface for user consent.

T

toString() - Method in class net.shibboleth.idp.attribute.consent.User

U

updateAttributeRelease(String, String, AttributeRelease) - Method in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: Updates the attribute releases for a specific user and relying party.
updateAttributeRelease(String, String, AttributeRelease) - Method in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: Updates the attribute releases for a specific user and relying party.
updateAttributeRelease(String, String, AttributeRelease) - Method in interface net.shibboleth.idp.attribute.consent.storage.Storage: Updates the attribute releases for a specific user and relying party.
updateUser(User) - Method in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: Updates a user.
updateUser(User) - Method in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: Updates a user.
updateUser(User) - Method in interface net.shibboleth.idp.attribute.consent.storage.Storage: Updates a user.
User - Class in net.shibboleth.idp.attribute.consent: Represents the current user.
User(String, boolean) - Constructor for class net.shibboleth.idp.attribute.consent.User: Constructs a @see User.
USER_KEY - Static variable in class net.shibboleth.idp.attribute.consent.ConsentServlet: Key for the current user object.
userIdAttribute - Variable in class net.shibboleth.idp.attribute.consent.ConsentEngineImpl: A attribute id which is used for unique user identification.
userMapper - Variable in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: The user mapper.
userPartition - Variable in class net.shibboleth.idp.attribute.consent.storage.CacheStorage: The user partition.
userTable - Variable in class net.shibboleth.idp.attribute.consent.storage.JDBCStorage: The name of the user table.

V

values - Variable in class net.shibboleth.idp.attribute.consent.ConsentServlet.DisplayAttribute: The values of the attribute.
valuesHash - Variable in class net.shibboleth.idp.attribute.consent.AttributeRelease: An hash over all attribute values.
velocityEngine - Variable in class net.shibboleth.idp.attribute.consent.ConsentServlet: The velocity engine.

A C D F G H I J L M N P R S T U V