# All Classes and Interfaces

Class
Description
AbstractBeanSelectionProvider
TODO lukaszlenart: write a JavaDoc
AbstractClosingTag
AbstractDoubleListTag
AbstractFileUploadInterceptor
AbstractInterceptor
Provides default implementations of optional lifecycle methods
AbstractListTag
AbstractMatcher<E>
Matches patterns against pre-compiled wildcard expressions pulled from target objects.
AbstractMultiPartRequest
Abstract class with some helper methods, it should be used when starting development of another implementation of `MultiPartRequest`
AbstractRequiredListTag
AbstractResourceStore
AbstractUITag
Abstract base class for all UI tags.
AbstractUITagBeanInfo
Describes properties supported by the AbstractUITag - base class for all UI tags This bases on HtmlTagSupportBeanInfo class from StripesFramework - thanks! FIXME: is it used?
AcceptedPatternsChecker
Used across different interceptors to check if given string matches one of the accepted patterns.
AcceptedPatternsChecker.IsAccepted
Action
All actions may implement this interface, which exposes the `execute()` method.
ActionChainResult
This result invokes an entire other action, complete with it's own interceptor stack and result.
ActionComponent
ActionConfig
Contains everything needed to configure and execute an action: methodName - the method name to execute on the action.
ActionConfig.Builder
The builder for this object.
ActionConfigMatcher
Matches paths against pre-compiled wildcard expressions pulled from action configs.
ActionContext
The ActionContext is the context in which an `Action` is executed.
ActionError
Render action errors if they exists the specific layout of the rendering depends on the theme itself.
ActionErrorModel
ActionErrorTag
ActionError Tag.
ActionEventListener
Provides hooks for handling key action events
ActionFactory
Used by `ObjectFactory` to build actions
ActionFileUploadInterceptor
Interceptor that is based off of `MultiPartRequestWrapper`, which is automatically applied for any request that includes a file when the support for multi-part request is enabled, see Disabling file upload.
ActionInvocation
An `ActionInvocation` represents the execution state of an `Action`.
ActionMapper
ActionMapping
Simple class that holds the action mapping information used to invoke a Struts action.
ActionMappingParametersInterceptor
ActionMessage
Render action messages if they exists, specific rendering layout depends on the theme itself.
ActionMessageModel
ActionMessageTag
ActionMessage Tag.
ActionModel
ActionProxy
ActionProxy is an extra layer between XWork and the action so that different proxies are possible.
ActionProxyFactory
The `ActionProxyFactory` is used to create `ActionProxy`s to be executed.
ActionSupport
Provides a default implementation for the most common actions.
ActionTag
ActionValidatorManager
ActionValidatorManager is the main interface for validation managers (regular and annotation based).
After
Marks a action method that needs to be called after the main action method and the result was executed.
AliasInterceptor
The aim of this Interceptor is to alias a named parameter to a different named parameter.
AllowedHttpMethod
Use this annotation to limit with what http method action or action's method can be called
AllowedMethods
Anchor
AnchorModel
AnchorTag
AnnotationActionValidatorManager
AnnotationActionValidatorManager is the entry point into XWork's annotations-based validator framework.
AnnotationUtils
`AnnotationUtils`
AnnotationValidationConfigurationBuilder
`AnnotationValidationConfigurationBuilder`
AnnotationValidationInterceptor
Extends the xwork validation interceptor to also check for a @SkipValidation annotation, and if found, don't validate this action method
AnnotationWorkflowInterceptor
AppendIterator
AppendIteratorFilter
A bean that takes several iterators and outputs them in sequence
AppendIteratorTag
Append a list of iterators.
ApplicationAware
Actions that want to be aware of the application Map object should implement this interface.
ApplicationMap
A simple implementation of the `Map` interface to handle a collection of attributes and init parameters in a `ServletContext` object.
ArrayConverter
AsyncManager
Adds support for invoke async actions.
AttributeMap
A Map that holds 4 levels of scope.
BackgroundProcess
Interface used to create a background process which will be executed by `ExecuteAndWaitInterceptor`
BaseTemplateEngine
Base class for template engines.
Bean
BeanConfig
BeanInfoCacheFactory<Key,Value>
A proxy interface to be used with Struts DI mechanism
BeanModel
BeanSelectionConfig
BeanSelectionProvider
When implemented allows to alias already existing beans
BeanTag
Before
Marks a action method that needs to be executed before the main action method.
BeforeResult
Marks a action method that needs to be executed before the result.
CallbackWriter
ChainingInterceptor
Checkbox
Renders an HTML input element of type checkbox, populated by the specified property from the ValueStack.
CheckboxInterceptor
CheckboxList
Creates a series of checkboxes from a list.
CheckboxListModel
CheckboxListTag
CheckboxModel
CheckboxTag
ClassFinder
ClassFinder searches the classpath of the specified ClassLoaderInterface for packages, classes, constructors, methods, or fields with specific annotations.
ClassFinder.Annotatable
ClassFinder.AnnotationInfo
ClassFinder.ClassInfo
ClassFinder.FieldInfo
ClassFinder.Info
ClassFinder.MethodInfo
ClassFinder.PackageInfo
ClassFinderFactory
Allows create different ClassFinders which should help support different Java versions
ClassLoaderInterface
Classes implementing this interface can find resources and load classes, usually delegating to a class loader
ClassLoaderInterfaceDelegate
Default implementation of ClassLoaderInterface, which delegates to an actual ClassLoader
ClassLoaderUtil
This class is extremely useful for loading resources and classes in a fault tolerant manner that works across different applications servers.
ClassPathFinder
This class is an utility class that will search through the classpath for files whose names match the given pattern.
ClearableValueStack
ValueStacks implementing this interface provide a way to remove values from their contexts.
ClearSessionInterceptor
ClosingUIBean
ClosingUIBean is the standard superclass for UI components such as div etc.
CoepInterceptor
Interceptor that implements Cross-Origin Embedder Policy on incoming requests used to protect a document from loading any non-same-origin resources which don't explicitly grant the document permission to be loaded.
CollectionConverter
ComboBox
ComboBoxModel
ComboBoxTag
Component
Base class to extend for UI components.
ComponentModel
ComponentTag
ComponentTagSupport
ComponentUrlProvider
Default implementation of UrlProvider
ComponentUtils
Various static methods used with components
CompositeActionMapper
A composite action mapper that is capable of delegating to a series of `ActionMapper` if the former failed to obtained a valid `ActionMapping` or uri.
CompositeTextProvider
This is a composite `TextProvider` that takes in an array or `List` of `TextProvider`s, it will consult each of them in order to get a composite result.
CompoundRoot
A Stack that is implemented using a List.
CompoundRootAccessor
A stack that is able to call methods on objects in the stack.
ConditionalInterceptor
A marking interface, when implemented allows to conditionally execute a given interceptor within the current action invocation.
ConditionalVisitorFieldValidator
ConditionalVisitorFieldValidator
The ConditionalVisitorFieldValidator will forward validation to the VisitorFieldValidator only if the expression will evaluate to true.
ConfigParseUtil
Configuration
XWork configuration.
ConfigurationException
ConfigurationException
ConfigurationManager
ConfigurationManager - central for XWork Configuration management, including its ConfigurationProvider.
ConfigurationProvider
Interface to be implemented by all forms of XWork configuration classes.
ConfigurationUtil
ConfigurationUtil
ConstantConfig
Container
Injects dependencies into constructors, methods and fields annotated with `Inject`.
ContainerBuilder
Builds a dependency injection `Container`.
ContainerBuilder.Command
Implemented by classes which participate in building a container.
ContainerProvider
Provides beans and constants/properties for the Container
ContainUtil
`ContainUtil` will check if object 1 contains object 2.
ContentTypeMatcher<E>
Matches content type of uploaded files, similar to `PatternMatcher`
Context
Context of the current injection.
ContextBean
Base class for control and data tags
ContextBeanTag
ContextUtil
Value Stack's Context related Utilities.
Conversion
A marker annotation for type conversions at Type level.
ConversionAnnotationProcessor
Used to process `TypeConversion` annotation to read defined Converters
ConversionData
ConversionErrorFieldValidator
This validator checks if there are any conversion errors for a field and applies them if they exist.
ConversionErrorFieldValidator
Field Validator that checks if a conversion error occurred for this field.
ConversionErrorInterceptor
ConversionErrorInterceptor adds conversion errors from the ActionContext to the Action's field errors.
ConversionFileProcessor
Used to process <clazz>-conversion.properties file to read defined Converters
ConversionPropertiesProcessor
Used to read converters from Properties file
ConversionRule
`ConversionRule`
ConversionType
`ConversionType`
ConverterFactory
Dedicated interface used by `ObjectFactory` to build `TypeConverter`
CookieInterceptor
CookieProvider
Action can create cookies which will be stored in response
CookieProviderInterceptor
Allows actions to send cookies to client, action must implement `CookieProvider` You must reference this interceptor in your default stack or in action's stack, see example below.
CookiesAware
Actions implementing the CookiesAware interface will receive a Map of filtered cookies via the setCookiesMap method.
CoopInterceptor
Interceptor that implements Cross-Origin Opener Policy on incoming requests.
Counter
A bean that can be used to keep track of a counter.
CreateIfNull
CreateSessionInterceptor
CreditCardValidator
This validator checks that a field is a valid credit card.
CreditCardValidator
CreditCardFieldValidator checks that a given String/Array/Collection field, if not empty, is a valid credit card number.
CspInterceptor
Interceptor that implements Content Security Policy on incoming requests used to protect against common XSS and data injection attacks.
CspReportAction
An abstract Action that can be extended to process the incoming CSP violation reports.
CspSettings
CspSettings interface used by the `CspInterceptor` to add the CSP header to the response.
CspSettingsAware
Implement this interface by an action to provide a custom `CspSettings`, see `CspInterceptor` for more details
CustomValidator
This annotation can be used for custom validators.
CycleDetector<T>
Date
DateConverter
DateFormatter
Allows defines a wrapper around different formatting APIs, like old SimpleDateFormat and new DateTimeFormatter introduced in Java 8 Date/Time API
DateModel
`DateModel`
DateRangeFieldValidator
This validator checks that a date field has a value within a specified range.
DateRangeFieldValidator
Field Validator that checks if the date supplied is within a specific range.
DateTag
DateTextField
DateTextFieldInterceptor
DateTextFieldInterceptor.DateWord
DateTextFieldTag
DateTimeFormatterAdapter
Debug
DebuggingInterceptor
DebugTag
DebugUtils
DefaultAcceptedPatternsChecker
DefaultActionFactory
Default implementation
DefaultActionInvocation
The Default ActionInvocation implementation
DefaultActionMapper
DefaultActionProxy
The Default ActionProxy implementation
DefaultActionProxyFactory
Default factory for `ActionProxyFactory`.
DefaultActionSupport
A simple action support class that sets properties to be able to serve
DefaultActionValidatorManager
This is the entry point into XWork's rule-based validation framework.
DefaultConfiguration
DefaultConfiguration
DefaultContentTypeMatcher
DefaultConversionAnnotationProcessor
Default implementation of `ConversionAnnotationProcessor`
DefaultConversionFileProcessor
Default implementation of `ConversionFileProcessor`
DefaultCspReportAction
The default implementation of `CspReportAction` that simply logs the JSON object that contains the details of the CSP violation.
DefaultCspSettings
Default implementation of `CspSettings`.
DefaultDispatcherErrorHandler
Default implementation of `DispatcherErrorHandler` which sends Error Report in devMode or `HttpServletResponse.sendError(int, java.lang.String)` otherwise.
DefaultExcludedPatternsChecker
DefaultFileManager
Default implementation of `FileManager`
DefaultFileManagerFactory
Default implementation
DefaultInterceptorFactory
Default implementation
DefaultLocaleProvider
Default implementation of `LocaleProvider`
DefaultLocaleProviderFactory
DefaultNotExcludedAcceptedPatternsChecker
DefaultObjectTypeDeterminer
This `ObjectTypeDeterminer` looks at the Class-conversion.properties for entries that indicated what objects are contained within Maps and Collections.
DefaultOgnlBeanInfoCacheFactory<Key,Value>
Default OGNL Cache factory implementation.
DefaultOgnlCacheFactory<Key,Value>
Default OGNL Cache factory implementation.
DefaultOgnlExpressionCacheFactory<Key,Value>
Default OGNL Expression Cache factory implementation.
DefaultPropertiesProvider
Loads the default properties, separate from the usual struts.properties loading
DefaultSettings
DefaultSettings implements optional methods of Settings.
DefaultStaticContentLoader
Default implementation to server static content
DefaultTagLibrary
The default Struts tag library
DefaultTextProvider
DefaultTextProvider gets texts from only the default resource bundles associated with the default bundles.
DefaultTypeConverter
Default type conversion.
DefaultUnknownHandlerFactory
Default implementation
DefaultUnknownHandlerManager
Default implementation of UnknownHandlerManager
DefaultUrlHelper
Default implementation of UrlHelper
DefaultValidatorFactory
Default implementation
DefaultValidatorFactory
Default validator factory
DefaultValidatorFileParser
Parse the validation file.
DefaultWorkflowInterceptor
DelegatingValidatorContext
A default implementation of the `ValidatorContext` interface.
DependencyException
Thrown when a dependency is misconfigured.
DirectedGraph<T>
Dispatcher
A utility class the actual dispatcher delegates most of its tasks to.
Dispatcher.Locator
Provide an accessor class for static XWork utility.
DispatcherConstants
DispatcherErrorHandler
Implementation of this interface is used to handle internal errors or missing resources.
DispatcherListener
A interface to tag those that want to execute code on the init and destory of a Dispatcher.
DomHelper
Helper class to create and retrieve information from location-enabled DOM-trees.
DomHelper.DOMBuilder
The `DOMBuilder` is a utility class that will generate a W3C DOM Document from SAX events.
DomHelper.StartHandler
DoubleListUIBean
DoubleListUIBean is the standard superclass of all Struts double list handling components.
DoubleRangeFieldValidator
This validator checks that a double field has a value within a specified range.
DoubleRangeFieldValidator
Field Validator that checks if the double specified is within a certain range.
DoubleSelect
Renders two HTML select elements with second one changing displayed values depending on selected entry of first one.
DoubleSelectModel
DoubleSelectTag
EarlyInitializable
A marking interface that will tell CI to initialise the bean when instating the whole objects' graph
Element
Else
ElseIf
ElseIfModel
ElseIfTag
ElseModel
ElseTag
EmailValidator
This validator checks that a field is a valid e-mail address if it contains a non-empty String.
EmailValidator
EmailValidator checks that a given String field, if not empty, is a valid email address.
EnvsValueSubstitutor
ErrorMessageBuilder
Helper class to build error messages.
Evaluated
ExceptionHolder
A simple wrapper around an exception, providing an easy way to print out the stack trace of the exception as well as a way to get a handle on the exception itself.
ExceptionMappingConfig
Configuration for exception mapping.
ExceptionMappingConfig.Builder
The builder for this object.
ExceptionMappingInterceptor
ExcludedPatternsChecker
Used across different interceptors to check if given string matches one of the excluded patterns.
ExcludedPatternsChecker.IsExcluded
ExecuteAndWaitInterceptor
ExecuteOperations
Contains execution operations for filters
ExecutorProvider
Interface mimics `ExecutorService` to be used with `ExecuteAndWaitInterceptor` to execute `BackgroundProcess`
ExpressionCacheFactory<Key,Value>
A proxy interface to be used with Struts DI mechanism
ExpressionValidator
This non-field level validator validates a supplied regular expression.
ExpressionValidator
A Non-Field Level validator that validates based on regular expression supplied.
ExtraParameterProvider
Factory<T>
A custom factory.
FastByteArrayOutputStream
A speedy implementation of ByteArrayOutputStream.
FetchMetadataInterceptor
Interceptor that implements Fetch Metadata policy on incoming requests used to protect against CSRF, XSSI, and cross-origin information leaks.
FieldError
Render field errors if they exists.
FieldErrorModel
FieldErrorTag
FieldError Tag.
FieldExpressionValidator
This validator uses an OGNL expression to perform its validator.
FieldExpressionValidator
Validates a field using an OGNL expression.
FieldValidator
The FieldValidator interface defines the methods to be implemented by FieldValidators.
FieldValidatorSupport
Base class for field validators.
File
Renders an HTML file input element.
FileManager
Basic interface to access file on the File System and to monitor changes
FileManagerFactory
Factory that creates FileManager, default to `DefaultFileManager`
FileManagerFactoryProvider
Allows to specify custom `FileManagerFactory`
FileManagerProvider
Allows to specify custom `FileManager` by user
FileModel
FileResourceStore
Reads a class from disk class taken from Apache JCI
FileRevision
Represents file resource revision, used for file://* resources
FileTag
FilterHostConfig
Host configuration that wraps FilterConfig
FinalizablePhantomReference<T>
Phantom reference with a `finalizeReferent()` method which a background thread invokes after the garbage collector reclaims the referent.
FinalizableSoftReference<T>
Soft reference with a `finalizeReferent()` method which a background thread invokes after the garbage collector reclaims the referent.
FinalizableWeakReference<T>
Weak reference with a `finalizeReferent()` method which a background thread invokes after the garbage collector reclaims the referent.
Form
Form.FieldVisitorValidatorWrapper
Wrap field validator, add visitor's field prefix to the field name.
FormButton
FormButton.
FormModel
FormTag
FreemarkerManager
Static Configuration Manager for the FreemarkerResult's configuration
FreemarkerResult
Renders a view using the Freemarker template engine.
FreemarkerTemplateEngine
Freemarker based template engine.
FreemarkerThemeTemplateLoader
When loading a template, if sees theme token in path, does a template search through theme hierarchy for template, starting at the theme name after the token.
Function<F,T>
A Function provides a transformation on an object and returns the resulting object.
GenericUIBean
GlobalLocalizedTextProvider
Provides support for localization in the framework, it can be used to read only default bundles.
Head
Renders parts of the HEAD section for an HTML file.
HeadModel
HeadTag
Hidden
Renders an HTML input element of type hidden, populated by the specified property from the ValueStack.
HiddenModel
HiddenTag
HostConfig
Abstraction for host configuration information such as init params or the servlet context.
HttpDelete
Use this annotation to allow call action or action's method via DELETE request only
HttpGet
Use this annotation to allow call action or action's method via GET request only
HttpGetOrPost
Use this annotation to allow call action or action's method via GET or POST request only
HttpHeader<T>
HttpHeaderResult
HttpMethod
Enum represents possible http request types
HttpMethodAware
Action when implements this interface is notified about what method was used to perform request, it works in connection with `HttpMethodInterceptor` Another function of this interface is to return result, which should be returned when action was called with wrong http method
HttpMethodInterceptor
Interceptor is used to control with what http methods action can be called, if request with not allowed method was performed, `HttpMethodInterceptor.badRequestResultName` will be returned or if action implements `HttpMethodAware` and `HttpMethodAware.getBadRequestResultName()` returns non-null result name, thus value will be used instead.
HttpParameters
HttpParameters.Builder
HttpParametersPropertyAccessor
HttpPost
Use this annotation to allow call action or action's method via POST request only
HttpPut
Use this annotation to allow call action or action's method via PUT request only
I18n
Gets a resource bundle and place it on the value stack.
I18nInterceptor
An interceptor that handles setting the locale specified in a session as the locale for the current action request.
I18nInterceptor.LocaleHandler
Uses to handle reading/storing Locale from/in different locations
I18nInterceptor.Storage
I18nModel
I18nTag
If
IfModel
IfTag
Include
IncludeModel
IncludeTag
Initializable
Beans marked with this interface will be always initialised after the internal DI mechanism will be created.
InitOperations
Contains initialization operations
Inject
Annotates members and parameters which should have their value[s] injected.
InputConfig
Marks a action method that if it's not validated by ValidationInterceptor then execute input method or input result.
InputTransferSelect
InputTransferSelectModel
InputTransferSelectTag
InputTransferSelect jsp tag.
InstantiatingNullHandler
Interceptor
InterceptorBuilder
Builds a list of interceptors referenced by the refName in the supplied PackageConfig.
InterceptorConfig
Configuration for Interceptors.
InterceptorConfig.Builder
The builder for this object.
InterceptorFactory
Dedicated interface used by `ObjectFactory` to build `Interceptor`
InterceptorListHolder
InterceptorListHolder
InterceptorLocator
Defines an object that can be used to retrieve interceptor configuration
InterceptorMapping
`InterceptorMapping`
InterceptorStackConfig
Configuration for InterceptorStack.
InterceptorStackConfig.Builder
The builder for this object.
IntRangeFieldValidator
This validator checks that a numeric field has a value within a specified range.
IntRangeFieldValidator
Field Validator that checks if the integer specified is within a certain range.
InvocationSessionStore
InvocationSessionStore
IteratorComponent
IteratorFilterSupport
A base class for iterator filters
IteratorFilterSupport.EnumerationIterator
IteratorGenerator
A bean that generates an iterator filled with a given object depending on the count, separator and converter defined.
IteratorGenerator.Converter
Interface for converting each separated token into an Object of choice.
IteratorGeneratorTag
NOTE: JSP-TAG
IteratorModel
IteratorStatus
The iterator tag can export an IteratorStatus object so that one can get information about the status of the iteration, such as: index: current iteration index, starts on 0 and increments in one on every iteration count: iterations so far, starts on 1.
IteratorStatus.StatusState
IteratorTag
JakartaMultiPartRequest
Multipart form data request adapter for Jakarta Commons FileUpload package.
JakartaStreamMultiPartRequest
Multi-part form data request adapter for Jakarta Commons FileUpload package that leverages the streaming API rather than the traditional non-streaming API.
JarEntryRevision
Represents jar resource revision, used for jar://* resource
JarResourceStore
Read resources from a jar file
JBossFileManager
FileManager implementation used with JBoss AS
JspSupportServlet
JspTemplateEngine
JSP based template engine.
Key
KeyProperty
Label
LabelModel
LabelTag
Link
Add nonce propagation feature to implement CSP in link tags
LinkModel
LinkTag
ListenerHostConfig
Host configuration that just holds a ServletContext
ListEntry
Entry in a list.
ListUIBean
DoubleListUIBean is the standard superclass of all Struts list handling components.
LocaleProvider
Indicates that the implementing class can provide its own `Locale`.
LocaleProviderFactory
Allows delegate creation of `LocaleProvider` to another implementation provided by a user.
LocalizedMessage
LocalizedTextProvider
Locatable
A interface that should be implemented by objects knowning their location (i.e.
LocatableConstantFactory<T>
Factory that remembers where a constant came from
LocatableFactory<T>
Attaches location information to the factory.
LocatableProperties
Properties implementation that remembers the location of each property.
Located
Base class for location aware objects
Location
A location in a resource.
LocationAttributes
A class to handle location information stored in attributes.
LocationAttributes.Pipe
A SAX filter that adds the information available from the `Locator` as attributes.
LocationImpl
A simple immutable and serializable implementation of `Location`.
LocationUtils
Location-related utility methods.
LocationUtils.LocationFinder
An finder or object locations
LoggingInterceptor
LongRangeFieldValidator
This validator checks that a numeric field has a value within a specified range.
LongRangeFieldValidator
Field Validator that checks if the long specified is within a certain range.
MakeIterator
MakeIterator.
MemberAccessValueStack
ValueStacks implementing this interface provide a way to remove block or allow access to properties using regular expressions
MergeIterator
MergeIteratorFilter
A bean that takes several iterators and outputs the merge of them.
MergeIteratorTag
Append a list of iterators.
MessageStoreInterceptor
MessageStorePreResultListener
This listener is used by `MessageStoreInterceptor` to store messages in HttpSession just before result will be executed.
MethodFilterInterceptor
MethodFilterInterceptorUtil
Utility class contains common methods used by `MethodFilterInterceptor`.
MockActionInvocation
Mock for an `ActionInvocation`.
MockActionProxy
Mock for an `ActionProxy`.
MockConfiguration
Simple configuration used for unit testing
MockContainer
Mock implementation to be used in unittests
MockDispatcher
MockInterceptor
Mock for an `Interceptor`.
MockObjectTypeDeterminer
Mocks the function of an ObjectTypeDeterminer for testing purposes.
MockResult
Mock for a `Result`.
ModelDriven<T>
ModelDriven Actions provide a model object to be pushed onto the ValueStack in addition to the Action itself, allowing a FormBean type approach like Struts.
ModelDrivenInterceptor
Watches for `ModelDriven` actions and adds the action's model on to the value stack.
ModelDrivenInterceptor.RefreshModelBeforeResult
Refreshes the model instance on the value stack, if it has changed
MultiPartRequest
Abstract wrapper class HTTP requests to handle multi-part data.
MultiPartRequestWrapper
Parse a multipart request and provide a wrapper around the request.
MultiselectInterceptor
Just as the CheckboxInterceptor checks that if only the hidden field is present, so too does this interceptor.
NamedVariablePatternMatcher
An implementation of a pattern matcher that uses simple named wildcards.
NamedVariablePatternMatcher.CompiledPattern
Stores the compiled pattern and the variable names matches will correspond to.
NamespaceMatch
Represents a match from a namespace pattern matching.
NamespaceMatcher
Matches namespace strings against a wildcard pattern matcher
NoOpInterceptor
Interceptor that does nothing, used in the "empty" stack
NoParameters
This marker interface should be implemented by actions that do not want any parameters set on them automatically.
NotExcludedAcceptedPatternsChecker
Used across different places to check if given string is not excluded and is accepted
NotExcludedAcceptedPatternsChecker.IsAllowed
NullHandler
Interface for handling null results from Chains.
NullResult
Null result to get around annotation defaults that can't be null FIXME: ???? is it usable? doesn't it make sense to have such result?
Number
NumberConverter
NumberTag
ObjectAccessor
ObjectFactory
ObjectFactory is responsible for building the core framework objects.
ObjectFactoryDestroyable
An interface to be implemented by any ObjectFactory implementation if it requires shutdown hook whenever an ObjectFactory is to be destroyed.
ObjectProxy
An Object to use within OGNL to proxy other Objects usually Collections that you set in a different place on the ValueStack but want to retain the context information about where they previously were.
ObjectProxyPropertyAccessor
Is able to access (set/get) properties on a given object.
ObjectTypeDeterminer
Determines what the key and and element class of a Map or Collection should be.
OgnlCache<Key,Value>
A basic cache interface for use with OGNL processing (such as Expression, BeanInfo).
OgnlCacheFactory<Key,Value>
Used by `OgnlUtil` to create appropriate OGNL caches based on configuration.
OgnlCacheFactory.CacheType
OgnlCaffeineCache<K,V>
This OGNL Cache implementation is backed by `Caffeine` which uses the Window TinyLfu algorithm.
OgnlDefaultCache<K,V>
Basic OGNL cache implementation.
OgnlGuard
Guards all expressions parsed by Struts Core.
OgnlLRUCache<K,V>
A basic OGNL LRU cache implementation.
OgnlNullHandlerWrapper
OgnlReflectionContextFactory
OgnlReflectionProvider
OgnlTextParser
OGNL implementation of `TextParser`
OgnlTypeConverterWrapper
Wraps an XWork type conversion class for as an OGNL TypeConverter
OgnlUtil
Utility class that provides common access to the Ognl APIs for setting and getting properties from objects (usually Actions).
OgnlValueStack
Ognl implementation of a value stack that allows for dynamic Ognl expressions to be evaluated against it.
OgnlValueStackFactory
Creates an Ognl value stack
OptGroup
OptGroupModel
Freemarker's TransformModel for OptGroup component.
OptGroupTag
OptionTransferSelect
OptionTransferSelectModel
OptionTransferSelectTag
OptionTransferSelect jsp tag.
PackageConfig
Configuration for Package.
PackageConfig.Builder
The builder for this object.
PackageProvider
Provides configuration packages.
Param
Param.UnnamedParametric
Tags can implement this to support nested param tags without the `name` attribute.
Parameter
Parameter.Empty
Parameter.File
Parameter.Request
ParameterAction
Defines a parameter action prefix.
Parameterizable
ParameterNameAware
This interface is implemented by actions that want to declare acceptable parameters.
ParameterPropertyAccessor
ParameterRemoverInterceptor
This is a simple XWork interceptor that allows parameters (matching one of the paramNames attribute csv value) to be removed from the parameter map if they match a certain value (matching one of the paramValues attribute csv value), before they are set on the action.
ParametersAware
This interface gives actions an alternative way of receiving input parameters.
ParametersInterceptor
This interceptor sets all parameters on the value stack.
ParameterValueAware
This interface is implemented by actions that want to declare acceptable parameter values.
ParamModel
ParamNameAwareResult
Accept parameter name/value to be set on `Result`
ParamTag
Password
PasswordModel
PasswordTag
PatternMatcher<E>
Compiles and matches a pattern against a value
PlainResult
This result can only be used in code, as a result of action's method, eg.:
PlainTextResult
A result that send the content out as plain text.
PostbackResult
PrefixBasedActionMapper
PrefixBasedActionProxyFactory
PrefixMethodInvocationUtil
A utility class for invoking prefixed methods in action class.
PrefixTrie
Quickly matches a prefix to an object.
Preparable
Preparable Actions will have their `prepare()` method called if the `PrepareInterceptor` is applied to the ActionConfig.
PrepareInterceptor
This interceptor calls `prepare()` on actions which implement `Preparable`.
PrepareOperations
Contains preparation operations for a request before execution
PreResultListener
PreResultListeners may be registered with an `ActionInvocation` to get a callback after the `Action` has been executed but before the `Result` is executed.
PrettyPrintWriter
PrincipalAware
Actions that want access to the Principal information from HttpServletRequest object should implement this interface.
PrincipalProxy
Proxy interface used together with PrincipalAware interface.
PropertiesConfigurationProvider
PropertiesReader
This class is used to read properties lines.
Property
PropertyModel
PropertyTag
ProviderAllowlist
Allows registration of classes that should be allowed to be used in OGNL expressions, using a key to identify the source of the allowlist.
ProxyUtil
`ProxyUtil`
Push
PushModel
PushTag
QueryStringBuilder
A builder used to create a proper Query String out of a set of parameters
QueryStringParser
Used to parse Http Query String into a map of parameters with support for fragment
QueryStringParser.Result
Represents result of parsing query string by implementation of `QueryStringParser`
Radio
RadioModel
RadioTag
RangeValidatorSupport<T extends Comparable>
Base class for range based validators.
Redirectable
Marking interface for results which perform browser redirection
ReferenceCache<K,V>
Extends `ReferenceMap` to support lazy loading values by overriding `ReferenceCache.create(Object)`.
ReferenceMap<K,V>
Concurrent hash map that wraps keys and/or values in soft or weak references.
ReferenceMap.Strategy
ReferenceType
Reference type.
ReflectionContextFactory
ReflectionContextState
Manages variables in the reflection context and returns values to be used by the application.
ReflectionException
ReflectionExceptionHandler
Declares a class that wants to handle its own reflection exceptions
ReflectionProvider
RegexFieldValidator
Validates a string field using a regular expression.
RegexFieldValidator
Validates a string field using a regular expression.
RegexPatternMatcher
Allows regular expressions to be used in action names.
RegexPatternMatcherExpression
Holds a compiled expression to match URLs
ReloadingClassLoader
The ReloadingClassLoader uses a delegation mechanism to allow classes to be reloaded.
RepopulateConversionErrorFieldValidatorSupport
An abstract base class that adds in the capability to populate the stack with a fake parameter map when a conversion error has occurred and the 'repopulateField' property is set to "true".
RequestMap
A simple implementation of the `Map` interface to handle a collection of request attributes.
RequestUtils
Request handling utility class.
RequiredFieldValidator
This validator checks that a field is non-null.
RequiredFieldValidator
RequiredFieldValidator checks if the specified field is not null.
RequiredStringValidator
This validator checks that a String field is not empty (i.e.
RequiredStringValidator
RequiredStringValidator checks that a String field is non-null and has a length > 0.
Reset
Render a reset button.
ResetModel
ResetTag
ResolverUtil<T>
ResolverUtil is used to locate classes that are available in the/a class path and meet arbitrary conditions.
ResolverUtil.AnnotatedWith
A Test that checks to see if each class is annotated with a specific annotation.
ResolverUtil.ClassTest
ResolverUtil.IsA
A Test that checks to see if each class is assignable to the provided class.
ResolverUtil.NameEndsWith
A Test that checks to see if each class name ends with the provided suffix.
ResolverUtil.NameIs
ResolverUtil.ResourceTest
ResolverUtil.Test
A simple interface that specifies how to test classes to determine if they are to be included in the results produced by the ResolverUtil.
ResourceBundleTextProvider
Extension Interface for TextProvider to help supporting ResourceBundles.
ResourceFinder
ResourceIsolationPolicy
Interface for the resource isolation policies to be used for fetch metadata checks.
ResourceStore
*interface taken from Apache JCI
ResourceStoreClassLoader
class taken from Apache JCI
ResourceUtil
ResponseBuilder
Restful2ActionMapper
Extended version of `RestfulActionMapper`, see documentation for more details Restful2ActionMapper
RestfulActionMapper
Simple Restfull Action Mapper to support REST application See docs for more information RestfulActionMapper
Result
All results (except for `Action.NONE`) of an `Action` are mapped to a View implementation.
ResultConfig
Configuration for Result.
ResultConfig.Builder
The builder for this object.
ResultFactory
Used by `ObjectFactory` to build `Result`
ResultTypeConfig
Configuration class for result types.
ResultTypeConfig.Builder
The builder for this object.
Revision
Class represents common revision resource, should be used as default class when no other option exists
RolesInterceptor
RootAccessor
RuntimeConfiguration
RuntimeConfiguration
Scope
Scope of an injected objects.
Scope.Strategy
Pluggable scoping strategy.
Scoped
Annotates a scoped implementation class.
ScopedModelDriven<T>
Adds the ability to set a model, probably retrieved from a given state.
ScopedModelDrivenInterceptor
An interceptor that enables scoped model-driven actions.
ScopeInterceptor
ScopesHashModel
Simple Hash model that also searches other scopes.
Script
Add nonce propagation feature to implement CSP in script tags
ScriptModel
ScriptTag
SecurityMemberAccess
Allows access decisions to be made on the basis of whether a member is static or not.
Select
Render an HTML input tag of type select.
SelectModel
SelectTag
ServletActionContext
Web-specific context information for actions.
ServletActionRedirectResult
ServletConfigInterceptor
ServletContextAware
For components that have a dependence on the Servlet context.
ServletContextAwareConfigurationProvider
Dedicated interface to allow inject `ServletContext` and perform initialisation based in it
ServletDispatcherResult
ServletHostConfig
Host configuration that wraps a ServletConfig
ServletPrincipalProxy
PrincipalProxy implementation for using HttpServletRequest Principal related methods.
ServletRedirectResult
Calls the `sendRedirect` method to the location specified.
ServletRequestAware
All Actions that want to have access to the servlet request object must implement this interface.
ServletResponseAware
All Actions that want to have access to the servlet response object must implement this interface.
ServletUrlRenderer
Implementation of the `UrlRenderer` interface that creates URLs suitable in a servlet environment.
SessionAware
Actions that want access to the user's HTTP session attributes should implement this interface.
SessionMap
A simple implementation of the `Map` interface to handle a collection of HTTP session attributes.
Set
SetModel
SetTag
ShortCircuitableValidator
This interface should be implemented by validators that can short-circuit the validator queue that it is in.
ShortRangeFieldValidator
This validator checks that a numeric field has a value within a specified range.
ShortRangeFieldValidator
Field Validator that checks if the short specified is within a certain range.
SimpleDateFormatAdapter
SkipValidation
Marks an Action method to not be validated
SortIteratorFilter
A bean that takes a source and comparator then attempt to sort the source utilizing the comparator.
SortIteratorTag
NOTE: JSP-TAG
StaticContentLoader
Interface for loading static resources, based on a path.
StaticContentLoader.Validator
StaticParametersInterceptor
This interceptor populates the action with the static parameters defined in the action configuration.
StreamResult
A custom Result type for sending raw data (via an InputStream) directly to the HttpServletResponse.
StringConverter
StringLengthFieldValidator
This validator checks that a String field is of the right length.
StringLengthFieldValidator
StringLengthFieldValidator checks that a String field is of a certain length.
StrutsActionProxy
StrutsActionProxyFactory
StrutsBackgroundProcess
Background thread to be executed by the ExecuteAndWaitInterceptor.
StrutsBeanSelectionProvider
Selects the implementations of key framework extension points, using the loaded property constants.
StrutsBeanWrapper
StrutsBodyTagSupport
Contains common functionalities for Struts JSP Tags.
StrutsClassTemplateLoader
StrutsConstants
This class provides a central location for framework configuration keys used to retrieve and store Struts configuration settings.
StrutsConversionErrorInterceptor
StrutsConversionPropertiesProcessor
StrutsConverterFactory
Default implementation
StrutsDefaultConfigurationProvider
StrutsException
A generic runtime exception that optionally contains Location information
StrutsExecuteFilter
Executes the discovered request information.
StrutsExecutorProvider
StrutsJavaConfiguration
StrutsJavaConfigurationProvider
StrutsListener
Servlet listener for Struts.
StrutsLocalizedTextProvider
Provides support for localization in the framework, it can be used to read only default bundles, or it can search the class hierarchy to find proper bundles.
StrutsModels
Provides @s.tag access for various tags.
StrutsOgnlGuard
The default implementation of `OgnlGuard`.
StrutsParameter
Used to annotate public getter/setter methods or fields on `Action` classes that are intended for parameter injection by the `ParametersInterceptor`.
StrutsPrepareAndExecuteFilter
Handles both the preparation and execution phases of the Struts dispatching process.
StrutsPrepareFilter
Prepares the request for execution by a later `StrutsExecuteFilter` filter instance.
StrutsQueryStringBuilder
StrutsQueryStringParser
StrutsQueryStringParser.StrutsQueryStringParserResult
StrutsRequestWrapper
All Struts requests are wrapped with this class, which provides simple JSTL accessibility.
StrutsResourceIsolationPolicy
Default resource isolation policy used in `FetchMetadataInterceptor` that implements the `ResourceIsolationPolicy` interface.
StrutsResultFactory
Default implementation which uses `ParamNameAwareResult` to accept or throw away parameters
StrutsResultSupport
StrutsServlet
Servlet dispatcher for Struts.
StrutsStatics
Constants used internally by Struts.
StrutsTag
An annotation to document a Struts jsp/freemarker/velocity tag
StrutsTagAttribute
Documents an attribute to a Struts tag
StrutsTagSkipInheritance
Marks a class as the top class in the class hierarchy scanned for tag annotations FIXME: use it or remove
StrutsTestCaseHelper
Generic test setup methods to be used with any unit testing framework.
StrutsTextProviderFactory
This factory enables users to provide and correctly initialize a custom TextProvider.
StrutsTypeConverter
StrutsTypeConverterCreator
Default implementation of `TypeConverterCreator`
StrutsTypeConverterHolder
Default implementation of `TypeConverterHolder`
StrutsUploadedFile
StrutsUploadedFile.Builder
StrutsUrlDecoder
StrutsUrlEncoder
StrutsUtil
Struts base utility class, for use in Velocity and Freemarker templates
StrutsXmlConfigurationProvider
Override Xwork class so we can use an arbitrary config file
StubConfigurationProvider
Submit
Render a submit button.
SubmitModel
SubmitTag
SubsetIteratorFilter
A bean that takes an iterator and outputs a subset of it.
SubsetIteratorFilter.Decider
A decider determines if the given element should be added to the list or not.
SubsetIteratorTag
NOTE: JSP-TAG
TabbedPane
A bean that helps implement a tabbed pane FIXME: use it remove
TagLibraryDirectiveProvider
Provides Velocity implementation classes for a tag library
TagLibraryModelProvider
Provides Freemarker implementation classes for a tag library
TagModel
TagUtils
Template
A template is used as a model for rendering output.
TemplateEngine
Any template language which wants to support UI tag templating needs to provide an implementation of this interface to handle rendering the template
TemplateEngineManager
The TemplateEngineManager will return a template engine for the template
TemplateRenderingContext
Context used when rendering templates.
Test<T>
This is the testing interface that is used to accept or reject resources.
Text
TextArea
TextAreaModel
TextareaTag
TextField
TextFieldModel
TextFieldTag
TextModel
TextParser
Used to parse expressions like ${foo.bar} or %{bar.foo} but it is up tp the TextParser's implementation what kind of opening char to use (#, $, %, etc)
TextParseUtil
Utility class for text parsing.
TextParseUtil.ParsedValueEvaluator
A parsed value evaluator for `TextParseUtil`.
TextProvider
Provides access to `ResourceBundle`s and their underlying text messages.
TextProviderFactory
TextProviderHelper
Helper methods to access text from TextProviders
TextProviderSupport
Default TextProvider implementation.
TextTag
ThreadAllowlist
Allows any bean to allowlist a class for use in OGNL expressions, for the current thread only.
Timer
A bean that can be used to time execution of pages FIXME: remove?
Token
TokenHelper
TokenHelper
TokenInterceptor
TokenModel
TokenSessionStoreInterceptor
TokenTag
TypeConversion
TypeConversionException
TypeConversionException should be thrown by any TypeConverters which fail to convert values
TypeConverter
Interface for accessing the type conversion facilities within a context.
TypeConverterCreator
Instantiate converter classes, if cannot create TypeConverter throws exception
TypeConverterHolder
Holds all mappings related to `TypeConverter`s
UIBean
UIBean is the standard superclass of all Struts UI components.
Unchainable
Simple marker interface to indicate an object should not have its properties copied during chaining.
UnknownHandler
Handles cases when the result or action is unknown.
UnknownHandlerConfig
UnknownHandlerFactory
Dedicated interface used by `ObjectFactory` to build `UnknownHandler`
UnknownHandlerManager
An unknown handler manager contains a list of UnknownHandler and iterates on them by order
UpDownSelect
UpDownSelectModel
UpDownSelectTag
UploadedFile
Virtual representation of an uploaded file used by `MultiPartRequest`
UploadedFileConverter
UploadedFilesAware
Actions that want to be aware of all the uploaded file should implement this interface.
URL
URLBean
A bean that can generate a URL.
UrlDecoder
URL Decoder used internally by Struts
UrlEncoder
URL Encoder used internally by Struts
UrlHelper
Helper class used to build Urls or parse request params
URLModel
UrlProvider
Implementations of this interface can be used to build a URL
UrlRenderer
Implementations of this interface are responsible for rendering/creating URLs for a specific environment (e.g.
UrlSet
Use with ClassFinder to filter the Urls to be scanned, example:
UrlSet.FileProtocolNormalizer
URLTag
UrlValidator
This validator checks that a field is a valid URL.
URLValidator
URLValidator checks that a given field is a String and a valid URL
Validateable
Provides an interface in which a call for a validation check can be done.
ValidationAware
ValidationAware classes can accept Action (class level) or field level error messages.
ValidationAwareSupport
Provides a default implementation of ValidationAware.
ValidationErrorAware
ValidationErrorAware classes can be notified about validation errors before `DefaultWorkflowInterceptor` will return 'inputResultName' result to allow change or not the result name This interface can be only applied to action which already implements `ValidationAware` interface!
ValidationException
ValidationException.
ValidationInterceptor
ValidationParameter
The ValidationParameter annotation is used as a parameter for CustomValidators.
Validations
ValidationWorkflowAware
ValidationWorkflowAware classes can programmatically change result name when errors occurred This interface can be only applied to action which already implements `ValidationAware` interface!
Validator<T>
ValidatorConfig
Holds the necessary information for configuring an instance of a Validator.
ValidatorConfig.Builder
Builds a ValidatorConfig
ValidatorContext
The context for validation.
ValidatorFactory
Dedicated interface used by `ObjectFactory` to build `Validator`
ValidatorFactory
ValidatorFactory
ValidatorFileParser
This class serves 2 purpose : Parse the validation config file.
ValidatorSupport
Abstract implementation of the Validator interface suitable for subclassing.
ValidatorType
`ValidatorType`
ValueStack
ValueStack allows multiple beans to be pushed in and dynamic EL expressions to be evaluated against it.
ValueStackFactory
Factory that creates a value stack, defaulting to the OgnlValueStackFactory
ValueStackProvider
ValueSubstitutor
VisitorFieldValidator
The validator allows you to forward validator to object properties of your action using the objects own validator files.
VisitorFieldValidator
VisitorFieldValidator.AppendingValidatorContext
WildcardHelper
This class is an utility class that perform wilcard-patterns matching and isolation taken from Apache Cocoon.
WildcardUtil
Helper class to convert wildcard expression to regular expression
WithLazyParams
Interceptors marked with this interface won't be fully initialised during initialisation.
WithLazyParams.LazyParamInjector
XmlConfigurationProvider
Looks in the classpath for an XML file, "struts.xml" by default, and uses it for the XWork configuration.
XmlDocConfigurationProvider
This is a base Struts `ConfigurationProvider` for loading configuration from a parsed `XML document`.
XmlHelper
XML utilities.
XWorkBasicConverter
XWorkCollectionPropertyAccessor
XWorkConverter
XWorkConverter is a singleton used by many of the Struts 2's Ognl extension points, such as InstantiatingNullHandler, XWorkListPropertyAccessor etc to do object conversion.
XWorkEnumerationAccessor
XWorkIteratorPropertyAccessor
XWorkJUnit4TestCase
XWorkList
A simple list that guarantees that inserting and retrieving objects will always work regardless of the current size of the list.
XWorkListPropertyAccessor
Overrides the list property accessor so in the case of trying to add properties of a given bean and the JavaBean is not present, this class will create the necessary blank JavaBeans.
XWorkMapPropertyAccessor
Implementation of PropertyAccessor that sets and gets properties by storing and looking up values in Maps.
XWorkMethodAccessor
Allows methods to be executed under normal cirumstances, except when `ReflectionContextState.DENY_METHOD_EXECUTION` is in the action context with a value of true.
XWorkObjectPropertyAccessor
XWorkTestCase
Base JUnit TestCase to extend for XWork specific JUnit tests.
XWorkTestCaseHelper
Generic test setup methods to be used with any unit testing framework.
XWorkTypeConverterWrapper
Wraps an OGNL TypeConverter as an XWork TypeConverter