Package name.matthewgreet.strutscommons.util

Class DefaultAnnotationValidator.InterceptorContext

java.lang.Object

name.matthewgreet.strutscommons.util.DefaultAnnotationValidator.InterceptorContext

Enclosing class:

DefaultAnnotationValidator

public static class DefaultAnnotationValidator.InterceptorContext
extends Object

Thread local execution state of algorithm. Use getInstance() to obtain the current state. Properties are set as the algorithm progresses and these are divided into sets, shown below. Documentation of each library function defines the sets in use as well as its purpose.

Property set 1

• step

Property set 2

• invocation
• action
• form
• modelDriven
• textProvider
• validationAware
• validationAware2
• validationLogger

Property set 3

• fieldParsedParameterListTable

Property set 4

• autoParameterConversionFields
• defaultParameterConversionFields
• manualParameterConversionFields
• noConversionFields
• pairConversionFields
• setOnlyFields
• successfulFields
• failedFields
• successfulPairFields
• failedPairFields

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DefaultAnnotationValidator.InterceptorContext.InterceptorStep	Describes processing step.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InterceptorContext()

Method Summary

Modifier and Type	Method	Description
Object	getAction()	Returns current Action.
List<InterceptorCommonLibrary.FieldUsage<?>>	getAutoParameterConversionFields()	Returns info of fields where converted request parameters are directly set according to a converter annotation.
List<InterceptorCommonLibrary.FieldUsage<?>>	getAutoParameterListConversionFields()	Returns info of fields where a converted request parameter is directly set according to a list converter annotation.
List<InterceptorCommonLibrary.FieldUsage<?>>	getDefaultParameterConversionFields()	Returns info of fields where a converted request parameters are directly set according to the default converter for the data type.
List<InterceptorCommonLibrary.FieldUsage<?>>	getFailedFields()	Returns info list of non-pair fields processing failed.
List<InterceptorCommonLibrary.PairFieldUsage<?>>	getFailedPairFields()	Returns info list of pair fields processing failed.
Map<String,FieldParsedParameterList>	getFieldParsedParameterListTable()	Returns table of parameters parsed into field name and index, lookup by field name.
List<InterceptorCommonLibrary.FieldUsage<?>>	getFileFields()	Returns info of fields that receive file parameters created by the FileUploadInterceptor.
Object	getForm()	Returns whatever's the Action's form, whether it's the Action itself, or the model for a ModelDriven Action.
static DefaultAnnotationValidator.InterceptorContext	getInstance()	Retrieves processing state.
ActionInvocation	getInvocation()	Returns Action's execution state.
List<InterceptorCommonLibrary.FieldUsage<?>>	getManualParameterConversionFields()	Returns info of fields that will be validated and converted from request parameters using form code.
boolean	getModelDriven()	Returns whether Action is ModelDriven.
List<InterceptorCommonLibrary.FieldUsage<?>>	getNoConversionFields()	Returns info of string fields set from a request parameter without conversion.
List<InterceptorCommonLibrary.PairFieldUsage<?>>	getPairConversionFields()	Returns info for string/non-string field pairs where the string field stores the unconverted request parameters and non-string field has the converted values.
List<InterceptorCommonLibrary.PairFieldUsage<?>>	getPairListConversionFields()	Returns info for single string/non-string list field pairs where the string field stores the unconverted request parameter and non-string field has the converted values.
List<InterceptorCommonLibrary.FieldUsage<?>>	getSetOnlyFields()	Returns info for string fields that are set from request parameters with no validation or other policies.
DefaultAnnotationValidator.InterceptorContext.InterceptorStep	getStep()	Returns current, top-level processing step.
List<InterceptorCommonLibrary.FieldUsage<?>>	getSuccessfulFields()	Returns info list of non-pair fields that were successfully processed.
List<InterceptorCommonLibrary.PairFieldUsage<?>>	getSuccessfulPairFields()	Returns info list of pair fields that were successfully processed.
TextProvider	getTextProvider()	Returns message key translator, which can be null if not provided by Action.
ValidationAware	getValidationAware()	Returns recipient of error messages, which can be null if not provided by Action.
ValidationAware2	getValidationAware2()	Returns recipient of error and warning messages, which can be null if not provided by Action.
org.apache.logging.log4j.Logger	getValidationLogger()	Returns Log4j2 logger for logging conversion and validation failures.
void	reset()
void	setAction(Object action)
void	setAutoParameterConversionFields(List<InterceptorCommonLibrary.FieldUsage<?>> autoParameterConversionFields)
void	setAutoParameterListConversionFields(List<InterceptorCommonLibrary.FieldUsage<?>> autoParameterListConversionFields)
void	setDefaultParameterConversionFields(List<InterceptorCommonLibrary.FieldUsage<?>> defaultParameterConversionFields)
void	setFailedFields(List<InterceptorCommonLibrary.FieldUsage<?>> failedFields)
void	setFailedPairFields(List<InterceptorCommonLibrary.PairFieldUsage<?>> failedPairFields)
void	setFieldParsedParameterListTable(Map<String,FieldParsedParameterList> fieldParsedParameterListTable)
void	setFileFields(List<InterceptorCommonLibrary.FieldUsage<?>> fileFields)
void	setForm(Object form)
static void	setInstance(DefaultAnnotationValidator.InterceptorContext value)
void	setInvocation(ActionInvocation invocation)
void	setManualParameterConversionFields(List<InterceptorCommonLibrary.FieldUsage<?>> manualParameterConversionFields)
void	setModelDriven(boolean modelDriven)
void	setNoConversionFields(List<InterceptorCommonLibrary.FieldUsage<?>> noConversionFields)
void	setPairConversionFields(List<InterceptorCommonLibrary.PairFieldUsage<?>> pairConversionFields)
void	setPairListConversionFields(List<InterceptorCommonLibrary.PairFieldUsage<?>> pairListConversionFields)
void	setSetOnlyFields(List<InterceptorCommonLibrary.FieldUsage<?>> setOnlyFields)
void	setStep(DefaultAnnotationValidator.InterceptorContext.InterceptorStep step)
void	setSuccessfulFields(List<InterceptorCommonLibrary.FieldUsage<?>> successfulFields)
void	setSuccessfulPairFields(List<InterceptorCommonLibrary.PairFieldUsage<?>> successfulPairFields)
void	setTextProvider(TextProvider textProvider)
void	setValidationAware(ValidationAware validationAware)
void	setValidationAware2(ValidationAware2 validationAware2)
void	setValidationLogger(org.apache.logging.log4j.Logger validationLogger)

Methods inherited from class java.lang.Object

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

Constructor Details

InterceptorContext

protected InterceptorContext()

Method Details

getInstance

public static DefaultAnnotationValidator.InterceptorContext getInstance()

Retrieves processing state.

setInstance

public static void setInstance(DefaultAnnotationValidator.InterceptorContext value)

reset

public void reset()

getStep

public DefaultAnnotationValidator.InterceptorContext.InterceptorStep getStep()

Returns current, top-level processing step.

setStep

public void setStep(DefaultAnnotationValidator.InterceptorContext.InterceptorStep step)

getInvocation

public ActionInvocation getInvocation()

Returns Action's execution state.

setInvocation

public void setInvocation(ActionInvocation invocation)

getAction

public Object getAction()

Returns current Action.

setAction

public void setAction(Object action)

getForm

public Object getForm()

Returns whatever's the Action's form, whether it's the Action itself, or the model for a ModelDriven Action.

setForm

public void setForm(Object form)

getModelDriven

public boolean getModelDriven()

Returns whether Action is ModelDriven.

setModelDriven

public void setModelDriven(boolean modelDriven)

getTextProvider

public TextProvider getTextProvider()

Returns message key translator, which can be null if not provided by Action.

setTextProvider

public void setTextProvider(TextProvider textProvider)

getValidationAware

public ValidationAware getValidationAware()

Returns recipient of error messages, which can be null if not provided by Action.

setValidationAware

public void setValidationAware(ValidationAware validationAware)

getValidationAware2

public ValidationAware2 getValidationAware2()

Returns recipient of error and warning messages, which can be null if not provided by Action.

setValidationAware2

public void setValidationAware2(ValidationAware2 validationAware2)

getValidationLogger

public org.apache.logging.log4j.Logger getValidationLogger()

Returns Log4j2 logger for logging conversion and validation failures.

setValidationLogger

public void setValidationLogger(org.apache.logging.log4j.Logger validationLogger)

getFieldParsedParameterListTable

public Map<String,FieldParsedParameterList> getFieldParsedParameterListTable()

Returns table of parameters parsed into field name and index, lookup by field name.

setFieldParsedParameterListTable

public void setFieldParsedParameterListTable(Map<String,FieldParsedParameterList> fieldParsedParameterListTable)

getAutoParameterConversionFields

public List<InterceptorCommonLibrary.FieldUsage<?>> getAutoParameterConversionFields()

Returns info of fields where converted request parameters are directly set according to a converter annotation.

setAutoParameterConversionFields

public void setAutoParameterConversionFields(List<InterceptorCommonLibrary.FieldUsage<?>> autoParameterConversionFields)

getAutoParameterListConversionFields

public List<InterceptorCommonLibrary.FieldUsage<?>> getAutoParameterListConversionFields()

Returns info of fields where a converted request parameter is directly set according to a list converter annotation.

setAutoParameterListConversionFields

public void setAutoParameterListConversionFields(List<InterceptorCommonLibrary.FieldUsage<?>> autoParameterListConversionFields)

getDefaultParameterConversionFields

public List<InterceptorCommonLibrary.FieldUsage<?>> getDefaultParameterConversionFields()

Returns info of fields where a converted request parameters are directly set according to the default converter for the data type.

setDefaultParameterConversionFields

public void setDefaultParameterConversionFields(List<InterceptorCommonLibrary.FieldUsage<?>> defaultParameterConversionFields)

getFileFields

public List<InterceptorCommonLibrary.FieldUsage<?>> getFileFields()

Returns info of fields that receive file parameters created by the FileUploadInterceptor.

setFileFields

public void setFileFields(List<InterceptorCommonLibrary.FieldUsage<?>> fileFields)

getManualParameterConversionFields

public List<InterceptorCommonLibrary.FieldUsage<?>> getManualParameterConversionFields()

Returns info of fields that will be validated and converted from request parameters using form code.

setManualParameterConversionFields

public void setManualParameterConversionFields(List<InterceptorCommonLibrary.FieldUsage<?>> manualParameterConversionFields)

getNoConversionFields

public List<InterceptorCommonLibrary.FieldUsage<?>> getNoConversionFields()

Returns info of string fields set from a request parameter without conversion.

setNoConversionFields

public void setNoConversionFields(List<InterceptorCommonLibrary.FieldUsage<?>> noConversionFields)

getPairConversionFields

public List<InterceptorCommonLibrary.PairFieldUsage<?>> getPairConversionFields()

Returns info for string/non-string field pairs where the string field stores the unconverted request parameters and non-string field has the converted values.

setPairConversionFields

public void setPairConversionFields(List<InterceptorCommonLibrary.PairFieldUsage<?>> pairConversionFields)

getPairListConversionFields

public List<InterceptorCommonLibrary.PairFieldUsage<?>> getPairListConversionFields()

Returns info for single string/non-string list field pairs where the string field stores the unconverted request parameter and non-string field has the converted values.

setPairListConversionFields

public void setPairListConversionFields(List<InterceptorCommonLibrary.PairFieldUsage<?>> pairListConversionFields)

getSetOnlyFields

public List<InterceptorCommonLibrary.FieldUsage<?>> getSetOnlyFields()

Returns info for string fields that are set from request parameters with no validation or other policies.

setSetOnlyFields

public void setSetOnlyFields(List<InterceptorCommonLibrary.FieldUsage<?>> setOnlyFields)

getSuccessfulFields

public List<InterceptorCommonLibrary.FieldUsage<?>> getSuccessfulFields()

Returns info list of non-pair fields that were successfully processed.

setSuccessfulFields

public void setSuccessfulFields(List<InterceptorCommonLibrary.FieldUsage<?>> successfulFields)

getFailedFields

public List<InterceptorCommonLibrary.FieldUsage<?>> getFailedFields()

Returns info list of non-pair fields processing failed.

setFailedFields

public void setFailedFields(List<InterceptorCommonLibrary.FieldUsage<?>> failedFields)

getSuccessfulPairFields

public List<InterceptorCommonLibrary.PairFieldUsage<?>> getSuccessfulPairFields()

Returns info list of pair fields that were successfully processed.

setSuccessfulPairFields

public void setSuccessfulPairFields(List<InterceptorCommonLibrary.PairFieldUsage<?>> successfulPairFields)

getFailedPairFields

public List<InterceptorCommonLibrary.PairFieldUsage<?>> getFailedPairFields()

Returns info list of pair fields processing failed.

setFailedPairFields

public void setFailedPairFields(List<InterceptorCommonLibrary.PairFieldUsage<?>> failedPairFields)