net.shibboleth.idp.attribute.consent

Class ConsentHelper

java.lang.Object

net.shibboleth.idp.attribute.consent.ConsentHelper

@ThreadSafe
public final class ConsentHelper
extends Object

Consent helper class. Provides static utility methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ConsentHelper.SortedAttributeSet A sorted set of attributes.

Field Summary

Fields

Modifier and Type	Field and Description
private static Logger	LOGGER Class logger.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ConsentHelper() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static String	findUserId(String userIdAttribute, Collection<net.shibboleth.idp.attribute.IdPAttribute> releasedAttributes) Searches the user identification attribute in the collection of released attributes and returns its value as user id.
static ConsentContext	getConsentContext(HttpServletRequest request) Gets the consent context from the HTTP request.
static String	getRelyingParty(ConsentContext context) Retrieves the entityId of the relying party.
static HttpServletRequest	getRequest(ConsentContext consentContext) Gets the HTTP request from the consent context.
static HttpServletResponse	getResponse(ConsentContext consentContext) Gets the HTTP response from the consent context.
static String	hashAttributeValues(net.shibboleth.idp.attribute.IdPAttribute attribute) Hashes the values of a given @see Attribute.
static boolean	isConsentRevocationRequested(ConsentContext consentContext) Checks if consent revocation is requested.
static Collection<net.shibboleth.idp.attribute.IdPAttribute>	removeBlacklistedAttributes(Collection<String> blacklist, Collection<net.shibboleth.idp.attribute.IdPAttribute> allAttributes) Removes blacklisted attributes from the attributes which will be released.
static boolean	skipRelyingParty(Collection<String> list, boolean isBlacklist, String relyingPartyId) Checks if user consent for a specific relying party should be skipped.
static SortedSet<net.shibboleth.idp.attribute.IdPAttribute>	sortAttributes(List<String> sortOrder, Collection<net.shibboleth.idp.attribute.IdPAttribute> releasedAttributes) Sorts the released attributes according the specified sort order.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final Logger LOGGER

Class logger.

Constructor Detail

ConsentHelper

private ConsentHelper()

Default constructor.

Method Detail

getRelyingParty

public static String getRelyingParty(ConsentContext context)

Retrieves the entityId of the relying party.

Parameters:

context - The current terms of use context.

Returns:

The entityId of the relying party.

isConsentRevocationRequested

public static boolean isConsentRevocationRequested(ConsentContext consentContext)

Checks if consent revocation is requested.

Parameters:

consentContext - The @see ConsentContext.

Returns:

Returns true if consent revocation was requested by the user.

hashAttributeValues

public static String hashAttributeValues(net.shibboleth.idp.attribute.IdPAttribute attribute)

Hashes the values of a given @see Attribute.

Parameters:

attribute - The @see Attribute.

Returns:

Returns the hash of all attribute values.

findUserId

public static final String findUserId(String userIdAttribute,
                Collection<net.shibboleth.idp.attribute.IdPAttribute> releasedAttributes)

Searches the user identification attribute in the collection of released attributes and returns its value as user id.

Parameters:

userIdAttribute - The id of the attribute which is used as user identification.

releasedAttributes - The collection of released attributes.

Returns:

Returns the user id.

skipRelyingParty

public static boolean skipRelyingParty(Collection<String> list,
                       boolean isBlacklist,
                       String relyingPartyId)

Checks if user consent for a specific relying party should be skipped. I.e., it searches for the relying party id within the white- or blacklist resp.

Parameters:

list - The collection of relying party ids.

isBlacklist - Indicates whether the list is a blacklist or not (whitelist).

relyingPartyId - the relying party id.

Returns:

Returns true if the relying party should skipped.

removeBlacklistedAttributes

public static Collection<net.shibboleth.idp.attribute.IdPAttribute> removeBlacklistedAttributes(Collection<String> blacklist,
                                                                                Collection<net.shibboleth.idp.attribute.IdPAttribute> allAttributes)

Removes blacklisted attributes from the attributes which will be released.

Parameters:

blacklist - A collection of attribute ids which are blacklisted

allAttributes - A collection of attributes which will be released.

Returns:

Returns a new collection of attributes without the blacklisted ones.

sortAttributes

public static SortedSet<net.shibboleth.idp.attribute.IdPAttribute> sortAttributes(List<String> sortOrder,
                                                                  Collection<net.shibboleth.idp.attribute.IdPAttribute> releasedAttributes)

Sorts the released attributes according the specified sort order.

Parameters:

sortOrder - A list of attribute ids which specifies the sort order.

releasedAttributes - A collection of attributes which will be released.

Returns:

Returns a new collection of sorted attributes.

getConsentContext

public static ConsentContext getConsentContext(HttpServletRequest request)

Gets the consent context from the HTTP request.

Parameters:

request - The HTTP request

Returns:

Returns the consent context.

getRequest

public static HttpServletRequest getRequest(ConsentContext consentContext)

Gets the HTTP request from the consent context.

Parameters:

consentContext - The consent context.

Returns:

Returns the HTTP request.

getResponse

public static HttpServletResponse getResponse(ConsentContext consentContext)

Gets the HTTP response from the consent context.

Parameters:

consentContext - The consent context.

Returns:

Returns the HTTP response.