Package net.shibboleth.idp.saml.nameid

Interface NameIDDecoder

All Known Implementing Classes:

CryptoTransientNameIDDecoder, StoredPersistentIdDecoder, TransformingNameIDDecoder, TransientNameIDDecoder

public interface NameIDDecoder

Interface for converting a NameID back into a principal name.

Method Summary

Modifier and Type	Method	Description
String	decode(SubjectCanonicalizationContext c14nContext, NameID nameID)	Decode the provided NameID.

Method Details

decode

@Nullable
String decode(@Nonnull
 SubjectCanonicalizationContext c14nContext,
 @Nonnull
 NameID nameID)
       throws NameDecoderException

Decode the provided NameID.

If the object is incompatible with the decoder in some way, a null is returned.

Parameters:

c14nContext - the active c14n context

nameID - the object to decode

Returns:

the principal decoded from the value, or null

Throws:

NameDecoderException - if an error occurred during translation