Package net.shibboleth.idp.saml.nameid.impl

Class BaseTransientDecoder

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.BaseTransientDecoder

All Implemented Interfaces:

Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

Direct Known Subclasses:

TransientNameIDDecoder, TransientNameIdentifierDecoder

public abstract class BaseTransientDecoder
extends AbstractIdentifiableInitializableComponent

An abstract action which contains the logic to do transient decoding matching (shared between SAML2 and SAML1).

Field Summary

Fields

Modifier and Type	Field	Description
private StorageService	idStore	Store used to map identifiers to principals.
private org.slf4j.Logger	log	Class logger.
private String	logPrefix	cache for the log prefix - to save multiple recalculations.

Constructor Summary

Constructors

Constructor	Description
BaseTransientDecoder()

Method Summary

Modifier and Type	Method	Description
String	decode(String transientId, String requesterId)	Convert the transient Id into the principal.
protected void	doInitialize()
StorageService	getIdStore()	Gets the ID store we are using.
protected String	getLogPrefix()	Return a prefix for logging messages for this component.
void	setIdStore(StorageService store)	Sets the ID store we should use.

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

idStore

@NonnullAfterInit
private StorageService idStore

Store used to map identifiers to principals.

logPrefix

@Nullable
private String logPrefix

cache for the log prefix - to save multiple recalculations.

Constructor Detail

BaseTransientDecoder

public BaseTransientDecoder()

Method Detail

getIdStore

@NonnullAfterInit
public StorageService getIdStore()

Gets the ID store we are using.

Returns:

the ID store we are using.

setIdStore

public void setIdStore(@Nonnull
                       StorageService store)

Sets the ID store we should use.

Parameters:

store - the store to use.

decode

@Nullable
public String decode(@Nonnull
                     String transientId,
                     @Nonnull @NotEmpty
                     String requesterId)
              throws NameDecoderException

Convert the transient Id into the principal.

Parameters:

transientId - the transientID

requesterId - the requested (SP)

Returns:

the decoded principal

Throws:

NameDecoderException - if a decode error occurs

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

getLogPrefix

@Nonnull
@NotEmpty
protected String getLogPrefix()

Return a prefix for logging messages for this component.

Returns:

a string for insertion at the beginning of any log messages