Package org.bardframework.flow.form.field.input.otp

Class OtpFieldTemplate<F extends OtpField,O>

java.lang.Object

org.bardframework.form.field.FieldTemplate<F>

org.bardframework.form.field.input.InputFieldTemplateAbstract<F,String>

org.bardframework.flow.form.field.input.FlowInputFieldTemplate<F,String>

org.bardframework.flow.form.field.input.otp.OtpFieldTemplate<F,O>

Direct Known Subclasses:

CaptchaFieldTemplate, EotpFieldTemplate, SotpFieldTemplate, TotpFieldTemplate

public abstract class OtpFieldTemplate<F extends OtpField,O>
extends FlowInputFieldTemplate<F,String>

Field Summary

Fields inherited from class org.bardframework.flow.form.field.input.FlowInputFieldTemplate

actionProcessors

Fields inherited from class org.bardframework.form.field.input.InputFieldTemplateAbstract

disableExpression, persistentValue, valueProvider

Fields inherited from class org.bardframework.form.field.FieldTemplate

defaultValue, fieldClazz, log, name, showExpression

Constructor Summary

Constructors

Constructor	Description
OtpFieldTemplate(String name, OtpGenerator<O> otpGenerator, int maxTryToResolveCount)

Method Summary

Modifier and Type	Method	Description
void	fill(FormTemplate formTemplate, F field, Map<String,String> args, Locale locale)
protected abstract String	getMaxSendCountErrorMessage()
protected abstract String	getOtpMaxTryToResolveCountErrorMessage()
protected abstract String	getResendAction()
final boolean	isValid(String flowToken, F field, String value, Map<String,String> flowData)
protected abstract boolean	isValidOtp(String flowToken, String otp, Map<String,String> flowData)
void	resend(String flowToken, Map<String,String> flowData, Locale locale, jakarta.servlet.http.HttpServletResponse httpResponse)
protected abstract void	send(String flowToken, Map<String,String> flowData, O otp, Locale locale, jakarta.servlet.http.HttpServletResponse httpResponse)
protected void	sendInternal(String flowToken, Map<String,String> flowData, Locale locale, jakarta.servlet.http.HttpServletResponse httpResponse)
String	toValue(String value)

Methods inherited from class org.bardframework.flow.form.field.input.FlowInputFieldTemplate

preProcess

Methods inherited from class org.bardframework.form.field.input.InputFieldTemplateAbstract

getDisableExpression, getValidationOrder, getValueProvider, isPersistentValue, setDisableExpression, setPersistentValue, setValueProvider, validate, validate

Methods inherited from class org.bardframework.form.field.FieldTemplate

getDefaultValue, getEmptyField, getFieldClazz, getLog, getName, getShowExpression, mustShow, setDefaultValue, setLog, setShowExpression, toField

Methods inherited from class java.lang.Object

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

Constructor Details

OtpFieldTemplate

public OtpFieldTemplate(String name,
 OtpGenerator<O> otpGenerator,
 int maxTryToResolveCount)

Method Details

getResendAction

protected abstract String getResendAction()

send

protected abstract void send(String flowToken,
 Map<String,String> flowData,
 O otp,
 Locale locale,
 jakarta.servlet.http.HttpServletResponse httpResponse)
                      throws Exception

Throws:

Exception

isValidOtp

protected abstract boolean isValidOtp(String flowToken,
 String otp,
 Map<String,String> flowData)
                               throws Exception

Throws:

Exception

isValid

public final boolean isValid(String flowToken,
 F field,
 String value,
 Map<String,String> flowData)
                      throws Exception

Specified by:

isValid in class InputFieldTemplateAbstract<F extends OtpField,String>

Throws:

Exception

fill

public void fill(FormTemplate formTemplate,
 F field,
 Map<String,String> args,
 Locale locale)
          throws Exception

Overrides:

fill in class InputFieldTemplateAbstract<F extends OtpField,String>

Throws:

Exception

sendInternal

protected void sendInternal(String flowToken,
 Map<String,String> flowData,
 Locale locale,
 jakarta.servlet.http.HttpServletResponse httpResponse)
                     throws Exception

Throws:

Exception

resend

public void resend(String flowToken,
 Map<String,String> flowData,
 Locale locale,
 jakarta.servlet.http.HttpServletResponse httpResponse)
            throws Exception

Throws:

Exception

toValue

public String toValue(String value)

Specified by:

toValue in class InputFieldTemplateAbstract<F extends OtpField,String>

getOtpMaxTryToResolveCountErrorMessage

protected abstract String getOtpMaxTryToResolveCountErrorMessage()

getMaxSendCountErrorMessage

protected abstract String getMaxSendCountErrorMessage()