CreateResult (Shibboleth Identity Provider 4.3.4-SNAPSHOT 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.profile.interceptor.AbstractProfileInterceptorAction
        
        net.shibboleth.idp.consent.flow.impl.AbstractConsentAction
        
        net.shibboleth.idp.consent.flow.storage.impl.AbstractConsentStorageAction
        
        net.shibboleth.idp.consent.flow.storage.impl.AbstractConsentIndexedStorageAction
        
        net.shibboleth.idp.consent.flow.storage.impl.CreateResult

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action
```
public class CreateResult
extends AbstractConsentIndexedStorageAction
```
Consent action to create a consent result representing the result of a consent flow. The result is added to the profile interceptor context for eventual storage by a storage service. The result of the consent flow is created from the current consents of the consent context.

Event:

EventIds.PROCEED_EVENT_ID

Precondition:

The current consents in the consent context must not be empty.

Postcondition:

A ConsentResult will be created representing the current consents and will be added to the ProfileInterceptorContext.

Field Summary

Fields
Modifier and Type Field Description

private org.slf4j.Logger log
Class logger.
- Fields inherited from class net.shibboleth.idp.consent.flow.storage.impl.AbstractConsentIndexedStorageAction
  DEFAULT_STORAGE_INDEX_KEY

Constructor Summary

Constructors
Constructor Description

CreateResult()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doExecute(ProfileRequestContext profileRequestContext, ProfileInterceptorContext interceptorContext)`	Performs this profile interceptor action.
`protected boolean`	`doPreExecute(ProfileRequestContext profileRequestContext, ProfileInterceptorContext interceptorContext)`	Performs this profile interceptor action's pre-execute step.

Methods inherited from class net.shibboleth.idp.consent.flow.storage.impl.AbstractConsentIndexedStorageAction
addKeyToStorageIndex, doInitialize, getStorageIndexKey, getStorageKeysFromIndex, getStorageKeysSerializer, pruneStorageRecords, removeKeyFromStorageIndex, setStorageIndexKeyLookupStrategy, setStorageKeysSerializer, setStorageKeysStrategy, storeResult, storeResultWithIndex

Methods inherited from class net.shibboleth.idp.consent.flow.storage.impl.AbstractConsentStorageAction
getStorageContext, getStorageContextLookupStrategy, getStorageKey, getStorageKeyLookupStrategy, getStorageSerializer, getStorageService, setStorageContextLookupStrategy, setStorageKeyLookupStrategy, setStorageSerializer

Methods inherited from class net.shibboleth.idp.consent.flow.impl.AbstractConsentAction
getConsentContext, getConsentFlowDescriptor, setConsentContextLookupStrategy

Methods inherited from class net.shibboleth.idp.profile.interceptor.AbstractProfileInterceptorAction
doExecute, doPreExecute, setLookupStrategy

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction
doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, 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, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, setHttpServletRequest, setHttpServletRequestSupplier, setHttpServletResponse, setHttpServletResponseSupplier

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.InitializableComponent
initialize, isInitialized

- Field Detail
  - log
```
@Nonnull
private final org.slf4j.Logger log
```
    Class logger.
- Constructor Detail
  - CreateResult
```
public CreateResult()
```
- Method Detail
  - doPreExecute
```
protected boolean doPreExecute(@Nonnull
                               ProfileRequestContext profileRequestContext,
                               @Nonnull
                               ProfileInterceptorContext interceptorContext)
```
    Performs this profile interceptor action's pre-execute step. Default implementation returns true.
    
    Overrides:
    
    doPreExecute in class AbstractConsentIndexedStorageAction
    
    Parameters:
    
    profileRequestContext - the current profile request context
    
    interceptorContext - the current profile interceptor context
    
    Returns:
    
    true iff execution should continue
  - doExecute
```
protected void doExecute(@Nonnull
                         ProfileRequestContext profileRequestContext,
                         @Nonnull
                         ProfileInterceptorContext interceptorContext)
```
    Performs this profile interceptor action. Default implementation does nothing.
    
    Overrides:
    
    doExecute in class AbstractProfileInterceptorAction
    
    Parameters:
    
    profileRequestContext - the current profile request context
    
    interceptorContext - the current profile interceptor context