CryptoTransientNameIDDecoder (Shibboleth Identity Provider 4.3.3-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.BaseCryptoTransientDecoder
      - net.shibboleth.idp.saml.nameid.impl.CryptoTransientNameIDDecoder

All Implemented Interfaces:

NameIDDecoder, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent
```
public class CryptoTransientNameIDDecoder
extends BaseCryptoTransientDecoder
implements NameIDDecoder
```
Processes a transient NameID, checks that its NameIDType.getNameQualifier() and NameIDType.getSPNameQualifier() are correct, and decodes XSString.getValue() via the base class (reversing the work done by CryptoTransientIdGenerationStrategy).

Constructor Summary

Constructors
Constructor Description

CryptoTransientNameIDDecoder()

Method Summary

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

Methods inherited from class net.shibboleth.idp.saml.nameid.impl.BaseCryptoTransientDecoder
decode, doInitialize, getDataSealer, getLogPrefix, setDataSealer

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

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
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
  - CryptoTransientNameIDDecoder
```
public CryptoTransientNameIDDecoder()
```
- Method Detail
  - decode
```
@Nullable
@NotEmpty
public 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.
    
    Specified by:
    
    decode in interface NameIDDecoder
    
    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