TransformingNameIDDecoder (Shibboleth Identity Provider 4.3.4-SNAPSHOT API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
  - - net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent
    - - net.shibboleth.idp.saml.nameid.impl.BaseTransformingDecoder
      - net.shibboleth.idp.saml.nameid.impl.TransformingNameIDDecoder

All Implemented Interfaces:

NameIDDecoder, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent
```
public class TransformingNameIDDecoder
extends BaseTransformingDecoder
implements NameIDDecoder
```
Transform from a NameID.

Constructor Summary

Constructors
Constructor Description

TransformingNameIDDecoder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`decode(SubjectCanonicalizationContext c14nContext, NameID nameIdentifier)`	Decode the provided `NameID`.

Methods inherited from class net.shibboleth.idp.saml.nameid.impl.BaseTransformingDecoder
decode, setLowercase, setTransforms, setUppercase

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent
setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
doInitialize, getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent
getId

- Constructor Detail
  - TransformingNameIDDecoder
```
public TransformingNameIDDecoder()
```
- Method Detail
  - decode
```
@Nullable
public String decode(@Nonnull
                     SubjectCanonicalizationContext c14nContext,
                     @Nonnull
                     NameID nameIdentifier)
              throws NameDecoderException
```
    Decode the provided NameID.
    If the object is incompatible with the decoder in some way, a null is returned.
    
    Specified by:
    
    decode in interface NameIDDecoder
    
    Parameters:
    
    c14nContext - the active c14n context
    
    nameIdentifier - the object to decode
    
    Returns:
    
    the principal decoded from the value, or null
    
    Throws:
    
    NameDecoderException - if an error occurred during translation