net.shibboleth.idp.attribute.resolver

Interface LegacyPrincipalDecoder

public interface LegacyPrincipalDecoder

Definition of the legacy Principal Connectors.
This is the component which takes a context and produces the unique principal. Code will only be implemented by the legacy parsing of the <PrinicipalConnector> statements and will consume CanonicalizationContexts.

Method Summary

Methods

Modifier and Type	Method and Description
String	canonicalize(SubjectCanonicalizationContext context) Resolve the principal with respect to the provided context.
boolean	hasValidConnectors() Report on whether this decoder has any configured connectors.

Method Detail

canonicalize

@Nullable
String canonicalize(@Nonnull
                           SubjectCanonicalizationContext context)
                    throws 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.

Parameters:

context - what to look at.

Returns:

the IdP principal, or null if no definitions were applicable

Throws:

ResolutionException - if we recognise the definition but could not decode it (data out of date and so forth)

hasValidConnectors

boolean hasValidConnectors()

Report on whether this decoder has any configured connectors.

Returns:

whether there are any decoders.