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

Property set 3

• allowedRequestParameters

Property set 4

• autoParameterConversionFields
• defaultParameterConversionFields
• manualParameterConversionFields
• noConversionFields
• pairConversionFields
• setOnlyFields

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.
HttpParameters	getAllowedRequestParameters()	Returns request parameters that have passed parameter filtering step.
Collection<InterceptorCommonLibrary.FieldUsage<?>>	getAutoParameterConversionFields()	Returns policies for fields where a converted request parameter is directly set according to a converter annotation.
Collection<InterceptorCommonLibrary.FieldUsage<?>>	getDefaultParameterConversionFields()	Returns policies for fields where a converted request parameter is directly set according to the default converter for the data type.
Collection<InterceptorCommonLibrary.FieldUsage<?>>	getFileFields()	Returns 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.
Collection<InterceptorCommonLibrary.FieldUsage<?>>	getManualParameterConversionFields()	Returns fields that will be validated and converted from request parameters using form code.
boolean	getModelDriven()	Returns whether Action is ModelDriven.
Collection<InterceptorCommonLibrary.FieldUsage<?>>	getNoConversionFields()	Returns policies for string fields set from a request parameter without conversion.
Collection<InterceptorCommonLibrary.PairFieldUsage<?>>	getPairConversionFields()	Returns policies for string/non-string field pairs where the string field stores the unconverted request parameter and non-string field has the converted value.
Collection<InterceptorCommonLibrary.FieldUsage<?>>	getSetOnlyFields()	Returns string fields that are set from a request parameter with no validation or other policies.
DefaultAnnotationValidator.InterceptorContext.InterceptorStep	getStep()	Returns current, top-level processing step.
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.
org.apache.logging.log4j.Logger	getValidationLogger()	Returns Log4j2 logger for logging conversion and validation failures.
void	reset()
void	setAction(Object action)
void	setAllowedRequestParameters(HttpParameters allowedRequestParameters)
void	setAutoParameterConversionFields(Collection<InterceptorCommonLibrary.FieldUsage<?>> autoParameterConversionFields)
void	setDefaultParameterConversionFields(Collection<InterceptorCommonLibrary.FieldUsage<?>> defaultParameterConversionFields)
void	setFileFields(Collection<InterceptorCommonLibrary.FieldUsage<?>> fileFields)
void	setForm(Object form)
static void	setInstance(DefaultAnnotationValidator.InterceptorContext value)
void	setInvocation(ActionInvocation invocation)
void	setManualParameterConversionFields(Collection<InterceptorCommonLibrary.FieldUsage<?>> manualParameterConversionFields)
void	setModelDriven(boolean modelDriven)
void	setNoConversionFields(Collection<InterceptorCommonLibrary.FieldUsage<?>> noConversionFields)
void	setPairConversionFields(Collection<InterceptorCommonLibrary.PairFieldUsage<?>> pairConversionFields)
void	setSetOnlyFields(Collection<InterceptorCommonLibrary.FieldUsage<?>> setOnlyFields)
void	setStep(DefaultAnnotationValidator.InterceptorContext.InterceptorStep step)
void	setTextProvider(TextProvider textProvider)
void	setValidationAware(ValidationAware validationAware)
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)

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)

getAllowedRequestParameters

public HttpParameters getAllowedRequestParameters()

Returns request parameters that have passed parameter filtering step.

setAllowedRequestParameters

public void setAllowedRequestParameters(HttpParameters allowedRequestParameters)

getAutoParameterConversionFields

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

Returns policies for fields where a converted request parameter is directly set according to a converter annotation.

setAutoParameterConversionFields

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

getDefaultParameterConversionFields

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

Returns policies for fields where a converted request parameter is directly set according to the default converter for the data type.

setDefaultParameterConversionFields

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

getFileFields

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

Returns fields that receive file parameters created by the FileUploadInterceptor.

setFileFields

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

getManualParameterConversionFields

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

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

setManualParameterConversionFields

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

getNoConversionFields

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

Returns policies for string fields set from a request parameter without conversion.

setNoConversionFields

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

getPairConversionFields

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

Returns policies for string/non-string field pairs where the string field stores the unconverted request parameter and non-string field has the converted value.

setPairConversionFields

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

getSetOnlyFields

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

Returns string fields that are set from a request parameter with no validation or other policies.

setSetOnlyFields

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