net.shibboleth.idp.saml.attribute.principalconnector.impl

Class PrinicpalConnectorCanonicalizer

java.lang.Object

net.shibboleth.idp.saml.attribute.principalconnector.impl.PrinicpalConnectorCanonicalizer

All Implemented Interfaces:

net.shibboleth.idp.attribute.resolver.LegacyPrincipalDecoder

public class PrinicpalConnectorCanonicalizer
extends Object
implements net.shibboleth.idp.attribute.resolver.LegacyPrincipalDecoder

Implements SAML subject canonicalization using a series of PrincipalConnector instances.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.
private Collection<PrincipalConnector>	principalConnectors The connectors.

Constructor Summary

Constructors

Constructor and Description
PrinicpalConnectorCanonicalizer()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	canonicalize(org.opensaml.saml.saml1.core.NameIdentifier nameIdentifier, SubjectCanonicalizationContext c14nContext) Canonicalize the provided NameIdentifier with respect to the provided SubjectCanonicalizationContext.
protected String	canonicalize(org.opensaml.saml.saml2.core.NameID nameID, SubjectCanonicalizationContext c14nContext) Canonicalize the provided NameID with respect to the provided SubjectCanonicalizationContext.
String	canonicalize(SubjectCanonicalizationContext c14nContext) Resolve the principal with respect to the provided context.
boolean	hasValidConnectors()
void	setConnectors(Collection<PrincipalConnector> connectors) Set the connectors we care about.

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

principalConnectors

@Nonnull
@NonnullElements
private Collection<PrincipalConnector> principalConnectors

The connectors.

Constructor Detail

PrinicpalConnectorCanonicalizer

public PrinicpalConnectorCanonicalizer()

Method Detail

setConnectors

public void setConnectors(@Nullable@NullableElements
                 Collection<PrincipalConnector> connectors)

Set the connectors we care about.

Parameters:

connectors - the connectors we care about.

hasValidConnectors

public boolean hasValidConnectors()

Specified by:

hasValidConnectors in interface net.shibboleth.idp.attribute.resolver.LegacyPrincipalDecoder

canonicalize

@Nullable
public String canonicalize(@Nonnull
                           SubjectCanonicalizationContext c14nContext)
                    throws net.shibboleth.idp.attribute.resolver.ResolutionException

Resolve the principal with respect to the provided context. This is expected to strip out the NameID or NameIdentifier and match it against the connector definitions configured.

Specified by:

canonicalize in interface net.shibboleth.idp.attribute.resolver.LegacyPrincipalDecoder

Parameters:

c14nContext - what to look at.

Returns:

the IdP principal, or null if no definitions were applicable. A null will be turned into a AuthnEventIds.INVALID_SUBJECT event

Throws:

net.shibboleth.idp.attribute.resolver.ResolutionException - if we recognise the definition but could not decode it (data out of date and so forth) This will be turned into a AuthnEventIds.SUBJECT_C14N_ERROR event

canonicalize

@Nullable
protected String canonicalize(@Nonnull
                           org.opensaml.saml.saml1.core.NameIdentifier nameIdentifier,
                           @Nonnull
                           SubjectCanonicalizationContext c14nContext)
                       throws net.shibboleth.idp.attribute.resolver.ResolutionException

Canonicalize the provided NameIdentifier with respect to the provided SubjectCanonicalizationContext.

We iterate over all the connectors to see whether anything matches.

Parameters:

nameIdentifier - the NameIdentifier

c14nContext - the SubjectCanonicalizationContext

Returns:

the Principal, or null if we could not match

Throws:

net.shibboleth.idp.attribute.resolver.ResolutionException - if we get a fatal error during decoding.

canonicalize

@Nullable
protected String canonicalize(@Nonnull
                           org.opensaml.saml.saml2.core.NameID nameID,
                           @Nonnull
                           SubjectCanonicalizationContext c14nContext)
                       throws net.shibboleth.idp.attribute.resolver.ResolutionException

Canonicalize the provided NameID with respect to the provided SubjectCanonicalizationContext.
We iterate over all the connectors to see whether anything matches.

Parameters:

nameID - the NameID

c14nContext - the SubjectCanonicalizationContext

Returns:

the Principal, or null if we could not match

Throws:

net.shibboleth.idp.attribute.resolver.ResolutionException - if we get a fatal error during decoding.