net.shibboleth.metadata.dom.saml.mdrpi

Class RegistrationAuthorityItemIdentificationStrategy

java.lang.Object

net.shibboleth.metadata.AbstractCompositeItemIdentificationStrategy

net.shibboleth.metadata.FirstItemIdItemIdentificationStrategy

net.shibboleth.metadata.dom.saml.mdrpi.RegistrationAuthorityItemIdentificationStrategy

All Implemented Interfaces:

ItemIdentificationStrategy

@ThreadSafe
public class RegistrationAuthorityItemIdentificationStrategy
extends FirstItemIdItemIdentificationStrategy

Item identification strategy for interfederation use cases. The basic identifier is taken from FirstItemIdItemIdentificationStrategy. The extra identifier is based on a RegistrationAuthority if one of those is present. The extra identifier is omitted if it is present in a specified blacklist, and it can be mapped to a simpler value for display if desired.

Field Summary

Fields

Modifier and Type	Field and Description
private Set<String>	ignoredRegistrationAuthorities Set of registration authorities to be ignored.
private Map<String,String>	registrationAuthorityDisplayNames Replacement display names for registration authorities.

Constructor Summary

Constructors

Constructor and Description
RegistrationAuthorityItemIdentificationStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getExtraIdentifier(Item<?> item) Derive a display name for an entity's registration authority, if it has one.
Collection<String>	getIgnoredRegistrationAuthorities() Returns the set of registration authorities we are ignoring.
Map<String,String>	getRegistrationAuthorityDisplayNames() Returns the map of display names for registration authorities.
void	setIgnoredRegistrationAuthorities(Collection<String> registrars) Set the set of registration authorities we are ignoring.
void	setRegistrationAuthorityDisplayNames(Map<String,String> names) Sets the map of display names for registration authorities.

Methods inherited from class net.shibboleth.metadata.FirstItemIdItemIdentificationStrategy

getBasicIdentifier

Methods inherited from class net.shibboleth.metadata.AbstractCompositeItemIdentificationStrategy

getItemIdentifier, getNoItemIdIdentifier, setNoItemIdIdentifier

Methods inherited from class java.lang.Object

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

Field Detail

ignoredRegistrationAuthorities

@Nonnull
private Set<String> ignoredRegistrationAuthorities

Set of registration authorities to be ignored.

registrationAuthorityDisplayNames

@Nonnull
private Map<String,String> registrationAuthorityDisplayNames

Replacement display names for registration authorities.

Constructor Detail

RegistrationAuthorityItemIdentificationStrategy

public RegistrationAuthorityItemIdentificationStrategy()

Method Detail

getIgnoredRegistrationAuthorities

@Nonnull
public Collection<String> getIgnoredRegistrationAuthorities()

Returns the set of registration authorities we are ignoring.

Returns:

Set of registration authority names.

setIgnoredRegistrationAuthorities

public void setIgnoredRegistrationAuthorities(@Nullable
                                     Collection<String> registrars)

Set the set of registration authorities we are ignoring.

Parameters:

registrars - Set of registration authority names to ignore.

getRegistrationAuthorityDisplayNames

public Map<String,String> getRegistrationAuthorityDisplayNames()

Returns the map of display names for registration authorities.

Returns:

Map of display names for authorities.

setRegistrationAuthorityDisplayNames

public void setRegistrationAuthorityDisplayNames(@Nullable
                                        Map<String,String> names)

Sets the map of display names for registration authorities.

Parameters:

names - Map of display names for registration authorities.

getExtraIdentifier

@Nullable
protected String getExtraIdentifier(@Nonnull
                                 Item<?> item)

Derive a display name for an entity's registration authority, if it has one.

Overrides:

getExtraIdentifier in class FirstItemIdItemIdentificationStrategy

Parameters:

item - Item to derive an identifier for.

Returns:

registration authority name, or null.