net.shibboleth.idp.tou

Class TOUHelper

java.lang.Object

net.shibboleth.idp.tou.TOUHelper

public final class TOUHelper
extends Object

Terms of use helper class. Provides static utility methods.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TOUHelper() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static String	findUserId(String userIdAttribute, Collection<IdPAttribute> releasedAttributes) Searches the user identification attribute in the collection of released attributes and returns its value as user id.
static String	getRelyingParty(TermsOfUseContext context) Retrieves the entityId of the relying party.
static HttpServletRequest	getRequest(TermsOfUseContext touContext) Gets the HTTP request from the terms of use context.
static HttpServletResponse	getResponse(TermsOfUseContext touContext) Gets the HTTP response from the terms of use context.
static TermsOfUseContext	getTermsOfUseContext(HttpServletRequest request) Gets the terms of use context from the HTTP request.
static String	getToUFingerprint(TOU tou) Gets the terms of use fingerprint.
static TOU	getToUForRelyingParty(Map<String,TOU> touMap, String entityId) Retrieves the mapped TOU for a specific relying party.
static Collection<IdPAttribute>	getUserAttributes(TermsOfUseContext context) Retrieves the entityId of the relying party.

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

TOUHelper

private TOUHelper()

Default constructor.

Method Detail

getRelyingParty

public static String getRelyingParty(TermsOfUseContext context)

Retrieves the entityId of the relying party.

Parameters:

context - The current terms of use context.

Returns:

The entityId of the relying party.

getUserAttributes

public static Collection<IdPAttribute> getUserAttributes(TermsOfUseContext context)

Retrieves the entityId of the relying party.

Parameters:

context - The current terms of use context.

Returns:

A collection of attribute which are releases to the relying party.

findUserId

public static final String findUserId(String userIdAttribute,
                Collection<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.

getToUForRelyingParty

public static TOU getToUForRelyingParty(Map<String,TOU> touMap,
                        String entityId)

Retrieves the mapped TOU for a specific relying party.

Parameters:

touMap - The relying party / terms of use map.

entityId - The relying party id.

Returns:

Returns the mapped TOU for this relying party id or null.

getToUFingerprint

public static String getToUFingerprint(TOU tou)

Gets the terms of use fingerprint.

Parameters:

tou - The TOU.

Returns:

Returns the terms of use fingerprint.

getTermsOfUseContext

public static TermsOfUseContext getTermsOfUseContext(HttpServletRequest request)

Gets the terms of use context from the HTTP request.

Parameters:

request - The HTTP request

Returns:

Returns the terms of use context.

getRequest

public static HttpServletRequest getRequest(TermsOfUseContext touContext)

Gets the HTTP request from the terms of use context.

Parameters:

touContext - The terms of use context.

Returns:

Returns the HTTP request.

getResponse

public static HttpServletResponse getResponse(TermsOfUseContext touContext)

Gets the HTTP response from the terms of use context.

Parameters:

touContext - The term of use context.

Returns:

Returns the HTTP response.