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 StorageServiceidStoreStore used to map identifiers to principals.private org.slf4j.LoggerlogClass logger.private StringlogPrefixcache for the log prefix - to save multiple recalculations.
-
Constructor Summary
Constructors Constructor Description BaseTransientDecoder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringdecode(String transientId, String requesterId)Convert the transient Id into the principal.protected voiddoInitialize()StorageServicegetIdStore()Gets the ID store we are using.protected StringgetLogPrefix()Return a prefix for logging messages for this component.voidsetIdStore(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.
-
-
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 transientIDrequesterId- the requested (SP)- Returns:
- the decoded principal
- Throws:
NameDecoderException- if a decode error occurs
-
doInitialize
protected void doInitialize() throws ComponentInitializationException- Overrides:
doInitializein classAbstractIdentifiedInitializableComponent- Throws:
ComponentInitializationException
-
-