If this condition is configured and fulfilled, the step is skipped and the flow execution continues with the subsequent step.
",
optional = true
)
@GroupProperty(groupIdentifier = "Tags/Guards")
private FlowConditionConfig skipCondition;
@PluginProperty(
description = "This step is executed only if the configured pre condition is fulfilled. If the condition is not fulfilled, the step and flow execution fail immediately. The step is not initialized and no step method can be called. If no condition is configured, the behavior is that of a fulfilled pre condition.",
optional = true
)
@GroupProperty(groupIdentifier = "Tags/Guards")
private FlowConditionConfig preCondition;
@BooleanProperty(
description = "If enabled, this step is only executed if it has been dynamically activated from a previous step. If it has not been activated, the step is skipped (equivalent to when the skip condition is fulfilled).",
optional = true,
defaultValue = "false"
)
@GroupProperty(groupIdentifier = "Flow Control")
private boolean requiresActivation;
public static final String REQUIRES_ACTIVATION_FIELD = "requiresActivation";
@PluginListProperty(description = "This step grants these tags if it completes successfully.", optional = true)
@GroupProperty(groupIdentifier = "Tags/Guards")
private List tagsOnSuccess;
@PluginProperty(
description = "ID of this step. This is only needed if this step is the target of a goto action or if this step requires activation.",
optional = true,
displayName = "Step ID"
)
@GroupProperty(groupIdentifier = "Flow Control")
private StepIdConfig stepId;
public static final String STEP_ID_FIELD = "stepId";
public static final String STEP_ID_DISPLAY_NAME = "Step ID";
@PluginMapProperty(
description = "If the step fails (no retry) and a goto target for the error code is defined here, the flow does not fail\nand instead a \"goto\" to the specified target step is executed. Note that even when the \"goto\" is executed, any\nerror codes that are considered a failed factor attempt will still increment the \"failed attempts\" counter,\nand may lead to the user being locked. Therefore, this may still result in a failed flow.
\nA typical application of this feature is switching to an alternative authentication factor step, if an external\nservice (e.g. Futurae server, SMS gateway) is not available (error code EXTERNAL_SERVICE_UNAVAILABLE\nwith \"Strict Counting\" disabled, which will not increment the \"failed attempts\" counter).\nOther error codes can be found in the IAM REST documentation, in both the general \"Error Codes\" section and\nin the documentation of specific endpoints.
",
optional = true
)
@GroupProperty(groupIdentifier = "Flow Control")
private Map onFailureGotos;
public static final String ON_FAILURE_GOTOS_FIELD = "onFailureGotos";
@PluginListProperty(
description = "A list of custom attributes that are returned in the REST response in addition to the\nstandard attributes the step already returns. The custom attributes defined here are only returned if the\nstep result does not lead to an error response.
\nCustom attributes are added to the response when a step is initialized and when actions are executed on the step. They will therefore be available in the response leading to this step,\nand in any responses from endpoints specific to this step. For non-interactive steps, custom attributes are accumulated and added to the response leading to the next interactive step.
\nCustom attributes are not returned for 'retrieve' endpoints.
\n",
optional = true
)
@GroupProperty(groupIdentifier = "Advanced Settings")
private List customResponseAttributes;
@PluginListProperty(
description = "A list of custom attributes that are added to the REST response in case of a step failure during step execution.\nUnexpected failures leading to HTTP response status code 500 do not contain these attributes.\n",
optional = true
)
@GroupProperty(groupIdentifier = "Advanced Settings")
private List customFailureResponseAttributes;
@Override
public Optional getStepId() {
return Optional.ofNullable(this.stepId).map(StepIdConfig::getId);
}
@Override
public Optional getSkipCondition() {
return Optional.ofNullable(this.skipCondition);
}
@Override
public Optional getPreCondition() {
return Optional.ofNullable(this.preCondition);
}
protected AbstractFlowStepConfig(
@Nullable FlowConditionConfig skipCondition,
@Nullable FlowConditionConfig preCondition,
boolean requiresActivation,
List tagsOnSuccess,
@Nullable StepIdConfig stepId,
Map onFailureGotos,
List customResponseAttributes,
List customFailureResponseAttributes
) {
this.skipCondition = skipCondition;
this.preCondition = preCondition;
this.requiresActivation = requiresActivation;
this.tagsOnSuccess = tagsOnSuccess;
this.stepId = stepId;
this.onFailureGotos = onFailureGotos;
this.customResponseAttributes = customResponseAttributes;
this.customFailureResponseAttributes = customFailureResponseAttributes;
}
@ConfigurationValidator
static void validateStepIdPresentIfActivationRequired(
PluginConfiguration config, ConfigurationEnvironment env, ConfigurationContext context, Environment validationEnvironment
) throws ConfigurationException {
PluginConfiguration stepId = PluginPropertyValueReader.effectivePluginPropertyValue(config, "stepId", env, context);
if (stepId == null && requiresActivation(config, env, context)) {
throw new PropertyConstraintViolationException("stepId", config, env, context, "If this step 'Requires Activation', a 'Step ID' must be configured.");
}
}
private static boolean requiresActivation(PluginConfiguration config, ConfigurationEnvironment environment, ConfigurationContext context) throws PropertyConstraintViolationException {
try {
return BooleanPropertyValueReader.effectiveBooleanPropertyValue(config, "requiresActivation", environment, context);
} catch (PropertyTypeMismatchException e) {
return false;
}
}
@Override
public Map getOnFailureGotos() {
return this.onFailureGotos;
}
@Override
public boolean requiresActivation() {
return this.requiresActivation;
}
@Override
public List getTagsOnSuccess() {
return this.tagsOnSuccess;
}
@Override
public List getCustomResponseAttributes() {
return this.customResponseAttributes;
}
@Override
public List getCustomFailureResponseAttributes() {
return this.customFailureResponseAttributes;
}
@SuppressFBWarnings(justification = "generated code")
public AbstractFlowStepConfig() {
}
}