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.InputFieldTemplate<F,T>

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.InputFieldTemplate

descriptionShowType, persistentValue, valueProvider

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

defaultValues, 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> values, Locale locale)
Boolean	getCanEditIdentifier()
int	getMaxSendCount()
int	getMaxTryToResolveCount()
OtpGenerator<O>	getOtpGenerator()
protected abstract String	getResendAction()
Integer	getResendIntervalSeconds()
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)
void	setCanEditIdentifier(Boolean canEditIdentifier)
void	setMaxSendCount(int maxSendCount)
void	setResendIntervalSeconds(Integer resendIntervalSeconds)
String	toValue(String value)

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

getActionProcessors, preProcess, setActionProcessors

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

getDescriptionShowType, getValidationOrder, getValueProvider, isPersistentValue, setDescriptionShowType, setPersistentValue, setValueProvider, validate, validate

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

getDefaultValues, getEmptyField, getFieldClazz, getLog, getName, getShowExpression, mustShow, setDefaultValues, 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 InputFieldTemplate<F extends OtpField,String>

Throws:

Exception

fill

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

Overrides:

fill in class InputFieldTemplate<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 InputFieldTemplate<F extends OtpField,String>

getOtpGenerator

public OtpGenerator<O> getOtpGenerator()

getMaxTryToResolveCount

public int getMaxTryToResolveCount()

getMaxSendCount

public int getMaxSendCount()

setMaxSendCount

public void setMaxSendCount(int maxSendCount)

getResendIntervalSeconds

public Integer getResendIntervalSeconds()

setResendIntervalSeconds

public void setResendIntervalSeconds(Integer resendIntervalSeconds)

getCanEditIdentifier

public Boolean getCanEditIdentifier()

setCanEditIdentifier

public void setCanEditIdentifier(Boolean canEditIdentifier)