de.xima.fc.form.identitytoken

Class IdentityTokenCheck

java.lang.Object

de.xima.fc.form.identitytoken.IdentityTokenCheck

public class IdentityTokenCheck
extends Object

Method Summary

Modifier and Type	Method and Description
Optional<EIdentityTokenFailure>	getCheckFailed()
String	getNewToken()
boolean	isCheckSkipped()
static IdentityTokenCheck	perform(IEntityContext ec, IFormRequestContext requestCtx) When enabled, an ID is generated based on the data of a submitted form.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCheckFailed

public Optional<EIdentityTokenFailure> getCheckFailed()

Returns:

Empty iff the identity token check succeeded. Otherwise, the type of error.

isCheckSkipped

public boolean isCheckSkipped()

Returns:

Whether the identity token check was skipped because of an empty identity token or identity token template.

getNewToken

public String getNewToken()

Returns:

The newly generated token. If the error is EIdentityTokenFailure.GENERATE_MAX_LENGTH_EXCEEDED, contains the invalid token. Blank for any other errors.

perform

public static IdentityTokenCheck perform(IEntityContext ec,
                                         IFormRequestContext requestCtx)

When enabled, an ID is generated based on the data of a submitted form. The form submission is rejected when a form record with the same identity token exists already. This creates the identity token for the current form and checks whether a form records exists already.

Parameters:

ec - Entity context for accessing the database.

ctx - Form request context for the new form data that was submitted.

Returns:

The result of the identity token check.