FinalizeSAMLSubjectCanonicalization (Shibboleth IdP :: SAML Profile Implementation 4.2.1 API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - org.opensaml.profile.action.AbstractProfileAction
  - - org.opensaml.profile.action.AbstractConditionalProfileAction
    - - net.shibboleth.idp.profile.AbstractProfileAction
      - net.shibboleth.idp.saml.profile.impl.FinalizeSAMLSubjectCanonicalization

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action
```
public class FinalizeSAMLSubjectCanonicalization
extends AbstractProfileAction
```
An action that runs after a completed canonicalization of a SAML Subject and transfers information into a SubjectContext child of the ProfileRequestContext.
The context is populated based on the presence of a canonical principal name in a SubjectCanonicalizationContext. Any SubjectCanonicalizationContext found will be removed.
Event:

EventIds.PROCEED_EVENT_ID, AuthnEventIds.INVALID_SUBJECT_C14N_CTX

Postcondition:
```
ProfileRequestContext.getSubcontext(SubjectCanonicalizationContext.class) == null
```

Field Summary

Fields
Modifier and Type Field Description

private String canonicalPrincipalName
The principal name extracted from the context tree.

private org.slf4j.Logger log
Class logger.

Constructor Summary

Constructors
Constructor Description

FinalizeSAMLSubjectCanonicalization()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doExecute(ProfileRequestContext profileRequestContext)`
`protected boolean`	`doPreExecute(ProfileRequestContext profileRequestContext)`

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction
doExecute, execute, getMessage, getMessage, getMessage, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction
getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction
doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
destroy, doDestroy, doInitialize, 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.InitializableComponent
initialize, isInitialized

Field Detail
- log
```
@Nonnull
private final org.slf4j.Logger log
```
  Class logger.
- canonicalPrincipalName
```
@Nullable
private String canonicalPrincipalName
```
  The principal name extracted from the context tree.

Constructor Detail
- FinalizeSAMLSubjectCanonicalization
```
public FinalizeSAMLSubjectCanonicalization()
```

Method Detail

doPreExecute

protected boolean doPreExecute(@Nonnull
                               ProfileRequestContext profileRequestContext)

Overrides:: doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
                         ProfileRequestContext profileRequestContext)

Overrides:: doExecute in class AbstractProfileAction