Index (formflow-library 0.0.14 API)

A C D E F G H I K L M N O P R S T U V Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

acceptedFileTypes() - Method in class formflow.library.file.FileValidationService: Provides the list of acceptable file types the system accepts in a string form, like so: ".bmp,.jpg"
Action - Interface in formflow.library.config.submission: An interface to define a particular Action.
ActionManager - Class in formflow.library.config: Manages methods for handling actions.
ActionManager(List<Action>) - Constructor for class formflow.library.config.ActionManager: Class Constructor generating a hashmap of action names and their corresponding action objects.
addInterceptors(InterceptorRegistry) - Method in class formflow.library.config.SessionContinuityInterceptorConfiguration
AddressParts - Enum Class in formflow.library.inputs: Fields used to define an address fragment
AddressValidationService - Class in formflow.library.address_validation
AddressValidationService(ValidationRequestFactory, ClientFactory, String, String, String, boolean) - Constructor for class formflow.library.address_validation.AddressValidationService
addUserFileToMap(String, String, UserFile, String) - Method in class formflow.library.utils.UserFileMap
arrayOrStringContains(Object, String) - Static method in class formflow.library.utils.InputUtils: Static function to help determine if a String or ArrayList contains the target value.

C

cfaUswdsTemplateResolver() - Method in class formflow.library.config.ThymeleafConfiguration: Creates a new ClassLoaderTemplateResolver to be able to resolve templates in the cfa-uswds-templates/ directory.
CheckboxField - Class in formflow.library.pdf
CheckboxField(String, List<String>, Integer) - Constructor for class formflow.library.pdf.CheckboxField
CITY - Enum constant in enum class formflow.library.inputs.AddressParts: City name
ClammitVirusScanner - Class in formflow.library.file: Clammit Virus Scanner An implementation of the FileVirusScanner interface that will use the Clammit Virus Scanner Server to check files for viruses.
ClammitVirusScanner(String, int) - Constructor for class formflow.library.file.ClammitVirusScanner
clearAddressFields(String) - Method in class formflow.library.data.Submission: Removes the data in the inputData pertaining to the inputName of the address passed in.
ClientFactory - Class in formflow.library.address_validation
ClientFactory() - Constructor for class formflow.library.address_validation.ClientFactory
CloudFile - Class in formflow.library.file
CloudFile() - Constructor for class formflow.library.file.CloudFile
CloudFileRepository - Interface in formflow.library.file
Condition - Interface in formflow.library.config.submission: An interface that defines a function to run a Condition
conditionExists(String) - Method in class formflow.library.config.ConditionManager
ConditionManager - Class in formflow.library.config
ConditionManager(List<Condition>) - Constructor for class formflow.library.config.ConditionManager
copySubmission(Submission) - Static method in class formflow.library.data.Submission: Create a deep copy of the given submission.
copyToTempFile(String) - Static method in record class formflow.library.pdf.PdfFile: This static function will take in a path to a template file and create a PdfFile object to return to the caller.
countBySubmission(Submission) - Method in interface formflow.library.data.UserFileRepository
countBySubmission(Submission) - Method in class formflow.library.data.UserFileRepositoryService
create(FormSubmission) - Method in class formflow.library.address_validation.ValidationRequestFactory
create(String, String, String) - Method in class formflow.library.address_validation.ClientFactory
createFileInfo(UserFile, String) - Static method in class formflow.library.data.UserFile: Creates a HashMap representation of an uploaded user file that holds information about the file (original file name, file size, thumbnail and mime type) which we add to the session for persisting user file uploads when a user refreshes the page or navigates away.
CSRF - Static variable in enum class formflow.library.inputs.UnvalidatedField

D

DatabaseField - Class in formflow.library.pdf
DatabaseField(String, String) - Constructor for class formflow.library.pdf.DatabaseField
DatabaseFieldPreparer - Class in formflow.library.pdf
DatabaseFieldPreparer() - Constructor for class formflow.library.pdf.DatabaseFieldPreparer
decrypt(Submission) - Method in class formflow.library.data.SubmissionEncryptionService: Goes through "@Encrypted" annotations and replaces the encrypted fields with the decrypted value.
DefaultSubmissionFieldPreparer - Interface in formflow.library.pdf
delete(String) - Method in interface formflow.library.file.CloudFileRepository
delete(String) - Method in class formflow.library.file.NoOpCloudFileRepository
delete(String) - Method in class formflow.library.file.S3CloudFileRepository
delete(UUID, String, String, String, HttpSession, HttpServletRequest) - Method in class formflow.library.FileController
deleteById(UUID) - Method in class formflow.library.data.UserFileRepositoryService: Removes a particular UserFile based on passed in id
deleteFile() - Method in record class formflow.library.pdf.PdfFile: Deletes the underlying temporary file from the file system.
DevController - Class in formflow.library
DevController() - Constructor for class formflow.library.DevController
doesFlowExist(String) - Method in class formflow.library.FormFlowController
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class formflow.library.filters.MDCInsertionFilter
downloadAllFiles(String, String, HttpSession, HttpServletRequest) - Method in class formflow.library.FileController
downloadSingleFile(String, String, String, HttpSession, HttpServletRequest) - Method in class formflow.library.FileController

E

EMAIL_REGEX - Static variable in class formflow.library.utils.RegexUtils
EmailClient<T> - Interface in formflow.library.email: An interface that can be implemented by objects to send email.
encrypt(Submission) - Method in class formflow.library.data.SubmissionEncryptionService: Go through "@Encrypt" annotations and replace fields with encrypted value.
ENCRYPT_SUFFIX - Variable in class formflow.library.data.SubmissionEncryptionService: Suffix added to the field name for encrypted fields
Encrypted - Annotation Interface in formflow.library.inputs
equals(Object) - Method in class formflow.library.data.Submission
equals(Object) - Method in class formflow.library.data.UserFile
equals(Object) - Method in record class formflow.library.pdf.PdfField: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class formflow.library.pdf.PdfFile: Indicates whether some other object is "equal to" this one.

F

fileBytes() - Method in record class formflow.library.pdf.PdfFile: Returns a byte array containing all the contents of the PDF file.
FileController - Class in formflow.library
FileController(UserFileRepositoryService, CloudFileRepository, FileVirusScanner, SubmissionRepositoryService, List<FlowConfiguration>, MessageSource, FileValidationService, Integer, boolean) - Constructor for class formflow.library.FileController
FileValidationService - Class in formflow.library.file: This service is intended to help with miscellaneous file things.
FileValidationService(String, Integer) - Constructor for class formflow.library.file.FileValidationService
FileVirusScanner - Interface in formflow.library.file: Interface that defines the abilities any File Virus Scanner should implement to work in this setup
fill(String, Collection<PdfField>) - Method in class formflow.library.pdf.PDFBoxFieldFiller
finalizeForSending() - Method in record class formflow.library.pdf.PdfFile: Does all the tasks necessary to finalize the PDF file.
findAllBySubmission(Submission) - Method in interface formflow.library.data.UserFileRepository
findAllBySubmission(Submission) - Method in class formflow.library.data.UserFileRepositoryService
findById(UUID) - Method in class formflow.library.data.SubmissionRepositoryService: Searches for a particular Submission by its id
findById(UUID) - Method in class formflow.library.data.UserFileRepositoryService: Searches for a particular UserFile by its id
findOrCreateSubmission(HttpSession, String) - Method in class formflow.library.FormFlowController: If the submission information exists in the HttpSession, find it in the db.
FLOW_PATH_FORMAT - Static variable in class formflow.library.interceptors.SessionContinuityInterceptor
FlowConfiguration - Class in formflow.library.config: Represents the configuration for a certain flow.
FlowConfiguration() - Constructor for class formflow.library.config.FlowConfiguration
flowConfigurations - Variable in class formflow.library.FormFlowController
FlowInputs - Class in formflow.library.data
FlowInputs() - Constructor for class formflow.library.data.FlowInputs
flowsConfiguration() - Method in class formflow.library.config.FlowsConfigurationFactoryConfig: Bean to get a list of FlowConfiguration objects.
flowsConfigurationFactory() - Method in class formflow.library.config.FlowsConfigurationFactoryConfig: Bean to get a FlowsConfigurationFactory object.
FlowsConfigurationFactory - Class in formflow.library.config: Parses the flow configuration yaml file and setups the FlowConfiguration list.
FlowsConfigurationFactory() - Constructor for class formflow.library.config.FlowsConfigurationFactory
FlowsConfigurationFactoryConfig - Class in formflow.library.config: Factory for FlowsConfiguration configuration.
FlowsConfigurationFactoryConfig() - Constructor for class formflow.library.config.FlowsConfigurationFactoryConfig
formData - Variable in class formflow.library.data.FormSubmission
formflow.library - package formflow.library
formflow.library.address_validation - package formflow.library.address_validation
formflow.library.config - package formflow.library.config
formflow.library.config.submission - package formflow.library.config.submission
formflow.library.data - package formflow.library.data
formflow.library.data.validators - package formflow.library.data.validators
formflow.library.email - package formflow.library.email
formflow.library.exceptions - package formflow.library.exceptions
formflow.library.file - package formflow.library.file
formflow.library.filters - package formflow.library.filters
formflow.library.inputs - package formflow.library.inputs
formflow.library.interceptors - package formflow.library.interceptors
formflow.library.pdf - package formflow.library.pdf
formflow.library.utils - package formflow.library.utils
FormFlowController - Class in formflow.library
FormFlowErrorController - Class in formflow.library
FormFlowErrorController(boolean, String, String, ErrorAttributes) - Constructor for class formflow.library.FormFlowErrorController
FormSubmission - Class in formflow.library.data
FormSubmission(Map<String, Object>) - Constructor for class formflow.library.data.FormSubmission
FormSubmission(MultiValueMap<String, String>) - Constructor for class formflow.library.data.FormSubmission

G

generate(String, Submission) - Method in class formflow.library.pdf.PdfGenerator: Generates a PdfFile based on Submission data and a certain Form Flow
generatePdfName(Submission) - Method in class formflow.library.pdf.PdfService: Generates a generic pdf file name from the flow and submission id that are part of the Submission.
get(String) - Method in interface formflow.library.file.CloudFileRepository
get(String) - Method in class formflow.library.file.NoOpCloudFileRepository
get(String) - Method in class formflow.library.file.S3CloudFileRepository
getAcceptableFileExts() - Method in class formflow.library.file.FileValidationService: Returns the list of file extensions the system accepts: ".bmp, .doc"
getAction(String) - Method in class formflow.library.config.ActionManager: Get an action by name, usually to run the action.
getAddressValidationFields() - Method in class formflow.library.data.FormSubmission: Returns the list of keys that are for addresses that are requested to be validated
getAllSubflowFields() - Method in class formflow.library.pdf.PdfMap: Fetches and returns all the fields for all the subflows, expanding out the fields based on the number of max iterations the PdfMap indicates are necessary.
getCondition(String) - Method in class formflow.library.config.ConditionManager
getFieldsForIterations() - Method in class formflow.library.pdf.PdfMapSubflow: Returns all the inputFields associated with a subflow's iterations, expanded out, up to the totalIterations number defined in the PdfMap yaml file.
getFilledOutPDF(Submission) - Method in class formflow.library.pdf.PdfService: Uses pdfGenerator to generate a pdf for a flow using a UUID.
getFlowConfigurationByName(String) - Method in class formflow.library.FormFlowController
getMaxFileSizeInMb() - Method in class formflow.library.file.FileValidationService
getName() - Method in class formflow.library.pdf.SubmissionField: Returns the name of the field.
getObject() - Method in class formflow.library.config.FlowsConfigurationFactory
getObject() - Method in class formflow.library.config.PdfMapFactory
getObjectType() - Method in class formflow.library.config.FlowsConfigurationFactory
getObjectType() - Method in class formflow.library.config.PdfMapFactory
getOrder() - Method in class formflow.library.interceptors.SessionContinuityInterceptor: Sets the value of the interceptor to the highest integer value making it the last interceptor executed.
getPdfMap(String) - Method in class formflow.library.pdf.PdfMapConfiguration: Based on a specific form flow, get the PdfMap associated with that flow.
getPdfPathFromFlow(String) - Method in class formflow.library.pdf.PdfMapConfiguration: Based on a specific form flow, get the PDF file path (and name) associated with that flow.
getScreenNavigation(String) - Method in class formflow.library.config.FlowConfiguration: Returns the screen navigation for a particular screen.
getSubflowEntryByUuid(String, String) - Method in class formflow.library.data.Submission: Provides access to a specific subflow's submission data for a particular UUID, if the subflow is present in the submission.
getSubmissionFromSession(HttpSession, String) - Method in class formflow.library.FormFlowController: This method will return a Submission that was referenced the HttpSession for a particular flow, if one exists.
getSubmissionIdForFlow(HttpSession, String) - Static method in class formflow.library.FormFlowController: Returns the UUID of the Submission associated with the given flow.
getValidatableFields() - Method in class formflow.library.data.FormSubmission
groups() - Element in annotation interface formflow.library.data.validators.Money
groups() - Element in annotation interface formflow.library.data.validators.Phone

H

handleAfterSaveAction(ScreenNavigationConfiguration, Submission) - Method in class formflow.library.config.ActionManager: handleAfterSaveAction() invokes a method after a submission has been saved in the ScreenController.
handleAfterSaveAction(ScreenNavigationConfiguration, Submission, String) - Method in class formflow.library.config.ActionManager: This handleAfterSaveAction() invokes a method after a subflow submission has been saved.
handleBeforeDisplayAction(ScreenNavigationConfiguration, Submission) - Method in class formflow.library.config.ActionManager: handleBeforeDisplayAction() invokes a method in the ScreenController.
handleBeforeDisplayAction(ScreenNavigationConfiguration, Submission, String) - Method in class formflow.library.config.ActionManager: handleBeforeDisplayAction() invokes a method in the ScreenController.
handleBeforeSaveAction(ScreenNavigationConfiguration, Submission) - Method in class formflow.library.config.ActionManager: handleBeforeSaveAction() invokes a method in the ScreenController.
handleBeforeSaveAction(ScreenNavigationConfiguration, Submission, String) - Method in class formflow.library.config.ActionManager: handleBeforeSaveAction() invokes a method in the ScreenController.
handleCrossFieldValidationAction(ScreenNavigationConfiguration, FormSubmission, Submission) - Method in class formflow.library.config.ActionManager: handleCrossFieldValidationAction() invokes a method in the ScreenController.
handleError(WebRequest) - Method in class formflow.library.FormFlowErrorController
handleOnPostAction(ScreenNavigationConfiguration, FormSubmission, Submission) - Method in class formflow.library.config.ActionManager: handleOnPostAction() invokes a method in the ScreenController.
handleOnPostAction(ScreenNavigationConfiguration, FormSubmission, Submission, String) - Method in class formflow.library.config.ActionManager: handleOnPostAction() invokes a method in the ScreenController.
hashCode() - Method in class formflow.library.data.Submission
hashCode() - Method in class formflow.library.data.UserFile
hashCode() - Method in record class formflow.library.pdf.PdfField: Returns a hash code value for this object.
hashCode() - Method in record class formflow.library.pdf.PdfFile: Returns a hash code value for this object.

I

InputUtils - Class in formflow.library.utils: Utility class to help with parsing input from forms
InputUtils() - Constructor for class formflow.library.utils.InputUtils
isAcceptedMimeType(MultipartFile) - Method in class formflow.library.file.FileValidationService: Returns True if the file is of the appropriate mime type for the system setup.
isSingleton() - Method in class formflow.library.config.FlowsConfigurationFactory
isSingleton() - Method in class formflow.library.config.PdfMapFactory
isTooLarge(MultipartFile) - Method in class formflow.library.file.FileValidationService
isValid(String, ConstraintValidatorContext) - Method in class formflow.library.data.validators.MoneyValidator
isValid(String, ConstraintValidatorContext) - Method in class formflow.library.data.validators.PhoneValidator
iteration - Variable in class formflow.library.pdf.SubmissionField

K

key() - Element in annotation interface formflow.library.inputs.Encrypted

L

LandmarkConfiguration - Class in formflow.library.config: Class which contains configuration for the landmark screen(s) in a flow.
LandmarkConfiguration() - Constructor for class formflow.library.config.LandmarkConfiguration
LandmarkNotSetException - Exception in formflow.library.exceptions
LandmarkNotSetException(String) - Constructor for exception formflow.library.exceptions.LandmarkNotSetException

M

MailgunEmailClient - Class in formflow.library.email: This implementation of EmailClient sends email through Mailgun.
MailgunEmailClient(String, String, String) - Constructor for class formflow.library.email.MailgunEmailClient: Constructor for the MailgunEmailClient class.
map(List<SubmissionField>, String) - Method in class formflow.library.pdf.PdfFieldMapper: Maps SubmissionFields to PdfFields, taking into account if they are a SingleField or a CheckboxField type of SubmissionField.
MB_IN_BYTES - Static variable in class formflow.library.file.FileValidationService
MDCInsertionFilter - Class in formflow.library.filters: Inserts useful attributes into the Mapped Diagnostic Context (MDC) for logging by clients.
MDCInsertionFilter() - Constructor for class formflow.library.filters.MDCInsertionFilter
mergeFormDataWithSubflowIterationData(String, Map<String, Object>, Map<String, Object>) - Method in class formflow.library.data.Submission: Merges the passed in subflow's iteration data into the Submission's subflow's data for that iteration.
mergeFormDataWithSubmissionData(FormSubmission) - Method in class formflow.library.data.Submission: Merges the passed in data into the data stored in the Submission.
mergeUrlParamsWithData(Map<String, String>) - Method in class formflow.library.data.Submission: Merges the passed in query parameters into the Submission's urlParams Map
message() - Element in annotation interface formflow.library.data.validators.Money
message() - Element in annotation interface formflow.library.data.validators.Phone
Money - Annotation Interface in formflow.library.data.validators
MoneyValidator - Class in formflow.library.data.validators: This class validates that Money has been passed in the correct format - one or more digits, a dot and 2 digits after the dot.
MoneyValidator() - Constructor for class formflow.library.data.validators.MoneyValidator

N

name - Variable in class formflow.library.pdf.SubmissionField
name() - Method in record class formflow.library.pdf.PdfField: Returns the value of the name record component.
name() - Method in record class formflow.library.pdf.PdfFile: Returns the value of the name record component.
NAVIGATION_FLOW_PATH_FORMAT - Static variable in class formflow.library.interceptors.SessionContinuityInterceptor
NextScreen - Class in formflow.library.config: NextScreen represents what the next screen in a flow is and any conditions that need to be tested before one can go to that screen.
NextScreen() - Constructor for class formflow.library.config.NextScreen
NoOpCloudFileRepository - Class in formflow.library.file: This implementation of CloudFileRepository does nothing useful at all.
NoOpCloudFileRepository() - Constructor for class formflow.library.file.NoOpCloudFileRepository
NoOpVirusScanner - Class in formflow.library.file: This implementation of FileVirusScanner does nothing useful at all.
NoOpVirusScanner() - Constructor for class formflow.library.file.NoOpVirusScanner

O

OneToManyPreparer - Class in formflow.library.pdf
OneToManyPreparer() - Constructor for class formflow.library.pdf.OneToManyPreparer
OneToOnePreparer - Class in formflow.library.pdf
OneToOnePreparer() - Constructor for class formflow.library.pdf.OneToOnePreparer

P

path() - Method in record class formflow.library.pdf.PdfFile: Returns the value of the path record component.
payload() - Element in annotation interface formflow.library.data.validators.Money
payload() - Element in annotation interface formflow.library.data.validators.Phone
PDFBoxFieldFiller - Class in formflow.library.pdf
PDFBoxFieldFiller() - Constructor for class formflow.library.pdf.PDFBoxFieldFiller
PdfController - Class in formflow.library
PdfController(MessageSource, PdfService, SubmissionRepositoryService, UserFileRepositoryService, List<FlowConfiguration>) - Constructor for class formflow.library.PdfController
PdfField - Record Class in formflow.library.pdf
PdfField(String, String) - Constructor for record class formflow.library.pdf.PdfField: Creates an instance of a PdfField record class.
PdfFieldMapper - Class in formflow.library.pdf
PdfFieldMapper(List<PdfMap>) - Constructor for class formflow.library.pdf.PdfFieldMapper
PdfFile - Record Class in formflow.library.pdf
PdfFile(String, String) - Constructor for record class formflow.library.pdf.PdfFile: Creates an instance of a PdfFile record class.
PdfGenerator - Class in formflow.library.pdf
PdfGenerator(SubmissionFieldPreparers, PdfFieldMapper, PdfMapConfiguration, PDFBoxFieldFiller) - Constructor for class formflow.library.pdf.PdfGenerator
PdfMap - Class in formflow.library.pdf
PdfMap() - Constructor for class formflow.library.pdf.PdfMap
PdfMapConfiguration - Class in formflow.library.pdf
PdfMapConfiguration(List<PdfMap>) - Constructor for class formflow.library.pdf.PdfMapConfiguration
pdfMapFactory() - Method in class formflow.library.config.PdfMapFactoryConfig
PdfMapFactory - Class in formflow.library.config: Parses the pdf map yaml file and creates corresponding PdfFieldMap Beans.
PdfMapFactory() - Constructor for class formflow.library.config.PdfMapFactory
PdfMapFactoryConfig - Class in formflow.library.config: Factory for PdfMapConfiguration configuration.
PdfMapFactoryConfig() - Constructor for class formflow.library.config.PdfMapFactoryConfig
pdfMaps() - Method in class formflow.library.config.PdfMapFactoryConfig: Bean to get a list of FlowConfiguration objects.
PdfMapSubflow - Class in formflow.library.pdf
PdfMapSubflow() - Constructor for class formflow.library.pdf.PdfMapSubflow
PdfService - Class in formflow.library.pdf
PdfService(PdfGenerator) - Constructor for class formflow.library.pdf.PdfService: PdfService is a service that generates a byte[] of a flattened pdf.
Phone - Annotation Interface in formflow.library.data.validators
PhoneValidator - Class in formflow.library.data.validators
PhoneValidator() - Constructor for class formflow.library.data.validators.PhoneValidator
preHandle(HttpServletRequest, HttpServletResponse, Object) - Method in class formflow.library.interceptors.SessionContinuityInterceptor
prepareSubmissionFields(Submission) - Method in class formflow.library.pdf.SubmissionFieldPreparers: This method creates a list of SubmissionField objects which will be used to create the PdfField objects that will eventually populate a given PDF.
prepareSubmissionFields(Submission, PdfMap) - Method in class formflow.library.pdf.DatabaseFieldPreparer
prepareSubmissionFields(Submission, PdfMap) - Method in interface formflow.library.pdf.DefaultSubmissionFieldPreparer
prepareSubmissionFields(Submission, PdfMap) - Method in class formflow.library.pdf.OneToManyPreparer
prepareSubmissionFields(Submission, PdfMap) - Method in class formflow.library.pdf.OneToOnePreparer
prepareSubmissionFields(Submission, PdfMap) - Method in class formflow.library.pdf.SubflowFieldPreparer: This will prepare the SubmissionFields for all the data across all the subflows specified in the PdfMap.
prepareSubmissionFields(Submission, PdfMap) - Method in interface formflow.library.pdf.SubmissionFieldPreparer

R

RegexUtils - Class in formflow.library.utils
RegexUtils() - Constructor for class formflow.library.utils.RegexUtils
removeFlowCSRF(Submission) - Method in class formflow.library.data.SubmissionRepositoryService: Removes the CSRF from the Submission's input data, if found.
removeIncompleteIterations(String, String) - Method in class formflow.library.data.Submission: Removes any data in an interation that has "iterationIsComplete" set to "false" and has a uuid not equal to the currentUuid provided.
removeSubflowCSRF(Submission, String) - Method in class formflow.library.data.SubmissionRepositoryService: Removes the CSRF from a particular Submission's Subflow's iteration data, if found.
removeUserFileFromMap(String, UUID) - Method in class formflow.library.utils.UserFileMap
requireTls - Static variable in interface formflow.library.email.EmailClient: A boolean variable required for any EmailClient
run(FormSubmission, Submission) - Method in interface formflow.library.config.submission.Action: Runs an action on form submission and submission data to potentially manipulate the data.
run(FormSubmission, Submission, String) - Method in interface formflow.library.config.submission.Action: Runs an action on form submission and submission data to potentially manipulate the data.
run(Submission) - Method in interface formflow.library.config.submission.Action: Runs an action on a submission to potentially manipulate the data.
run(Submission) - Method in interface formflow.library.config.submission.Condition: Runs a condition check on a submission.
run(Submission, String) - Method in interface formflow.library.config.submission.Action: Runs an action on a submission to potentially manipulate the data.
run(Submission, String) - Method in interface formflow.library.config.submission.Condition: Runs a condition check on a submission's subflow iteration.
runCondition(String, Submission) - Method in class formflow.library.config.ConditionManager
runCondition(String, Submission, String) - Method in class formflow.library.config.ConditionManager
runValidation(FormSubmission) - Method in interface formflow.library.config.submission.Action: Deprecated.
use `runValidation(final FormSubmission formSubmission, Submission submission)` instead.
runValidation(FormSubmission, Submission) - Method in interface formflow.library.config.submission.Action: Runs validation code with the expectation that error messages may be returned.

S

S3CloudFileRepository - Class in formflow.library.file: This is an implementation of the CloudFileRepository that uses Amazon S3
S3CloudFileRepository(String, String, String, String) - Constructor for class formflow.library.file.S3CloudFileRepository
save(Submission) - Method in class formflow.library.data.SubmissionRepositoryService: Saves the Submission in the database.
save(UserFile) - Method in class formflow.library.data.UserFileRepositoryService: Saves the UploadedFile in the database.
saveToRepository(Submission) - Method in class formflow.library.FormFlowController
saveToRepository(Submission, String) - Method in class formflow.library.FormFlowController
ScreenController - Class in formflow.library: A controller to render any screen in flows, including subflows.
ScreenController(List<FlowConfiguration>, UserFileRepositoryService, SubmissionRepositoryService, ValidationService, AddressValidationService, ConditionManager, ActionManager, FileValidationService) - Constructor for class formflow.library.ScreenController
ScreenNavigationConfiguration - Class in formflow.library.config: Screen navigation configuration class used to store navigation information about a specific screen.
ScreenNavigationConfiguration() - Constructor for class formflow.library.config.ScreenNavigationConfiguration
sendEmail(String, String, String) - Method in interface formflow.library.email.EmailClient: This sends an email with the least amount of information needed to be provided.
sendEmail(String, String, String) - Method in class formflow.library.email.MailgunEmailClient: This sends an email with the least amount of information needed to be provided.
sendEmail(String, String, String, List<File>) - Method in interface formflow.library.email.EmailClient: This sends an email with the least amount of information needed to be provided, but with attachments.
sendEmail(String, String, String, List<File>) - Method in class formflow.library.email.MailgunEmailClient: This sends an email with the least amount of information needed to be provided, but with attachments.
sendEmail(String, String, List<String>, List<String>, String, List<File>) - Method in interface formflow.library.email.EmailClient: This sends an email with the most customizations.
sendEmail(String, String, List<String>, List<String>, String, List<File>) - Method in class formflow.library.email.MailgunEmailClient: The main method that sends to Mailgun.
SessionContinuityInterceptor - Class in formflow.library.interceptors: This interceptor prevents users from jumping to random pages in a flow.
SessionContinuityInterceptor(List<FlowConfiguration>) - Constructor for class formflow.library.interceptors.SessionContinuityInterceptor
SessionContinuityInterceptorConfiguration - Class in formflow.library.config: Adds SessionContinuityInterceptor to the Interceptor registry.
SessionContinuityInterceptorConfiguration() - Constructor for class formflow.library.config.SessionContinuityInterceptorConfiguration
setActionManager(ActionManager) - Method in class formflow.library.pdf.SubflowFieldPreparer: Set the ActionManager explicitly.
setDbFields(Map<String, Object>) - Method in class formflow.library.pdf.PdfMap
setInputFields(Map<String, Object>) - Method in class formflow.library.pdf.PdfMap
setMailgunMessagesApi(MailgunMessagesApi) - Method in class formflow.library.email.MailgunEmailClient: This setter allows us to replace mailgunMessageApi with a mock for testing.
setRequireTls(Boolean) - Method in interface formflow.library.email.EmailClient: Requires any EmailClient to include the setRequireTls method.
setRequireTls(Boolean) - Method in class formflow.library.email.MailgunEmailClient: This setter allows to change requireTls from its default setting of true
setSenderEmail(String) - Method in class formflow.library.email.MailgunEmailClient: This setter allows you to change the senderEmail.
setSubflowInfo(Map<String, PdfMapSubflow>) - Method in class formflow.library.pdf.PdfMap
setSubmissionInSession(HttpSession, Submission, String) - Method in class formflow.library.FormFlowController
setValidatedAddress(Map<String, ValidatedAddress>) - Method in class formflow.library.data.FormSubmission
SingleField - Class in formflow.library.pdf
SingleField(String, String, Integer) - Constructor for class formflow.library.pdf.SingleField
STATE - Enum constant in enum class formflow.library.inputs.AddressParts: The State value stored as the state code, a two character String, for example, "IL", "CA", etc.
STREET_ADDRESS_1 - Enum constant in enum class formflow.library.inputs.AddressParts: Street component of an address
STREET_ADDRESS_2 - Enum constant in enum class formflow.library.inputs.AddressParts: Apartment, suite, or office number
SubflowConfiguration - Class in formflow.library.config: Class which contains configuration for a sub flow.
SubflowConfiguration() - Constructor for class formflow.library.config.SubflowConfiguration
SubflowFieldPreparer - Class in formflow.library.pdf: This preparer takes the Submission and the subflow map from a given `pdf-map.yaml` file and iterates over each subflow in the given subflow map to create an expanded map of data that can be used to populate the subflow related PDF fields.
SubflowFieldPreparer() - Constructor for class formflow.library.pdf.SubflowFieldPreparer
Submission - Class in formflow.library.data: A class representing what a submission of the form flow looks like in the database.
Submission() - Constructor for class formflow.library.data.Submission: Creates a new Submission with empty content
SUBMISSION_MAP_NAME - Static variable in class formflow.library.FormFlowController
SubmissionEncryptionService - Class in formflow.library.data: Service providing encryption and decryption of designated fields in a Submission using Google's Tink Cryptographic Library
SubmissionEncryptionService(String, String) - Constructor for class formflow.library.data.SubmissionEncryptionService: Constructs an instance of the SubmissionEncryptionService
SubmissionField - Class in formflow.library.pdf
SubmissionField() - Constructor for class formflow.library.pdf.SubmissionField
SubmissionFieldPreparer - Interface in formflow.library.pdf
SubmissionFieldPreparers - Class in formflow.library.pdf
SubmissionFieldPreparers(List<DefaultSubmissionFieldPreparer>, List<SubmissionFieldPreparer>, PdfMapConfiguration) - Constructor for class formflow.library.pdf.SubmissionFieldPreparers
SubmissionRepository - Interface in formflow.library.data: Repository interface for the SubmissionRepository.
submissionRepositoryService - Variable in class formflow.library.FormFlowController
SubmissionRepositoryService - Class in formflow.library.data: Service to retrieve and store Submission objects in the database.
SubmissionRepositoryService(SubmissionRepository, SubmissionEncryptionService) - Constructor for class formflow.library.data.SubmissionRepositoryService

T

throwNotFoundError(String, String, String) - Static method in class formflow.library.FormFlowController
ThymeleafConfiguration - Class in formflow.library.config: Provides configuration for the Thymeleaf templates, besides the default.
ThymeleafConfiguration() - Constructor for class formflow.library.config.ThymeleafConfiguration
toString() - Method in enum class formflow.library.inputs.AddressParts
toString() - Method in record class formflow.library.pdf.PdfField: Returns a string representation of this record class.
toString() - Method in record class formflow.library.pdf.PdfFile: Returns a string representation of this record class.

U

UnvalidatedField - Enum Class in formflow.library.inputs
upload(String, MultipartFile) - Method in interface formflow.library.file.CloudFileRepository
upload(String, MultipartFile) - Method in class formflow.library.file.NoOpCloudFileRepository
upload(String, MultipartFile) - Method in class formflow.library.file.S3CloudFileRepository: Takes a filepath and Multipart file to upload the multipart file to AWS S3 where the filepath acts as the path to the file in S3.
upload(MultipartFile, String, String, String, HttpSession, HttpServletRequest, Locale) - Method in class formflow.library.FileController: File upload endpoint.
UserFile - Class in formflow.library.data: A class representing what an uploaded file which can be saved in either S3 or Azure
UserFile() - Constructor for class formflow.library.data.UserFile
UserFileMap - Class in formflow.library.utils: A class to contain the file mapping for the client side rendering of DropZone files.
UserFileMap() - Constructor for class formflow.library.utils.UserFileMap
UserFileRepository - Interface in formflow.library.data: Repository interface for UserFile objects
userFileRepositoryService - Variable in class formflow.library.FormFlowController
UserFileRepositoryService - Class in formflow.library.data: Service to retrieve and store UploadedFile objects in the database.
UserFileRepositoryService(UserFileRepository) - Constructor for class formflow.library.data.UserFileRepositoryService

V

validate(ScreenNavigationConfiguration, String, FormSubmission, Submission) - Method in class formflow.library.ValidationService: Validates client inputs with java bean validation based on input definition.
validate(FormSubmission) - Method in class formflow.library.address_validation.AddressValidationService
VALIDATE_ADDRESS - Static variable in enum class formflow.library.inputs.UnvalidatedField
VALIDATED - Static variable in enum class formflow.library.inputs.UnvalidatedField
ValidatedAddress - Class in formflow.library.address_validation
ValidatedAddress() - Constructor for class formflow.library.address_validation.ValidatedAddress
ValidationRequestFactory - Class in formflow.library.address_validation
ValidationRequestFactory() - Constructor for class formflow.library.address_validation.ValidationRequestFactory
ValidationService - Class in formflow.library: A service that validates flow inputs based on input definition.
ValidationService(Validator, ActionManager, String) - Constructor for class formflow.library.ValidationService: Autoconfigured constructor.
value() - Method in record class formflow.library.pdf.PdfField: Returns the value of the value record component.
valueOf(String) - Static method in enum class formflow.library.inputs.AddressParts: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class formflow.library.inputs.UnvalidatedField: Returns the enum constant of this class with the specified name.
values() - Static method in enum class formflow.library.inputs.AddressParts: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class formflow.library.inputs.UnvalidatedField: Returns an array containing the constants of this enum class, in the order they are declared.
virusDetected(MultipartFile) - Method in class formflow.library.file.ClammitVirusScanner
virusDetected(MultipartFile) - Method in interface formflow.library.file.FileVirusScanner: This method will send the passed in `file` to a virus scanner service defined in the implementation and return a boolean value indicating if the file contains a virus.
virusDetected(MultipartFile) - Method in class formflow.library.file.NoOpVirusScanner

Z

ZIPCODE - Enum constant in enum class formflow.library.inputs.AddressParts: Five or nine digit value used by the post office to facilitate the delivery of mail.

A C D E F G H I K L M N O P R S T U V Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form