Serialized Form

  • Package org.apache.struts

  • Package org.apache.struts.action

  • Package org.apache.struts.chain

  • Package org.apache.struts.chain.commands

  • Package org.apache.struts.config

    • Class org.apache.struts.config.ActionConfig

      class ActionConfig extends BaseConfig implements Serializable
      serialVersionUID:
      -7821814205678644815L

      • Serialized Fields

        • acceptPage
          Integer acceptPage
          Accepted page value for multi-page validation.
          If two or more page values are accepted, then acceptPage is set minimum of them.
          If multi-page validation is not use, acceptPage is not set. Then multi-page validation is disabled.
          Since:
          Struts 1.4.1
        • actionId
          String actionId

          The internal identification of this action mapping. Identifications are not inheritable and must be unique within a module.

          Since:
          Struts 1.3.6
        • attribute
          String attribute

          The request-scope or session-scope attribute name under which our form bean is accessed, if it is different from the form bean's specified name.

        • cancellable
          boolean cancellable

          Can this Action be cancelled? [false]

          By default, when an Action is cancelled, validation is bypassed and the Action should not execute the business operation. If a request tries to cancel an Action when cancellable is not set, a "InvalidCancelException" is thrown.

        • cancellableSet
          boolean cancellableSet
          Indicates whether the "cancellable " property has been set or not.
        • catalog
          String catalog

          The name of a commons-chain catalog in which command should be sought. If a command is defined and this property is undefined, the "default" catalog will be used. This is likely to be infrequently used after a future release of commons-chain supports a one-string expression of a catalog/chain combination.

          Since:
          Struts 1.3.0
        • command
          String command

          The name of a commons-chain command which should be executed as part of the processing of this action.

          Since:
          Struts 1.3.0
        • dispatcher
          String dispatcher
          The name of the Dispatcher implementation that will dispatch to the end point of this action.
          Since:
          Struts 1.4
        • exceptions
          HashMap<String,ExceptionConfig> exceptions

          The set of exception handling configurations for this action, if any, keyed by the type property.

        • extensionProcessed
          boolean extensionProcessed

          Have the inheritance values for this class been applied?

        • forward
          String forward

          Context-relative path of the web application resource that will process this request via RequestDispatcher.forward(), instead of instantiating and calling the Action class specified by "type". Exactly one of forward, include, or type must be specified.

        • forwards
          HashMap<String,ForwardConfig> forwards

          The set of local forward configurations for this action, if any, keyed by the name property.

        • include
          String include

          Context-relative path of the web application resource that will process this request via RequestDispatcher.include(), instead of instantiating and calling the Action class specified by "type". Exactly one of forward, include, or type must be specified.

        • inherit
          String inherit

          The path of the ActionConfig that this object should inherit properties from.

        • input
          String input

          Context-relative path of the input form to which control should be returned if a validation error is encountered. Required if "name" is specified and the input bean returns validation errors.

        • moduleConfig
          ModuleConfig moduleConfig

          The module configuration with which we are associated.

        • multipartClass
          String multipartClass

          Fully qualified Java class name of the MultipartRequestHandler implementation class used to process multi-part request data for this Action.

        • name
          String name

          Name of the form bean, if any, associated with this Action.

        • parameter
          String parameter

          General purpose configuration parameter that can be used to pass extra information to the Action instance selected by this Action. Struts does not itself use this value in any way.

        • path
          String path

          Context-relative path of the submitted request, starting with a slash ("/") character, and omitting any filename extension if extension mapping is being used.

        • populate
          String populate

          Identifies conditions for automatic form population with values from HTTP request.

        • populateNames
          String[] populateNames
        • prefix
          String prefix

          Prefix used to match request parameter names to form bean property names, if any.

        • reset
          String reset

          Identifies conditions for automatic form reset.

        • resetNames
          String[] resetNames
        • roleNames
          String[] roleNames

          The set of security role names used to authorize access to this Action, as an array for faster access.

        • roles
          String roles

          Comma-delimited list of security role names allowed to request this Action.

        • scope
          String scope

          Identifier of the scope ("request" or "session") within which our form bean is accessed, if any.

        • singleton
          boolean singleton

          Should this action be instantiated once per module (singleton) or once per request (prototype)?

        • suffix
          String suffix

          Suffix used to match request parameter names to form bean property names, if any.

        • type
          String type

          Fully qualified Java class name of the Action class to be used to process requests for this mapping if the forward and include properties are not set. Exactly one of forward, include, or type must be specified.

        • unknown
          boolean unknown

          Indicates Action be configured as the default one for this module, when true.

        • validate
          boolean validate

          Should the validate() method of the form bean associated with this action be called?

        • validateSet
          boolean validateSet
          Indicates whether the "validate" property has been set or not.

    • Class org.apache.struts.config.ActionConfigMatcher

      class ActionConfigMatcher extends Object implements Serializable
      serialVersionUID:
      -7803926870173575845L

      • Serialized Fields

        • compiledPaths
          ArrayList<org.apache.struts.config.ActionConfigMatcher.Mapping> compiledPaths

          The compiled paths and their associated ActionConfig's

    • Class org.apache.struts.config.BaseConfig

      class BaseConfig extends Object implements Serializable
      serialVersionUID:
      7059240587081363820L

      • Serialized Fields

        • configured
          boolean configured
          Indicates if configuration of this component been completed. TODO change protected to private and use methods provided by extenders?
        • properties
          Properties properties
          A map of arbitrary properties configured for this component.
          Since:
          Struts 1.3

    • Class org.apache.struts.config.ControllerConfig

      class ControllerConfig extends BaseConfig implements Serializable
      serialVersionUID:
      7704474362520651283L

      • Serialized Fields

        • bufferSize
          int bufferSize
          The input buffer size for file uploads.
        • catalog
          String catalog
          The chain catalog name for this module.
        • command
          String command
          The chain command to execute for each request.
        • contentType
          String contentType
          The content type and character encoding to be set on each response.
        • fileCountMax
          long fileCountMax
          The maximum permitted number of files that may be uploaded in a single request. A value of -1 indicates no maximum.
        • forwardPattern
          String forwardPattern
          The replacement pattern used to determine a context-relative URL from a ForwardConfig element. The pattern may consist of any combination of the following markers and characters:
          • $M - Replaced by the module prefix for the current module.
          • $P - Replaced by the path property of a ForwardConfig instance.
          • $$ - Renders a literal dollar sign ("$") character in the resulting URL.
          • A dollar sign followed by any other character is reserved for future use, and both characters are silently swallowed.
          • All other characters in the pattern are passed through unchanged.

          If this property is set to null, a default pattern of $M$P is utilized, which is backwards compatible with the hard coded functionality in prior versions.

        • inputForward
          boolean inputForward
          Should the input property of ActionConfig instances associated with this module be treated as the name of a corresponding ForwardConfig. A false value treats them as a module-relative path (consistent with the hard coded behavior of earlier versions of Struts.
          Since:
          Struts 1.1
        • locale
          boolean locale
          Should we store a Locale object in the user's session if needed?
        • maxFileSize
          String maxFileSize
          The maximum file size to process for file uploads.
        • maxSize
          String maxSize
          The maximum size to process a complete request for file uploads.
        • maxStringLen
          String maxStringLen
          The maximum length of a string parameter in a multipart request.
        • memFileSize
          String memFileSize
          The maximum file size to retain in memory.
        • multipartClass
          String multipartClass
          The fully qualified Java class name of the MultipartRequestHandler class to be used.
        • nocache
          boolean nocache
          Should we set no-cache HTTP headers on each response?
        • pagePattern
          String pagePattern
          The replacement pattern used to determine a context-relative URL from the page attribute of Struts tags and configuration properties. The pattern may consist of any combination of the following markers and characters:
          • $M - Replaced by the module prefix for the current module.
          • $P - Replaced by the page attribute value being evaluated.
          • $$ - Renders a literal dollar sign ("$") character in the resulting URL.
          • A dollar sign followed by any other character is reserved for future use, and both characters are silently swallowed.
          • All other characters in the pattern are passed through unchanged.

          If this property is set to null, a default pattern of $M$P is utilized, which is backwards compatible with the hard coded functionality in prior versions.

        • processorClass
          String processorClass
          The fully qualified class name of the RequestProcessor implementation class to be used for this module.
        • tempDir
          String tempDir
          The temporary working directory to use for file uploads.

    • Class org.apache.struts.config.ExceptionConfig

      class ExceptionConfig extends BaseConfig implements Serializable
      serialVersionUID:
      -6269406361939618377L

      • Serialized Fields

        • bundle
          String bundle
          The servlet context attribute under which the message resources bundle to be used for this exception is located. If not set, the default message resources for the current module is assumed.
        • extensionProcessed
          boolean extensionProcessed
          Have the inheritance values for this class been applied?
        • handler
          String handler
          The fully qualified Java class name of the exception handler class which should be instantiated to handle this exception.
        • inherit
          String inherit
          The type of the ExceptionConfig that this object should inherit properties from.
        • key
          String key
          The message resources key specifying the error message associated with this exception.
        • path
          String path
          The module-relative path of the resource to forward to if this exception occurs during an Action.
        • scope
          String scope
          The scope in which we should expose the ActionMessage for this exception handler.
        • type
          String type
          The fully qualified Java class name of the exception that is to be handled by this handler.

    • Class org.apache.struts.config.FormBeanConfig

      class FormBeanConfig extends BaseConfig implements Serializable
      serialVersionUID:
      -2606605006051449892L

      • Serialized Fields

        • dynamic
          boolean dynamic
          Is the form bean class an instance of DynaActionForm with dynamic properties?
        • extensionProcessed
          boolean extensionProcessed
          Have the inheritance values for this class been applied?
        • formProperties
          HashMap<String,FormPropertyConfig> formProperties
          The set of FormProperty elements defining dynamic form properties for this form bean, keyed by property name.
        • inherit
          String inherit
          The name of the FormBeanConfig that this config inherits configuration information from.
        • lock
          String lock

          The lockable object we can synchronize on when creating DynaActionFormClass.

        • name
          String name
          The unique identifier of this form bean, which is used to reference this bean in ActionMapping instances as well as for the name of the request or session attribute under which the corresponding form bean instance is created or accessed.
        • restricted
          boolean restricted
          Is this DynaClass currently restricted (for DynaBeans with a MutableDynaClass).
        • type
          String type
          The fully qualified Java class name of the implementation class to be used or generated.

    • Class org.apache.struts.config.FormPropertyConfig

      class FormPropertyConfig extends BaseConfig implements Serializable
      serialVersionUID:
      8436264202472421426L

      • Serialized Fields

        • initial
          String initial
          String representation of the initial value for this property.
        • name
          String name
          The JavaBean property name of the property described by this element.
        • reset
          String reset

          The conditions under which the property described by this element should be reset to its initial value when the form's reset method is called.

          This may be set to true (to always reset the property) or a comma-separated list of HTTP request methods.

          Since:
          Struts 1.3
        • size
          int size

          The size of the array to be created if this property is an array type and there is no specified initial value. This value must be non-negative.

          Since:
          Struts 1.1
        • type
          String type
          The fully qualified Java class name of the implementation class of this bean property, optionally followed by [] to indicate that the property is indexed.

    • Class org.apache.struts.config.ForwardConfig

      class ForwardConfig extends BaseConfig implements Serializable
      serialVersionUID:
      -3983809829201419914L

      • Serialized Fields

        • catalog
          String catalog

          The name of a commons-chain catalog in which command should be looked up. If this value is undefined, then the command will be looked up in the "default" catalog. This value has no meaning except in the context of the command property.

        • command
          String command

          The name of a commons-chain command which should be looked up and executed before Struts dispatches control to the view represented by this config.

        • extensionProcessed
          boolean extensionProcessed
          Have the inheritance values for this class been applied?
        • inherit
          String inherit
          The name of the ForwardConfig that this object should inherit properties from.
        • module
          String module

          The prefix of the module to which this ForwardConfig entry points, which must start with a slash ("/") character.

          Usage note: If a forward config is used in a hyperlink, and a module is specified, the path must lead to another action and not directly to a page. This is in keeping with rule that in a modular application all links must be to an action rather than a page.

        • name
          String name
          The unique identifier of this forward, which is used to reference it in Action classes.
        • path
          String path

          The URL to which this ForwardConfig entry points, which must start with a slash ("/") character. It is interpreted according to the following rules:

          • If contextRelative property is true, the path is considered to be context-relative within the current web application (even if we are in a named module). It will be prefixed by the context path to create a server-relative URL.
          • If the contextRelative property is false, the path is considered to be the module-relative portion of the URL. It will be used as the replacement for the $P marker in the forwardPattern property defined on the ControllerConfig element for our current module. For the default forwardPattern value of $C$M$P, the resulting server-relative URL will be the concatenation of the context path, the module prefix, and the path from this ForwardConfig.
        • redirect
          boolean redirect
          Should a redirect be used to transfer control to the specified path?

    • Class org.apache.struts.config.MessageResourcesConfig

      class MessageResourcesConfig extends BaseConfig implements Serializable
      serialVersionUID:
      -8689874577436806101L

      • Serialized Fields

        • escape
          boolean escape
          Indicates whether 'escape processing' should be performed on the error message string.
        • factory
          String factory
          Fully qualified Java class name of the MessageResourcesFactory class we should use.
        • key
          String key
          The servlet context attributes key under which this MessageResources instance is stored.
        • nullValue
          boolean nullValue
          Should we return null for unknown message keys?
        • parameter
          String parameter
          Parameter that is passed to the createResources() method of our MessageResourcesFactory implementation.

    • Class org.apache.struts.config.PlugInConfig

      class PlugInConfig extends Object implements Serializable
      serialVersionUID:
      -7818510438622269230L

      • Serialized Fields

        • className
          String className
          The fully qualified Java class name of the PlugIn implementation class being configured.
        • configured
          boolean configured
          Has this component been completely configured?
        • properties
          HashMap<String,Object> properties
          A Map of the name-value pairs that will be used to configure the property values of a PlugIn instance.

  • Package org.apache.struts.config.impl

    • Class org.apache.struts.config.impl.DefaultModuleConfigFactory

      class DefaultModuleConfigFactory extends ModuleConfigFactory implements Serializable
      serialVersionUID:
      1227835615838585786L

    • Class org.apache.struts.config.impl.ModuleConfigImpl

      class ModuleConfigImpl extends BaseConfig implements Serializable
      serialVersionUID:
      -5742785805411686899L

      • Serialized Fields

        • actionConfigIds
          HashMap<String,ActionConfig> actionConfigIds

          The set of action configuration for this module, if any, keyed by the actionId property.

        • actionConfigList
          ArrayList<ActionConfig> actionConfigList

          The set of action configurations for this module, if any, listed in the order in which they are added.

        • actionConfigs
          Map<String,ActionConfig> actionConfigs

          The set of action configurations for this module, if any, keyed by the path property.

        • actionFormBeanClass
          String actionFormBeanClass

          The default class name to be used when creating action form bean instances.

        • actionForwardClass
          String actionForwardClass
          The default class name to be used when creating action forward instances.
        • actionMappingClass
          String actionMappingClass
          The default class name to be used when creating action mapping instances.
        • controllerConfig
          ControllerConfig controllerConfig

          The controller configuration object for this module.

        • exceptions
          HashMap<String,ExceptionConfig> exceptions

          The set of exception handling configurations for this module, if any, keyed by the type property.

        • formBeans
          HashMap<String,FormBeanConfig> formBeans

          The set of form bean configurations for this module, if any, keyed by the name property.

        • forwards
          HashMap<String,ForwardConfig> forwards

          The set of global forward configurations for this module, if any, keyed by the name property.

        • matcher
          ActionConfigMatcher matcher

          Matches action config paths against compiled wildcard patterns

        • messageResources
          HashMap<String,MessageResourcesConfig> messageResources

          The set of message resources configurations for this module, if any, keyed by the key property.

        • plugIns
          ArrayList<PlugInConfig> plugIns

          The set of configured plug-in Actions for this module, if any, in the order they were declared and configured.

        • prefix
          String prefix

          The prefix of the context-relative portion of the request URI, used to select this configuration versus others supported by the controller servlet. A configuration with a prefix of a zero-length String is the default configuration for this web module.

  • Package org.apache.struts.dispatcher

  • Package org.apache.struts.dispatcher.servlet

  • Package org.apache.struts.upload

  • Package org.apache.struts.util

  • Package org.apache.struts.validator