Serialized Form (Apache Struts API Documentation)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

# Serialized Form

Package org.apache.struts

Class org.apache.struts.Globals implements Serializable

Package org.apache.struts.validator

Class org.apache.struts.validator.DynaValidatorActionForm implements Serializable

Class org.apache.struts.validator.DynaValidatorForm implements Serializable

Serialized Fields

### validatorResults

    org.apache.commons.validator.ValidatorResults validatorResults

  The results returned from the validation performed by the `Validator`.

### page

    int page

  Used to indicate the current page of a multi-page form.

Class org.apache.struts.validator.FieldChecks implements Serializable

Class org.apache.struts.validator.ValidatorActionForm implements Serializable

Class org.apache.struts.validator.ValidatorForm implements Serializable

Serialized Fields

### validatorResults

    org.apache.commons.validator.ValidatorResults validatorResults

  The results returned from the validation performed by the `Validator`.

### page

    int page

  Used to indicate the current page of a multi-page form.

Package org.apache.struts.util

Class org.apache.struts.util.AppException implements Serializable

Class org.apache.struts.util.ImageButtonBean implements Serializable

Serialized Fields

### x

    java.lang.String x

  The X coordinate of the button press.

### y

    java.lang.String y

  The Y coordinate of the button press.

Class org.apache.struts.util.LabelValueBean implements Serializable

Serialized Fields

### label

    java.lang.String label

  The property which supplies the option label visible to the end user.

### value

    java.lang.String value

  The property which supplies the value returned to the server.

Class org.apache.struts.util.MessageResources implements Serializable

Serialized Fields

### config

    java.lang.String config

  The configuration parameter used to initialize this MessageResources.

### defaultLocale

    java.util.Locale defaultLocale

  The default Locale for our environment.

### factory

    MessageResourcesFactory factory

  The `MessageResourcesFactory` that created this instance.

### formats

    java.util.HashMap formats

  The set of previously created MessageFormat objects, keyed by the key computed in `messageKey()`.

### returnNull

    boolean returnNull

  Indicate is a `null` is returned instead of an error message string when an unknown Locale or key is requested.

Class org.apache.struts.util.MessageResourcesFactory implements Serializable

Serialized Fields

### returnNull

    boolean returnNull

  The "return null" property value to which newly created MessageResourcess should be initialized.

Class org.apache.struts.util.ModuleException implements Serializable

Serialized Fields

### property

    java.lang.String property

### error

    ActionError error

Class org.apache.struts.util.PropertyMessageResources implements Serializable

Serialized Fields

### locales

    java.util.HashMap locales

  The set of locale keys for which we have already loaded messages, keyed by the value calculated in `localeKey()`.

### messages

    java.util.HashMap messages

  The cache of messages we have accumulated over time, keyed by the value calculated in `messageKey()`.

Class org.apache.struts.util.PropertyMessageResourcesFactory implements Serializable

Class org.apache.struts.util.StrutsValidator implements Serializable

Package org.apache.struts.upload

Class org.apache.struts.upload.ContentLengthExceededException implements Serializable

Serialized Fields

### message

    java.lang.String message

Class org.apache.struts.upload.MaxLengthExceededException implements Serializable

Serialized Fields

### message

    java.lang.String message

Package org.apache.struts.tiles

Class org.apache.struts.tiles.ActionComponentServlet implements Serializable

Serialized Fields

### definitionsFactory

    DefinitionsFactory definitionsFactory

  Deprecated.
  Definitions factory

Class org.apache.struts.tiles.ComponentContext implements Serializable

Serialized Fields

### attributes

    java.util.Map attributes

  Component attributes.

Class org.apache.struts.tiles.ComponentDefinition implements Serializable

Serialized Fields

### name

    java.lang.String name

  Definition name

### path

    java.lang.String path

  Component / template path (URL).

### attributes

    java.util.Map attributes

  Attributes defined for the component.

### role

    java.lang.String role

  role associated to definition

### controller

    java.lang.String controller

  Associated Controller URL or classname, if defined

### controllerType

    java.lang.String controllerType

  Associated Controller typename, if controllerName defined. Can be CONTROLLER, ACTION or URL, or null

### controllerInstance

    Controller controllerInstance

  Controller associated to Definition. Lazy creation : only on first request

Class org.apache.struts.tiles.DefinitionAttribute implements Serializable

Class org.apache.struts.tiles.DefinitionNameAttribute implements Serializable

Class org.apache.struts.tiles.DefinitionsFactoryConfig implements Serializable

Serialized Fields

### factoryClassname

    java.lang.String factoryClassname

  Fully qualified classname of the factory to create. If no classname is set, a default factory is created (of class "org.apache.struts.tiles.xmlDefinition.I18nFactorySet").

### debugLevel

    int debugLevel

  Deprecated. Use commons-logging mechanism.

  Debug level value. 0=no debug info >0 = debug info.

### parserDebugLevel

    int parserDebugLevel

  Deprecated. Use commons-logging mechanism.

  Debug level value used when parsing configuration file. 0=no debug info; >0 = debug info.

### parserValidate

    boolean parserValidate

  Specifies whether the parser will validate configuration files. Default value is true.

### definitionConfigFiles

    java.lang.String definitionConfigFiles

  Definition configuration file specified by user

### moduleAware

    boolean moduleAware

  Specifies whether the factory is "module-aware".

### factoryName

    java.lang.String factoryName

  The name associated to this factory.
  With Struts 1.1, this name is the module name to which this factory belong. It is set by the system.
  In prior versions, this property is not used.

### extraAttributes

    java.util.Map extraAttributes

  Map of extra attribute available.

Class org.apache.struts.tiles.DefinitionsFactoryException implements Serializable

Serialized Fields

### exception

    java.lang.Exception exception

  Any "wrapped" exception will be exposed when this is serialized.

Class org.apache.struts.tiles.DirectStringAttribute implements Serializable

Class org.apache.struts.tiles.FactoryNotFoundException implements Serializable

Class org.apache.struts.tiles.NoSuchDefinitionException implements Serializable

Class org.apache.struts.tiles.PathAttribute implements Serializable

Class org.apache.struts.tiles.TilesException implements Serializable

Serialized Fields

### exception

    java.lang.Exception exception

  Any "wrapped" exception will be exposed when this is serialized.

Class org.apache.struts.tiles.TilesServlet implements Serializable

Class org.apache.struts.tiles.TilesUtilImpl implements Serializable

Serialized Fields

### log

    org.apache.commons.logging.Log log

  Commons Logging instance.

Class org.apache.struts.tiles.TilesUtilStrutsImpl implements Serializable

Class org.apache.struts.tiles.TilesUtilStrutsModulesImpl implements Serializable

Class org.apache.struts.tiles.UntyppedAttribute implements Serializable

Serialized Fields

### role

    java.lang.String role

  Role associated to this attribute.

### value

    java.lang.Object value

Package org.apache.struts.tiles.xmlDefinition

Class org.apache.struts.tiles.xmlDefinition.DefinitionsFactory implements Serializable

Serialized Fields

### definitions

    java.util.Map definitions

  Underlying map containing all definitions.

Class org.apache.struts.tiles.xmlDefinition.FactorySet implements Serializable

Serialized Fields

### factories

    java.util.Map factories

  Loaded factories

Class org.apache.struts.tiles.xmlDefinition.I18nFactorySet implements Serializable

Serialized Fields

### defaultFactory

    DefinitionsFactory defaultFactory

  Default factory.

### isValidatingParser

    boolean isValidatingParser

  Do we want validating parser. Default is `false`. Can be set from servlet config file.

### parserDetailLevel

    int parserDetailLevel

  Parser detail level. Default is 0. Can be set from servlet config file.

### filenames

    java.util.List filenames

  Names of files containing instances descriptions.

### loaded

    java.util.Map loaded

  Collection of already loaded definitions set, referenced by their suffix.

Class org.apache.struts.tiles.xmlDefinition.XmlDefinition implements Serializable

Serialized Fields

### inherit

    java.lang.String inherit

  Extends attribute value.

### isVisited

    boolean isVisited

  Used for resolving inheritance.

Package org.apache.struts.tiles.definition

Class org.apache.struts.tiles.definition.ComponentDefinitionsFactoryWrapper implements Serializable

Serialized Fields

### factory

    ComponentDefinitionsFactory factory

  The underlying factory

### config

    DefinitionsFactoryConfig config

  Factory configuration

Class org.apache.struts.tiles.definition.ReloadableDefinitionsFactory implements Serializable

Serialized Fields

### factory

    ComponentDefinitionsFactory factory

  The real factory instance

### properties

    java.util.Map properties

  Initialization parameters

Package org.apache.struts.tiles.beans

Class org.apache.struts.tiles.beans.SimpleMenuItem implements Serializable

Serialized Fields

### value

    java.lang.String value

### link

    java.lang.String link

### icon

    java.lang.String icon

### tooltip

    java.lang.String tooltip

Package org.apache.struts.taglib.tiles

Class org.apache.struts.taglib.tiles.AddTag implements Serializable

Class org.apache.struts.taglib.tiles.AttributeToScopeTag implements Serializable

Serialized Fields

### scopeName

    java.lang.String scopeName

  Deprecated.
  The scope name.

### scope

    int scope

  Deprecated.
  The scope value.

### property

    java.lang.String property

  Deprecated.
  The property name to be exposed.

Class org.apache.struts.taglib.tiles.DefinitionTag implements Serializable

Serialized Fields

### id

    java.lang.String id

  Definition identifier.

### scope

    java.lang.String scope

  Scope into which definition will be saved.

### extendsDefinition

    java.lang.String extendsDefinition

  Extends attribute value.

### definition

    ComponentDefinition definition

  Template definition

Class org.apache.struts.taglib.tiles.DefinitionTagSupport implements Serializable

Serialized Fields

### controllerType

    java.lang.String controllerType

  Associated Controller type

### controllerName

    java.lang.String controllerName

  Associated Controller name (classname or url)

### role

    java.lang.String role

  Role associated to definition.

### page

    java.lang.String page

  Uri of page assoicated to this definition.

Class org.apache.struts.taglib.tiles.GetAttributeTag implements Serializable

Serialized Fields

### attribute

    java.lang.String attribute

### role

    java.lang.String role

  Role attribute

### isErrorIgnored

    boolean isErrorIgnored

  Do we ignore error if attribute is not found. Default value is `false`, which will throw an exception.

Class org.apache.struts.taglib.tiles.GetTag implements Serializable

Class org.apache.struts.taglib.tiles.ImportAttributeTag implements Serializable

Serialized Fields

### name

    java.lang.String name

  Class name of object.

### scopeName

    java.lang.String scopeName

  The scope name.

### scope

    int scope

  The scope value.

### isErrorIgnored

    boolean isErrorIgnored

  Are errors ignored. This is the property for attribute `ignore`. Default value is `false`, which throws an exception. Only "attribute not found" - errors are ignored.

Class org.apache.struts.taglib.tiles.InitDefinitionsTag implements Serializable

Serialized Fields

### filename

    java.lang.String filename

### classname

    java.lang.String classname

Class org.apache.struts.taglib.tiles.InsertTag implements Serializable

Serialized Fields

### flush

    boolean flush

  Flush attribute value

### name

    java.lang.String name

  Name to insert

### attribute

    java.lang.String attribute

  Name of attribute from which to read page name to include

### beanName

    java.lang.String beanName

  Name of bean used as entity to include

### beanProperty

    java.lang.String beanProperty

  Name of bean property, if any

### beanScope

    java.lang.String beanScope

  Scope of bean, if any

### isErrorIgnored

    boolean isErrorIgnored

  Are errors ignored. This is the property for attribute 'ignore'. Default value is false, which throw an exception. Only 'attribute not found' errors are ignored.

### definitionName

    java.lang.String definitionName

  Name of component instance to include

### processEndTag

    boolean processEndTag

  Does the end tag need to be processed. Default value is true. Boolean set in case of ignored errors.

### cachedCurrentContext

    ComponentContext cachedCurrentContext

  Current component context

### tagHandler

    InsertTag.TagHandler tagHandler

  Finale handler of tag methods

### pageContext

    javax.servlet.jsp.PageContext pageContext

  Trick to allows inner classes to access pageContext

Class org.apache.struts.taglib.tiles.PutListTag implements Serializable

Serialized Fields

### attributeName

    java.lang.String attributeName

  Name of this attribute.

### list

    java.util.List list

  The list itself.

### role

    java.lang.String role

  Role attribute.

Class org.apache.struts.taglib.tiles.PutTag implements Serializable

Serialized Fields

### attributeName

    java.lang.String attributeName

  Name of attribute to put in component context

### value

    java.lang.Object value

  associated attribute value

### direct

    java.lang.String direct

  JSP Template compatibility

### valueType

    java.lang.String valueType

  Requested type for the value

### beanName

    java.lang.String beanName

  Bean name attribute

### beanProperty

    java.lang.String beanProperty

  Bean property attribute

### beanScope

    java.lang.String beanScope

  Bean scope attribute

### role

    java.lang.String role

  Role attribute

### realValue

    java.lang.Object realValue

  cached real value computed from tag attributes

Class org.apache.struts.taglib.tiles.UseAttributeTag implements Serializable

Serialized Fields

### classname

    java.lang.String classname

  Class name of object.

### scopeName

    java.lang.String scopeName

  The scope name.

### scope

    int scope

  The scope value.

### attributeName

    java.lang.String attributeName

  The attribute name to be exposed.

### isErrorIgnored

    boolean isErrorIgnored

  Are errors ignored. This is the property for attribute 'ignore'. Default value is `false`, which throws an exception. Only "attribute not found" - errors are ignored.

Package org.apache.struts.taglib.tiles.ext

Class org.apache.struts.taglib.tiles.ext.TextTag implements Serializable

Serialized Fields

### prefix

    java.lang.String prefix

  Deprecated.
  The prefix to be added before the html name.

Package org.apache.struts.taglib.template

Class org.apache.struts.taglib.template.GetTag implements Serializable

Serialized Fields

### flush

    boolean flush

  Deprecated.
  Should we flush before including this text?

### name

    java.lang.String name

  Deprecated.
  The name of the content that this tag includes (or prints).

### role

    java.lang.String role

  Deprecated.
  The role that the user must be in to retrieve content.

Class org.apache.struts.taglib.template.InsertTag implements Serializable

Serialized Fields

### map

    ContentMap map

  Deprecated.
  Each insert tag has a map of content.

### template

    java.lang.String template

  Deprecated.
  The application-relative URI of the template.

Class org.apache.struts.taglib.template.PutTag implements Serializable

Serialized Fields

### name

    java.lang.String name

  Deprecated.
  The content's name.

### role

    java.lang.String role

  Deprecated.
  The role that the user must be in to store content.

### content

    java.lang.String content

  Deprecated.
  The content's URI (or text).

### direct

    java.lang.String direct

  Deprecated.
  Determines whether content is included (false) or printed (true). Content is included (false) by default.

Package org.apache.struts.taglib.template.util

Class org.apache.struts.taglib.template.util.Content implements Serializable

Serialized Fields

### content

    java.lang.String content

  Deprecated.
  Templates regard this as content to be either included or printed directly. This is a blank final that is set at construction.

### direct

    java.lang.String direct

  Deprecated.
  Represents a boolean - if true, content is included, otherwise content is printed. This is a blank final that is set at construction. This is a string instead of a boolean as a convenience for the tags, whose corresponding attribute is a string.

Class org.apache.struts.taglib.template.util.ContentMap implements Serializable

Serialized Fields

### map

    java.util.HashMap map

  Deprecated.
  The map.

Package org.apache.struts.taglib.nested

Class org.apache.struts.taglib.nested.NestedPropertyTag implements Serializable

Serialized Fields

### property

    java.lang.String property

### originalNest

    java.lang.String originalNest

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.NestedReference implements Serializable

Serialized Fields

### beanName

    java.lang.String beanName

### property

    java.lang.String property

Class org.apache.struts.taglib.nested.NestedRootTag implements Serializable

Serialized Fields

### name

    java.lang.String name

### originalName

    java.lang.String originalName

### originalNesting

    java.lang.String originalNesting

### originalNestingName

    java.lang.String originalNestingName

Class org.apache.struts.taglib.nested.NestedWriteNestingTag implements Serializable

Serialized Fields

### filter

    boolean filter

### property

    java.lang.String property

### originalProperty

    java.lang.String originalProperty

Package org.apache.struts.taglib.nested.logic

Class org.apache.struts.taglib.nested.logic.NestedEmptyTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedEqualTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedGreaterEqualTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedGreaterThanTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedIterateTag implements Serializable

Serialized Fields

### nesting

    java.lang.String nesting

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

### originalNesting

    java.lang.String originalNesting

### originalNestingName

    java.lang.String originalNestingName

Class org.apache.struts.taglib.nested.logic.NestedLessEqualTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedLessThanTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedMatchTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedMessagesNotPresentTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedMessagesPresentTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedNotEmptyTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedNotEqualTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedNotMatchTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedNotPresentTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.logic.NestedPresentTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Package org.apache.struts.taglib.nested.html

Class org.apache.struts.taglib.nested.html.NestedCheckboxTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedErrorsTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedFileTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedFormTag implements Serializable

Serialized Fields

### originalNesting

    java.lang.String originalNesting

### originalNestingName

    java.lang.String originalNestingName

Class org.apache.struts.taglib.nested.html.NestedHiddenTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedImageTag implements Serializable

Serialized Fields

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedImgTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedLinkTag implements Serializable

Serialized Fields

### origName

    java.lang.String origName

### origProperty

    java.lang.String origProperty

### origParamProperty

    java.lang.String origParamProperty

Class org.apache.struts.taglib.nested.html.NestedMessagesTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedMultiboxTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedOptionsCollectionTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedOptionsTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

### originalLabelProperty

    java.lang.String originalLabelProperty

Class org.apache.struts.taglib.nested.html.NestedPasswordTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedRadioTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedSelectTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedSubmitTag implements Serializable

Serialized Fields

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedTextareaTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.html.NestedTextTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Package org.apache.struts.taglib.nested.bean

Class org.apache.struts.taglib.nested.bean.NestedDefineTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.bean.NestedMessageTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.bean.NestedSizeTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Class org.apache.struts.taglib.nested.bean.NestedWriteTag implements Serializable

Serialized Fields

### originalName

    java.lang.String originalName

### originalProperty

    java.lang.String originalProperty

Package org.apache.struts.taglib.logic

Class org.apache.struts.taglib.logic.CompareTagBase implements Serializable

Serialized Fields

### value

    java.lang.String value

  The value to which the variable specified by other attributes of this tag will be compared.

Class org.apache.struts.taglib.logic.ConditionalTagBase implements Serializable

Serialized Fields

### cookie

    java.lang.String cookie

  The name of the cookie to be used as a variable.

### header

    java.lang.String header

  The name of the HTTP request header to be used as a variable.

### name

    java.lang.String name

  The name of the JSP bean to be used as a variable (if `property` is not specified), or whose property is to be accessed (if `property` is specified).

### parameter

    java.lang.String parameter

  The name of the HTTP request parameter to be used as a variable.

### property

    java.lang.String property

  The name of the bean property to be used as a variable.

### role

    java.lang.String role

  The name of the security role to be checked for.

### scope

    java.lang.String scope

  The scope to search for the bean named by the name property, or "any scope" if null.

### user

    java.lang.String user

  The user principal name to be checked for.

Class org.apache.struts.taglib.logic.EmptyTag implements Serializable

Class org.apache.struts.taglib.logic.EqualTag implements Serializable

Class org.apache.struts.taglib.logic.ForwardTag implements Serializable

Serialized Fields

### name

    java.lang.String name

  The logical name of the `ActionForward` entry to be looked up.

Class org.apache.struts.taglib.logic.GreaterEqualTag implements Serializable

Class org.apache.struts.taglib.logic.GreaterThanTag implements Serializable

Class org.apache.struts.taglib.logic.IterateTag implements Serializable

Serialized Fields

### iterator

    java.util.Iterator iterator

  Iterator of the elements of this collection, while we are actually running.

### lengthCount

    int lengthCount

  The number of elements we have already rendered.

### lengthValue

    int lengthValue

  The actual length value (calculated in the start tag).

### offsetValue

    int offsetValue

  The actual offset value (calculated in the start tag).

### started

    boolean started

  Has this tag instance been started?

### collection

    java.lang.Object collection

  The collection over which we will be iterating.

### id

    java.lang.String id

  The name of the scripting variable to be exposed.

### indexId

    java.lang.String indexId

  The name of the scripting variable to be exposed as the current index.

### length

    java.lang.String length

  The length value or attribute name (<=0 means no limit).

### name

    java.lang.String name

  The name of the collection or owning bean.

### offset

    java.lang.String offset

  The starting offset (zero relative).

### property

    java.lang.String property

  The property name containing the collection.

### scope

    java.lang.String scope

  The scope of the bean specified by the name property, if any.

### type

    java.lang.String type

  The Java class of each exposed element of the collection.

Class org.apache.struts.taglib.logic.LessEqualTag implements Serializable

Class org.apache.struts.taglib.logic.LessThanTag implements Serializable

Class org.apache.struts.taglib.logic.MatchTag implements Serializable

Serialized Fields

### location

    java.lang.String location

  The location where the match must exist (`start` or `end`), or `null` for anywhere.

### value

    java.lang.String value

  The value to which the variable specified by other attributes of this tag will be matched.

Class org.apache.struts.taglib.logic.MessagesNotPresentTag implements Serializable

Class org.apache.struts.taglib.logic.MessagesPresentTag implements Serializable

Serialized Fields

### message

    java.lang.String message

  If this is set to 'true', then the `Globals.MESSAGE_KEY` will be used to retrieve the messages from scope.

Class org.apache.struts.taglib.logic.NotEmptyTag implements Serializable

Class org.apache.struts.taglib.logic.NotEqualTag implements Serializable

Class org.apache.struts.taglib.logic.NotMatchTag implements Serializable

Class org.apache.struts.taglib.logic.NotPresentTag implements Serializable

Class org.apache.struts.taglib.logic.PresentTag implements Serializable

Class org.apache.struts.taglib.logic.RedirectTag implements Serializable

Serialized Fields

### anchor

    java.lang.String anchor

  The anchor to be added to the end of the generated hyperlink.

### forward

    java.lang.String forward

  The logical forward name from which to retrieve the redirect URI.

### href

    java.lang.String href

  The redirect URI.

### name

    java.lang.String name

  The JSP bean name for query parameters.

### page

    java.lang.String page

  The module-relative page URL (beginning with a slash) to which this redirect will be rendered.

### paramId

    java.lang.String paramId

  The single-parameter request parameter name to generate.

### paramName

    java.lang.String paramName

  The single-parameter JSP bean name.

### paramProperty

    java.lang.String paramProperty

  The single-parameter JSP bean property.

### paramScope

    java.lang.String paramScope

  The single-parameter JSP bean scope.

### property

    java.lang.String property

  The JSP bean property name for query parameters.

### scope

    java.lang.String scope

  The scope of the bean specified by the name property, if any.

### transaction

    boolean transaction

  Include our transaction control token?

Package org.apache.struts.taglib.html

Class org.apache.struts.taglib.html.BaseFieldTag implements Serializable

Serialized Fields

### accept

    java.lang.String accept

  Comma-delimited list of content types that a server processing this form will handle correctly. This property is defined only for the `file` tag, but is implemented here because it affects the rendered HTML of the corresponding <input> tag.

### name

    java.lang.String name

  The name of the bean containing our underlying property.

### redisplay

    boolean redisplay

  The "redisplay contents" flag (used only on `password`).

### type

    java.lang.String type

  The type of input field represented by this tag (text, password, or hidden).

Class org.apache.struts.taglib.html.BaseHandlerTag implements Serializable

Serialized Fields

### accesskey

    java.lang.String accesskey

  Access key character.

### tabindex

    java.lang.String tabindex

  Tab index value.

### indexed

    boolean indexed

  Whether to created indexed names for fields

  Since:
    Struts 1.1

### onclick

    java.lang.String onclick

  Mouse click event.

### ondblclick

    java.lang.String ondblclick

  Mouse double click event.

### onmouseover

    java.lang.String onmouseover

  Mouse over component event.

### onmouseout

    java.lang.String onmouseout

  Mouse exit component event.

### onmousemove

    java.lang.String onmousemove

  Mouse moved over component event.

### onmousedown

    java.lang.String onmousedown

  Mouse pressed on component event.

### onmouseup

    java.lang.String onmouseup

  Mouse released on component event.

### onkeydown

    java.lang.String onkeydown

  Key down in component event.

### onkeyup

    java.lang.String onkeyup

  Key released in component event.

### onkeypress

    java.lang.String onkeypress

  Key down and up together in component event.

### onselect

    java.lang.String onselect

  Text selected in component event.

### onchange

    java.lang.String onchange

  Content changed after component lost focus event.

### onblur

    java.lang.String onblur

  Component lost focus event.

### onfocus

    java.lang.String onfocus

  Component has received focus event.

### disabled

    boolean disabled

  Component is disabled.

### readonly

    boolean readonly

  Component is readonly.

### style

    java.lang.String style

  Style attribute associated with component.

### styleClass

    java.lang.String styleClass

  Named Style class associated with component.

### styleId

    java.lang.String styleId

  Identifier associated with component.

### alt

    java.lang.String alt

  The alternate text of this element.

### altKey

    java.lang.String altKey

  The message resources key of the alternate text.

### bundle

    java.lang.String bundle

  The name of the message resources bundle for message lookups.

### locale

    java.lang.String locale

  The name of the session attribute key for our locale.

### title

    java.lang.String title

  The advisory title of this element.

### titleKey

    java.lang.String titleKey

  The message resources key of the advisory title.

### loopTagSupportClass

    java.lang.Class loopTagSupportClass

### loopTagSupportGetStatus

    java.lang.reflect.Method loopTagSupportGetStatus

### loopTagStatusClass

    java.lang.Class loopTagStatusClass

### loopTagStatusGetIndex

    java.lang.reflect.Method loopTagStatusGetIndex

### triedJstlInit

    boolean triedJstlInit

### triedJstlSuccess

    boolean triedJstlSuccess

Class org.apache.struts.taglib.html.BaseInputTag implements Serializable

Serialized Fields

### cols

    java.lang.String cols

  The number of character columns for this field, or negative for no limit.

### maxlength

    java.lang.String maxlength

  The maximum number of characters allowed, or negative for no limit.

### property

    java.lang.String property

  The name of the field (and associated property) being processed.

### rows

    java.lang.String rows

  The number of rows for this field, or negative for no limit.

### value

    java.lang.String value

  The value for this field, or `null` to retrieve the corresponding property from our associated bean.

Class org.apache.struts.taglib.html.BaseTag implements Serializable

Serialized Fields

### server

    java.lang.String server

  The server name to use instead of request.getServerName().

### target

    java.lang.String target

  The target window for this base reference.

Class org.apache.struts.taglib.html.ButtonTag implements Serializable

Serialized Fields

### property

    java.lang.String property

  The property name of the generated button.

### text

    java.lang.String text

  The body content of this tag (if any).

### value

    java.lang.String value

  The value of the button label.

Class org.apache.struts.taglib.html.CancelTag implements Serializable

Serialized Fields

### property

    java.lang.String property

  The property name of the generated button.

### text

    java.lang.String text

  The body content of this tag (if any).

### value

    java.lang.String value

  The value of the button label.

Class org.apache.struts.taglib.html.CheckboxTag implements Serializable

Serialized Fields

### name

    java.lang.String name

  The name of the bean containing our underlying property.

### property

    java.lang.String property

  The property name for this field.

### text

    java.lang.String text

  The body content of this tag (if any).

### value

    java.lang.String value

  The server value for this option.

Class org.apache.struts.taglib.html.ErrorsTag implements Serializable

Serialized Fields

### bundle

    java.lang.String bundle

  The servlet context attribute key for our resources.

### locale

    java.lang.String locale

  The session attribute key for our locale.

### name

    java.lang.String name

  The request attribute key for our error messages (if any).

### property

    java.lang.String property

  The name of the property for which error messages should be returned, or `null` to return all errors.

Class org.apache.struts.taglib.html.FileTag implements Serializable

Class org.apache.struts.taglib.html.FormTag implements Serializable

Serialized Fields

### action

    java.lang.String action

  The action URL to which this form should be submitted, if any.

### moduleConfig

    ModuleConfig moduleConfig

  The module configuration for our module.

### enctype

    java.lang.String enctype

  The content encoding to be used on a POST submit.

### focus

    java.lang.String focus

  The name of the field to receive focus, if any.

### focusIndex

    java.lang.String focusIndex

  The index in the focus field array to receive focus. This only applies if the field given in the focus attribute is actually an array of fields. This allows a specific field in a radio button array to receive focus while still allowing indexed field names like "myRadioButtonField[1]" to be passed in the focus attribute.

  Since:
    Struts 1.1

### mapping

    ActionMapping mapping

  The ActionMapping defining where we will be submitting this form

### method

    java.lang.String method

  The request method used when submitting this form.

### name

    java.lang.String name

  The attribute key under which our associated bean is stored.

### onreset

    java.lang.String onreset

  The onReset event script.

### onsubmit

    java.lang.String onsubmit

  The onSubmit event script.

### scope

    java.lang.String scope

  The scope (request or session) under which our associated bean is stored.

### servlet

    ActionServlet servlet

  The ActionServlet instance we are associated with (so that we can initialize the `servlet` property on any form bean that we create).

### style

    java.lang.String style

  The style attribute associated with this tag.

### styleClass

    java.lang.String styleClass

  The style class associated with this tag.

### styleId

    java.lang.String styleId

  The identifier associated with this tag.

### target

    java.lang.String target

  The window target.

### type

    java.lang.String type

  The Java class name of the bean to be created, if necessary.

### beanName

    java.lang.String beanName

  The name of the form bean to (create and) use. This is either the same as the 'name' attribute, if that was specified, or is obtained from the associated `ActionMapping` otherwise.

### beanScope

    java.lang.String beanScope

  The scope of the form bean to (create and) use. This is either the same as the 'scope' attribute, if that was specified, or is obtained from the associated `ActionMapping` otherwise.

### beanType

    java.lang.String beanType

  The type of the form bean to (create and) use. This is either the same as the 'type' attribute, if that was specified, or is obtained from the associated `ActionMapping` otherwise.

Class org.apache.struts.taglib.html.FrameTag implements Serializable

Serialized Fields

### frameborder

    java.lang.String frameborder

  The frameborder attribute that should be rendered (1, 0).

### frameName

    java.lang.String frameName

  The `name` attribute that should be rendered for this frame.

### longdesc

    java.lang.String longdesc

  URI of a long description of this frame (complements title).

### marginheight

    int marginheight

  The margin height in pixels, or zero for no setting.

### marginwidth

    int marginwidth

  The margin width in pixels, or zero for no setting.

### noresize

    boolean noresize

  Should users be disallowed to resize the frame?

### scrolling

    java.lang.String scrolling

  What type of scrolling should be supported (yes, no, auto)?

Class org.apache.struts.taglib.html.HiddenTag implements Serializable

Serialized Fields

### write

    boolean write

  Should the value of this field also be rendered to the response?

Class org.apache.struts.taglib.html.HtmlTag implements Serializable

Serialized Fields

### locale

    boolean locale

  Should we set the current Locale for this user if needed?

### xhtml

    boolean xhtml

  Are we rendering an xhtml page?

Class org.apache.struts.taglib.html.ImageTag implements Serializable

Serialized Fields

### align

    java.lang.String align

  The alignment for this image.

### border

    java.lang.String border

  The border size around the image.

### page

    java.lang.String page

  The module-relative URI of the image.

### pageKey

    java.lang.String pageKey

  The message resources key of the module-relative URI of the image.

### property

    java.lang.String property

  The name attribute for the image button.

### src

    java.lang.String src

  The URL of this image.

### srcKey

    java.lang.String srcKey

  The message resources key for the URL of this image.

Class org.apache.struts.taglib.html.ImgTag implements Serializable

Serialized Fields

### align

    java.lang.String align

  The property to specify where to align the image.

### border

    java.lang.String border

  The border size around the image.

### height

    java.lang.String height

  The image height.

### hspace

    java.lang.String hspace

  The horizontal spacing around the image.

### imageName

    java.lang.String imageName

  The image name for named images.

### ismap

    java.lang.String ismap

  Server-side image map declaration.

### lowsrc

    java.lang.String lowsrc

  Deprecated. This is not defined in the HTML 4.01 spec and will be removed in a future version of Struts.

  The low resolution image source URI.

### name

    java.lang.String name

  The JSP bean name for query parameters.

### page

    java.lang.String page

  The module-relative path, starting with a slash character, of the image to be displayed by this rendered tag.

### pageKey

    java.lang.String pageKey

  The message resources key under which we should look up the `page` attribute for this generated tag, if any.

### paramId

    java.lang.String paramId

  In situations where an image is dynamically generated (such as to create a chart graph), this specifies the single-parameter request parameter name to generate.

### paramName

    java.lang.String paramName

  The single-parameter JSP bean name.

### paramProperty

    java.lang.String paramProperty

  The single-parameter JSP bean property.

### paramScope

    java.lang.String paramScope

  The single-parameter JSP bean scope.

### property

    java.lang.String property

  The JSP bean property name for query parameters.

### scope

    java.lang.String scope

  The scope of the bean specified by the name property, if any.

### src

    java.lang.String src

  The image source URI.

### srcKey

    java.lang.String srcKey

  The message resources key under which we should look up the `src` attribute for this generated tag, if any.

### usemap

    java.lang.String usemap

  Client-side image map declaration.

### vspace

    java.lang.String vspace

  The vertical spacing around the image.

### width

    java.lang.String width

  The image width.

Class org.apache.struts.taglib.html.JavascriptValidatorTag implements Serializable

Serialized Fields

### bundle

    java.lang.String bundle

  The servlet context attribute key for our resources.

### formName

    java.lang.String formName

  The name of the form that corresponds with the action name in struts-config.xml. Specifying a form name places a <script> </script> around the javascript.

### page

    int page

  The current page number of a multi-part form. Only valid when the formName attribute is set.

### methodName

    java.lang.String methodName

  This will be used as is for the JavaScript validation method name if it has a value. This is the method name of the main JavaScript method that the form calls to perform validations.

### staticJavascript

    java.lang.String staticJavascript

  The static JavaScript methods will only be printed if this is set to "true".

### dynamicJavascript

    java.lang.String dynamicJavascript

  The dynamic JavaScript objects will only be generated if this is set to "true".

### src

    java.lang.String src

  The src attribute for html script element (used to include an external script resource). The src attribute is only recognized when the formName attribute is specified.

### htmlComment

    java.lang.String htmlComment

  The JavaScript methods will enclosed with html comments if this is set to "true".

### cdata

    java.lang.String cdata

  Hide JavaScript methods in a CDATA section for XHTML when "true".

### htmlBeginComment

    java.lang.String htmlBeginComment

### htmlEndComment

    java.lang.String htmlEndComment

Class org.apache.struts.taglib.html.LinkTag implements Serializable

Serialized Fields

### text

    java.lang.String text

  The body content of this tag (if any).

### anchor

    java.lang.String anchor

  The anchor to be added to the end of the generated hyperlink.

### forward

    java.lang.String forward

  The logical forward name from which to retrieve the hyperlink URI.

### href

    java.lang.String href

  The hyperlink URI.

### linkName

    java.lang.String linkName

  The link name for named links.

### name

    java.lang.String name

  The JSP bean name for query parameters.

### page

    java.lang.String page

  The module-relative page URL (beginning with a slash) to which this hyperlink will be rendered.

### action

    java.lang.String action

  The module-relative action (beginning with a slash) which will be called by this link

### paramId

    java.lang.String paramId

  The single-parameter request parameter name to generate.

### paramName

    java.lang.String paramName

  The single-parameter JSP bean name.

### paramProperty

    java.lang.String paramProperty

  The single-parameter JSP bean property.

### paramScope

    java.lang.String paramScope

  The single-parameter JSP bean scope.

### property

    java.lang.String property

  The JSP bean property name for query parameters.

### scope

    java.lang.String scope

  The scope of the bean specified by the name property, if any.

### target

    java.lang.String target

  The window target.

### transaction

    boolean transaction

  Include transaction token (if any) in the hyperlink?

### indexId

    java.lang.String indexId

  Name of parameter to generate to hold index number

Class org.apache.struts.taglib.html.MessagesTag implements Serializable

Serialized Fields

### iterator

    java.util.Iterator iterator

  Iterator of the elements of this error collection, while we are actually running.

### processed

    boolean processed

  Whether or not any error messages have been processed.

### id

    java.lang.String id

  The name of the scripting variable to be exposed.

### bundle

    java.lang.String bundle

  The servlet context attribute key for our resources.

### locale

    java.lang.String locale

  The session attribute key for our locale.

### name

    java.lang.String name

  The request attribute key for our error messages (if any).

### property

    java.lang.String property

  The name of the property for which error messages should be returned, or `null` to return all errors.

### header

    java.lang.String header

  The message resource key for errors header.

### footer

    java.lang.String footer

  The message resource key for errors footer.

### message

    java.lang.String message

  If this is set to 'true', then the `Globals.MESSAGE_KEY` will be used to retrieve the messages from scope.

Class org.apache.struts.taglib.html.MultiboxTag implements Serializable

Serialized Fields

### constant

    java.lang.String constant

  The constant String value to be returned when this checkbox is selected and the form is submitted.

### name

    java.lang.String name

  The name of the bean containing our underlying property.

### property

    java.lang.String property

  The property name for this field.

### value

    java.lang.String value

  The value which will mark this checkbox as "checked" if present in the array returned by our property getter.

Class org.apache.struts.taglib.html.OptionsCollectionTag implements Serializable

Serialized Fields

### filter

    boolean filter

  Should the label values be filtered for HTML sensitive characters?

### label

    java.lang.String label

  The name of the bean property containing the label.

### name

    java.lang.String name

  The name of the bean containing the values collection.

### property

    java.lang.String property

  The name of the property to use to build the values collection.

### style

    java.lang.String style

  The style associated with this tag.

### styleClass

    java.lang.String styleClass

  The named style class associated with this tag.

### value

    java.lang.String value

  The name of the bean property containing the value.

Class org.apache.struts.taglib.html.OptionsTag implements Serializable

Serialized Fields

### collection

    java.lang.String collection

  The name of the collection containing beans that have properties to provide both the values and the labels (identified by the `property` and `labelProperty` attributes).

### filter

    boolean filter

  Should the label values be filtered for HTML sensitive characters?

### labelName

    java.lang.String labelName

  The name of the bean containing the labels collection.

### labelProperty

    java.lang.String labelProperty

  The bean property containing the labels collection.

### name

    java.lang.String name

  The name of the bean containing the values collection.

### property

    java.lang.String property

  The name of the property to use to build the values collection.

### style

    java.lang.String style

  The style associated with this tag.

### styleClass

    java.lang.String styleClass

  The named style class associated with this tag.

Class org.apache.struts.taglib.html.OptionTag implements Serializable

Serialized Fields

### text

    java.lang.String text

  The message text to be displayed to the user for this tag (if any)

### bundle

    java.lang.String bundle

  The name of the servlet context attribute containing our message resources.

### disabled

    boolean disabled

  Is this option disabled?

### key

    java.lang.String key

  The key used to look up the text displayed to the user for this option, if any.

### locale

    java.lang.String locale

  The name of the attribute containing the Locale to be used for looking up internationalized messages.

### style

    java.lang.String style

  The style associated with this tag.

### styleClass

    java.lang.String styleClass

  The named style class associated with this tag.

### styleId

    java.lang.String styleId

  The identifier associated with this tag.

### value

    java.lang.String value

  The server value for this option, also used to match against the current property value to determine whether this option should be marked as selected.

Class org.apache.struts.taglib.html.PasswordTag implements Serializable

Class org.apache.struts.taglib.html.RadioTag implements Serializable

Serialized Fields

### name

    java.lang.String name

  The name of the bean containing our underlying property.

### property

    java.lang.String property

  The property name for this field.

### text

    java.lang.String text

  The body content of this tag (if any).

### value

    java.lang.String value

  The server value for this option.

### idName

    java.lang.String idName

  Name of the bean (in some scope) that will return the value of the radio tag.

  If an iterator is used to render a series of radio tags, this field may be used to specify the name of the bean exposed by the iterator. In this case, the value attribute is used as the name of a property on the `idName` bean that returns the value of the radio tag in this iteration.

Class org.apache.struts.taglib.html.ResetTag implements Serializable

Serialized Fields

### property

    java.lang.String property

  The name of the generated input field.

### text

    java.lang.String text

  The body content of this tag (if any).

### value

    java.lang.String value

  The value of the button label.

Class org.apache.struts.taglib.html.RewriteTag implements Serializable

Class org.apache.struts.taglib.html.SelectTag implements Serializable

Serialized Fields

### match

    java.lang.String[] match

  The actual values we will match against, calculated in doStartTag().

### multiple

    java.lang.String multiple

  Should multiple selections be allowed. Any non-null value will trigger rendering this.

### name

    java.lang.String name

  The name of the bean containing our underlying property.

### property

    java.lang.String property

  The property name we are associated with.

### saveBody

    java.lang.String saveBody

  The saved body content of this tag.

### size

    java.lang.String size

  How many available options should be displayed when this element is rendered?

### value

    java.lang.String value

  The value to compare with for marking an option selected.

Class org.apache.struts.taglib.html.SubmitTag implements Serializable

Serialized Fields

### property

    java.lang.String property

  The name of the generated input field.

### text

    java.lang.String text

  The body content of this tag (if any).

### value

    java.lang.String value

  The value of the button label.

Class org.apache.struts.taglib.html.TextareaTag implements Serializable

Serialized Fields

### name

    java.lang.String name

  The name of the bean containing our underlying property.

Class org.apache.struts.taglib.html.TextTag implements Serializable

Class org.apache.struts.taglib.html.XhtmlTag implements Serializable

Package org.apache.struts.taglib.bean

Class org.apache.struts.taglib.bean.CookieTag implements Serializable

Serialized Fields

### id

    java.lang.String id

  The name of the scripting variable that will be exposed as a page scope attribute.

### multiple

    java.lang.String multiple

  Return an array of Cookies if `multiple` is non-null.

### name

    java.lang.String name

  The name of the cookie whose value is to be exposed.

### value

    java.lang.String value

  The default value to return if no cookie of the specified name is found.

Class org.apache.struts.taglib.bean.DefineTag implements Serializable

Serialized Fields

### body

    java.lang.String body

  The body content of this tag (if any).

### id

    java.lang.String id

  The name of the scripting variable that will be exposed as a page scope attribute.

### name

    java.lang.String name

  The name of the bean owning the property to be exposed.

### property

    java.lang.String property

  The name of the property to be retrieved.

### scope

    java.lang.String scope

  The scope within which to search for the specified bean.

### toScope

    java.lang.String toScope

  The scope within which the newly defined bean will be creatd.

### type

    java.lang.String type

  The fully qualified Java class name of the value to be exposed.

### value

    java.lang.String value

  The (String) value to which the defined bean will be set.

Class org.apache.struts.taglib.bean.HeaderTag implements Serializable

Serialized Fields

### id

    java.lang.String id

  The name of the scripting variable that will be exposed as a page scope attribute.

### multiple

    java.lang.String multiple

  Return an array of header values if `multiple` is non-null.

### name

    java.lang.String name

  The name of the header whose value is to be exposed.

### value

    java.lang.String value

  The default value to return if no header of the specified name is found.

Class org.apache.struts.taglib.bean.IncludeTag implements Serializable

Serialized Fields

### anchor

    java.lang.String anchor

  The anchor to be added to the end of the generated hyperlink.

### forward

    java.lang.String forward

  The name of the global `ActionForward` that contains a path to our requested resource.

### href

    java.lang.String href

  The absolute URL to the resource to be included.

### id

    java.lang.String id

  The name of the scripting variable that will be exposed as a page scope attribute.

### page

    java.lang.String page

  The context-relative URI of the page or servlet to be included.

### transaction

    boolean transaction

  Include transaction token (if any) in the hyperlink?

Class org.apache.struts.taglib.bean.MessageTag implements Serializable

Serialized Fields

### arg0

    java.lang.String arg0

  The first optional argument.

### arg1

    java.lang.String arg1

  The second optional argument.

### arg2

    java.lang.String arg2

  The third optional argument.

### arg3

    java.lang.String arg3

  The fourth optional argument.

### arg4

    java.lang.String arg4

  The fifth optional argument.

### bundle

    java.lang.String bundle

  The servlet context attribute key for our resources.

### key

    java.lang.String key

  The message key of the message to be retrieved.

### name

    java.lang.String name

  Name of the bean that contains the message key.

### property

    java.lang.String property

  Name of the property to be accessed on the specified bean.

### scope

    java.lang.String scope

  The scope to be searched to retrieve the specified bean.

### localeKey

    java.lang.String localeKey

  The session scope key under which our Locale is stored.

Class org.apache.struts.taglib.bean.PageTag implements Serializable

Serialized Fields

### id

    java.lang.String id

  The name of the scripting variable that will be exposed as a page scope attribute.

### property

    java.lang.String property

  The name of the page context property to be retrieved.

Class org.apache.struts.taglib.bean.ParameterTag implements Serializable

Serialized Fields

### id

    java.lang.String id

  The name of the scripting variable that will be exposed as a page scope attribute.

### multiple

    java.lang.String multiple

  Return an array of parameter values if `multiple` is non-null.

### name

    java.lang.String name

  The name of the parameter whose value is to be exposed.

### value

    java.lang.String value

  The default value to return if no parameter of the specified name is found.

Class org.apache.struts.taglib.bean.ResourceTag implements Serializable

Serialized Fields

### id

    java.lang.String id

  The name of the scripting variable that will be exposed as a page scope attribute.

### input

    java.lang.String input

  Return an InputStream to the specified resource if this is non-null.

### name

    java.lang.String name

  The module-relative URI of the resource whose contents are to be exposed.

Class org.apache.struts.taglib.bean.SizeTag implements Serializable

Serialized Fields

### collection

    java.lang.Object collection

  The actual collection to be counted.

### id

    java.lang.String id

  The name of the scripting variable that will be exposed as a page scope attribute.

### name

    java.lang.String name

  The name of the bean owning the property to be counted.

### property

    java.lang.String property

  The name of the property to be retrieved.

### scope

    java.lang.String scope

  The scope within which to search for the specified bean.

Class org.apache.struts.taglib.bean.StrutsTag implements Serializable

Serialized Fields

### id

    java.lang.String id

  The name of the scripting variable that will be exposed as a page scope attribute.

### formBean

    java.lang.String formBean

  The name of the `ActionFormBean` object to be exposed.

### forward

    java.lang.String forward

  The name of the `ActionForward` object to be exposed.

### mapping

    java.lang.String mapping

  The name of the `ActionMapping` object to be exposed.

Class org.apache.struts.taglib.bean.WriteTag implements Serializable

Serialized Fields

### filter

    boolean filter

  Filter the rendered output for characters that are sensitive in HTML?

### ignore

    boolean ignore

  Should we ignore missing beans and simply output nothing?

### name

    java.lang.String name

  Name of the bean that contains the data we will be rendering.

### property

    java.lang.String property

  Name of the property to be accessed on the specified bean.

### scope

    java.lang.String scope

  The scope to be searched to retrieve the specified bean.

### formatStr

    java.lang.String formatStr

  The format string to be used as format to convert value to String.

### formatKey

    java.lang.String formatKey

  The key to search format string in applciation resources

### localeKey

    java.lang.String localeKey

  The session scope key under which our Locale is stored.

### bundle

    java.lang.String bundle

  The servlet context attribute key for our resources.

Package org.apache.struts.config

Class org.apache.struts.config.ActionConfig implements Serializable

Serialized Fields

### configured

    boolean configured

  Indicates if configuration of this component been completed.

### exceptions

    java.util.HashMap exceptions

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

### forwards

    java.util.HashMap forwards

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

### moduleConfig

    ModuleConfig moduleConfig

  The module configuration with which we are associated.

### attribute

    java.lang.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`.

### forward

    java.lang.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.

### include

    java.lang.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.

### input

    java.lang.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.

### multipartClass

    java.lang.String multipartClass

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

### name

    java.lang.String name

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

### parameter

    java.lang.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

    java.lang.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.

### prefix

    java.lang.String prefix

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

### roles

    java.lang.String roles

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

### roleNames

    java.lang.String[] roleNames

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

### scope

    java.lang.String scope

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

### suffix

    java.lang.String suffix

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

### type

    java.lang.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 application, when true.

### validate

    boolean validate

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

Class org.apache.struts.config.ApplicationConfig implements Serializable

Class org.apache.struts.config.ControllerConfig implements Serializable

Serialized Fields

### configured

    boolean configured

  Has this component been completely configured?

### bufferSize

    int bufferSize

  The input buffer size for file uploads.

### contentType

    java.lang.String contentType

  The content type and character encoding to be set on each response.

### debug

    int debug

  Deprecated. Configure the logging detail level in your underlying logging implemenation

  The debugging detail level that determines logging verbosity.

### forwardPattern

    java.lang.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

    java.lang.String maxFileSize

  The maximum file size to process for file uploads.

### memFileSize

    java.lang.String memFileSize

  The maximum file size to retain in memory.

### multipartClass

    java.lang.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

    java.lang.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

    java.lang.String processorClass

  The fully qualified class name of the RequestProcessor implementation class to be used for this module.

### tempDir

    java.lang.String tempDir

  The temporary working directory to use for file uploads.

Class org.apache.struts.config.DataSourceConfig implements Serializable

Serialized Fields

### configured

    boolean configured

  Has this component been completely configured?

### key

    java.lang.String key

  The servlet context attribute key under which this data source is stored and made available.

### properties

    java.util.HashMap properties

  The custom configuration properties for this data source implementation.

### type

    java.lang.String type

  The fully qualified class name of the `javax.sql.DataSource` implementation class.

Class org.apache.struts.config.ExceptionConfig implements Serializable

Serialized Fields

### configured

    boolean configured

  Has this component been completely configured?

### bundle

    java.lang.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.

### handler

    java.lang.String handler

  The fully qualified Java class name of the exception handler class which should be instantiated to handle this exception.

### key

    java.lang.String key

  The message resources key specifying the error message associated with this exception.

### path

    java.lang.String path

  The module-relative path of the resource to forward to if this exception occurs during an `Action`.

### scope

    java.lang.String scope

  The scope in which we should expose the ActionError for this exception handler.

### type

    java.lang.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 implements Serializable

Serialized Fields

### configured

    boolean configured

  Has this component been completely configured?

### formProperties

    java.util.HashMap formProperties

  The set of FormProperty elements defining dynamic form properties for this form bean, keyed by property name.

### dynamic

    boolean dynamic

  Is the form bean class an instance of DynaActionForm with dynamic properties?

### moduleConfig

    ModuleConfig moduleConfig

  The `ModuleConfig` with which this form bean definition is associated.

### name

    java.lang.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.

### type

    java.lang.String type

  The fully qualified Java class name of the implementation class to be used or generated.

Class org.apache.struts.config.FormPropertyConfig implements Serializable

Serialized Fields

### configured

    boolean configured

  Has this component been completely configured?

### initial

    java.lang.String initial

  String representation of the initial value for this property.

### name

    java.lang.String name

  The JavaBean property name of the property described by this element.

### 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

    java.lang.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 implements Serializable

Serialized Fields

### configured

    boolean configured

  Has this component been completely configured?

### contextRelative

    boolean contextRelative

  Should the value of the `path` property be considered context-relative if it starts with a slash (and therefore not prefixed with the module prefix?

### name

    java.lang.String name

  The unique identifier of this forward, which is used to reference it in `Action` classes.

### path

    java.lang.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 implements Serializable

Serialized Fields

### configured

    boolean configured

  Has this component been completely configured?

### factory

    java.lang.String factory

  Fully qualified Java class name of the MessageResourcesFactory class we should use.

### key

    java.lang.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

    java.lang.String parameter

  Parameter that is passed to the `createResources()` method of our MessageResourcesFactory implementation.

Class org.apache.struts.config.PlugInConfig implements Serializable

Serialized Fields

### configured

    boolean configured

  Has this component been completely configured?

### properties

    java.util.Map properties

  A `Map` of the name-value pairs that will be used to configure the property values of a `PlugIn` instance.

### className

    java.lang.String className

  The fully qualified Java class name of the `PlugIn` implementation class being configured.

Package org.apache.struts.config.impl

Class org.apache.struts.config.impl.DefaultModuleConfigFactory implements Serializable

Class org.apache.struts.config.impl.ModuleConfigImpl implements Serializable

Serialized Fields

### actionConfigs

    java.util.HashMap actionConfigs

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

### dataSources

    java.util.HashMap dataSources

  The set of JDBC data source configurations for this module, if any, keyed by the `key` property.

### exceptions

    java.util.HashMap exceptions

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

### formBeans

    java.util.HashMap formBeans

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

### forwards

    java.util.HashMap forwards

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

### messageResources

    java.util.HashMap messageResources

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

### plugIns

    java.util.ArrayList plugIns

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

### configured

    boolean configured

  Has this module been completely configured yet. Once this flag has been set, any attempt to modify the configuration will return an IllegalStateException.

### controllerConfig

    ControllerConfig controllerConfig

  The controller configuration object for this module.

### prefix

    java.lang.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.

### actionMappingClass

    java.lang.String actionMappingClass

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

Package org.apache.struts.action

Class org.apache.struts.action.ActionError implements Serializable

Class org.apache.struts.action.ActionErrors implements Serializable

Class org.apache.struts.action.ActionException implements Serializable

Class org.apache.struts.action.ActionForm implements Serializable

Class org.apache.struts.action.ActionFormBean implements Serializable

Class org.apache.struts.action.ActionFormBeans implements Serializable

Serialized Fields

### formBeans

    org.apache.commons.collections.FastHashMap formBeans

  Deprecated.
  The collection of ActionFormBean instances, keyed by name.

Class org.apache.struts.action.ActionForward implements Serializable

Class org.apache.struts.action.ActionForwards implements Serializable

Serialized Fields

### forwards

    org.apache.commons.collections.FastHashMap forwards

  Deprecated.
  The collection of ActionForward instances, keyed by logical name.

Class org.apache.struts.action.ActionMapping implements Serializable

Class org.apache.struts.action.ActionMappings implements Serializable

Serialized Fields

### mappings

    org.apache.commons.collections.FastHashMap mappings

  Deprecated.
  The collection of ActionMapping instances, keyed by request path.

### unknown

    ActionMapping unknown

  Deprecated.
  The ActionMapping that should handle unknown request paths, if any.

Class org.apache.struts.action.ActionMessage implements Serializable

Serialized Fields

### key

    java.lang.String key

  The message key for this message.

### values

    java.lang.Object[] values

  The replacement values for this mesasge.

Class org.apache.struts.action.ActionMessages implements Serializable

Serialized Fields

### messages

    java.util.HashMap messages

  The accumulated set of `ActionMessage` objects (represented as an ArrayList) for each property, keyed by property name.

### iCount

    int iCount

  The current number of the property/key being added. This is used to maintain the order messages are added.

Class org.apache.struts.action.ActionMessages.ActionMessageItem implements Serializable

Serialized Fields

### list

    java.util.List list

  The list of `ActionMessage`s.

### iOrder

    int iOrder

  The position in the list of messages.

Class org.apache.struts.action.ActionServlet implements Serializable

Serialized Fields

### config

    java.lang.String config

  Comma-separated list of context-relative path(s) to our configuration resource(s) for the default module.

### configDigester

    org.apache.commons.digester.Digester configDigester

  The Digester used to produce ModuleConfig objects from a Struts configuration file.

  Since:
    Struts 1.1

### convertNull

    boolean convertNull

  The flag to request backwards-compatible conversions for form bean properties of the Java wrapper class types.

  Since:
    Struts 1.1

### dataSources

    org.apache.commons.collections.FastHashMap dataSources

  The JDBC data sources that has been configured for this module, if any, keyed by the servlet context attribute under which they are stored.

### debug

    int debug

  Deprecated.

  The debugging detail level for this servlet.

### internal

    MessageResources internal

  The resources object for our internal resources.

### internalName

    java.lang.String internalName

  The Java base name of our internal resources.

  Since:
    Struts 1.1

### processor

    RequestProcessor processor

  The `RequestProcessor` instance we will use to process all incoming requests.

  Since:
    Struts 1.1

### registrations

    java.lang.String[] registrations

  The set of public identifiers, and corresponding resource names, for the versions of the configuration file DTDs that we know about. There MUST be an even number of Strings in this list!

### servletMapping

    java.lang.String servletMapping

  The URL pattern to which we are mapped in our web application deployment descriptor. FIXME - multiples???

### servletName

    java.lang.String servletName

  The servlet name under which we are registered in our web application deployment descriptor.

Class org.apache.struts.action.DynaActionForm implements Serializable

Serialized Fields

### dynaClass

    DynaActionFormClass dynaClass

  The DynaActionFormClass with which we are associated.

### dynaValues

    java.util.HashMap dynaValues

  The set of property values for this DynaActionForm, keyed by property name.

Class org.apache.struts.action.DynaActionFormClass implements Serializable

Serialized Fields

### config

    FormBeanConfig config

  The form bean configuration information for this class.

### name

    java.lang.String name

  The "dynamic class name" for this `DynaClass`.

### properties

    org.apache.commons.beanutils.DynaProperty[] properties

  The set of dynamic properties that are part of this DynaClass.

### propertiesMap

    java.util.HashMap propertiesMap

  The set of dynamic properties that are part of this DynaClass, keyed by the property name. Individual descriptor instances will be the same instances as those in the `properties` list.

Class org.apache.struts.action.ForwardingActionForward implements Serializable

Class org.apache.struts.action.RedirectingActionForward implements Serializable

Class org.apache.struts.action.RequestActionMapping implements Serializable

Class org.apache.struts.action.SessionActionMapping implements Serializable

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

Copyright © 2000-2003 - Apache Software Foundation