@axis Tag Reference

Tags for declaration of Apache Axis services

Applies to: POJO

@axis Class Level Tags

@axis.service

@axis Method Level Tags

@axis.method

@axis Field Level Tags

@axis Class Level Tag Usage

@axis.service (0..1)

Declares the class an Axis SOAP service.

Applies to: POJO

ParameterTypeApplicabilityDescriptionMandatory
nametextDefine the service's name.true
scopetextDefine the service scope.
Valid options are:

Request

Session

Application

Default value(s):

Application
true
providertext Specifies the provider type.

Default value(s):

"java:EJB" for EJBs, "java:RPC" for non-EJBs.
Valid options are:

java:RPC

java:MSG

java:EJB
false
include-allbool If set to true, all methods will be exposed, without regard to whether or not they are tagged with @axis.method.

Default value(s):

false
false

@axis Method Level Tag Usage

@axis.method (0..1)

Declares the method a SOAP service method. Does not have any parameters. Note: By default "create" methods of session bean is used, no need to explicitly specify a method as axis.method.

Applies to: Method level

@axis Field Level Tag Usage

@soap Tag Reference

Tags for declaration of Apache SOAP services

Applies to: POJO

@soap Class Level Tags

@soap.service

@soap Method Level Tags

@soap.method

@soap Field Level Tags

@soap Class Level Tag Usage

@soap.service (0..1)

Declares the class a SOAP service.

Applies to: POJO

ParameterTypeApplicabilityDescriptionMandatory
scopetextDefine the service scope.
Valid options are:

Page

Request

Session

Application

Default value(s):

Page
true
providertext Specifies the provider class name. There's special support for EJB beans, so if you do not specify the provider parameter, Apache Soap tries to assign the correct provider name to the service based on the type of the EJB bean. The provider name for the EJB is taken from statelessSessionEjbProvider or statefulSessionEjbProvider or entityEjbProvider configuration parameters based on the EJBean type. false
urntext The URN for the service. false
typetext Sets the service type. The only valid value is "message".
Valid options are:

message
false
checkMustUnderstandsbool Declares whether or not the server is to throw a Fault if there are SOAP headers in the request which are marked as "MustUnderstand". false

@soap Method Level Tag Usage

@soap.method (0..1)

Declares the method a SOAP service method. Does not have any parameters. Note: By default "create" methods of session bean is used, no need to explicitly specify a method as soap.method. All methods declared in remote interface of an EJB are automatically exposed to SOAP clients by default.

Applies to: Method level

@soap Field Level Tag Usage

@struts Tag Reference

Defines a form bean and its attributes.

Applies to: Applicable to pojos (i.e. Hibernate objects), entity beans and struts actions

@struts Field Level Tags

@struts Class Level Tag Usage

@struts.action (0..*)

Defines the action class and its attributes

Applies to: Struts Action

ParameterTypeApplicabilityDescriptionMandatory
nametextThe name of the action. Must be unique within the bounds of the Struts applicationtrue
typetext The class to instantiate for this action. Defaults to the current class, but can be overridden for certain uses, such as integration with Spring. false
pathtextThe path that the action will match.true
scopetextDefine the scope of the action. "request" | "session" | "application"
Valid options are:

request

session

application

Default value(s):

request
true
inputtextThe path to the input for the Actiontrue
rolestextComma-delimited list of security role names that are allowed access to this ActionMapping object. Since Struts 1.1.false
validatetextThe validation flag for the action

Default value(s):

true
true
parametertextThe optional parameter for the actiontrue

@struts.action-exception (0..*)

Defines the action specific exception handling

Applies to: Struts Action

ParameterTypeApplicabilityDescriptionMandatory
keytext The key to use with this handler's message resource bundle that will retrieve the error message template for this exception. true
typetext Fully qualified Java class name of the exception type to register with this handler. true
classNametext The configuration bean for this ExceptionHandler object. If specified, className must be a subclass of the default configuration bean. false
handlertext Fully qualified Java class name for this exception handler. false
pathtext The module-relative URI to the resource that will complete the request/response if this exception occurs. false
scopetext The context ("request" or "session") that is used to access the ActionError object [org.apache.struts.action.ActionError] for this exception. false

@struts.action-forward (0..*)

Defines local forwards for a Struts action class

Applies to: Struts Action

ParameterTypeApplicabilityDescriptionMandatory
nametextThe name of the forwardtrue
pathtextThe path of the forwardtrue
redirectbool Whether the browser should be redirected to the specified location. false

@struts.action-set-property (0..*)

Creates set-property tags for action blocks

Applies to: Struts Action

ParameterTypeApplicabilityDescriptionMandatory
propertytextThe name of the property to settrue
valuetextThe value to set the propertytrue

@struts.dynaform (0..*)

Defines a dynamic form bean and its attributes.

ParameterTypeApplicabilityDescriptionMandatory
nametextDefine a unique name for the form.true
typetextDefine the class type of dynamic form.true
validatetextDeclare if this form should be validated. If set to true, the dynamic form validation tag will iterate over this class and create the validation definition.false

@struts.form (0..*)

Defines a form bean and its attributes.

Applies to: Entity beans and POJOs

ParameterTypeApplicabilityDescriptionMandatory
nametextDefine a unique name for the form. If generating a form using this tag, this attribute is not necessary. The className+Form will be used (i.e. Address -> addressForm).true
extendstextDefine which class the generated form must extend.false
implementstextDefine which interface the generated form must implement.false
include-pkbool Whether to include pk field in form. Default is true. If set to false, individual pk fields can still be included.

Default value(s):

true
false
include-allboolWhether to include all persistent fields in form. Default is false.

Default value(s):

true
false

@struts Method Level Tag Usage

@struts.dynaform-field (0..*)

Include property in specific struts form

Applies to: property to be included

ParameterTypeApplicabilityDescriptionMandatory
nametextThe name of the JavaBean property described by this element. Declare, if you want to override the generated property name. Default is the method's name converted to a property namefalse
typetextFully qualified Java class name of the field underlying this property, optionally followed by "[]" to indicate that the field is indexed. Declare, if you want to override the generated property type. Default is the method's return type.false
initialtextString representation of the initial value for this property. If not specified, primitives will be initialized to zero and objects initialized to the zero-argument instantiation of that object class. For example, Strings will be initialized to ""false
sizetextThe number of array elements to create if the value of the "type" attribute specifies an array, but there is no value specified for the "initial" attribute.false

@struts.form-field (0..*)

Include property in specific struts form

Applies to: property to be included

ParameterTypeApplicabilityDescriptionMandatory
form-nametextSpecify the name of the form this field should belong to. Required if "name" defined on @struts.form.false

@struts.validator (0..*)

Defines Struts Validator for current setter field. NOTE: If you're generating forms from POJOs, this tag needs to be on the getter. It will be put on the setter in the generated Form.

Applies to: Struts ValidatorForm

ParameterTypeApplicabilityDescriptionMandatory
typetextValidator type, such as "required"true
msgkeytextOverride key for the validator error messagefalse
msgvaluetextExplicitly define a validator error messagefalse
pagetextOnly fields with a "page" attribute value that is equal to or less than the page property on the form JavaBean are processed.false
arg0valuetextValue of argument index 0false
arg0resourcetextResource key of argument index 0false
arg1valuetextValue of argument index 1false
arg1resourcetextResource key of argument index 1false
arg2valuetextValue of argument index 2false
arg2resourcetextResource key of argument index 2false
arg3valuetextValue of argument index 3false
arg3resourcetextResource key of argument index 3false

@struts.validator-args (0..1)

Defines arguments for current setter field.

Applies to: Struts ValidatorForm

ParameterTypeApplicabilityDescriptionMandatory
arg0valuetextValue of argument index 0false
arg0resourcetextResource key of argument index 0

Default value(s):

FormName.fieldName
false
arg1valuetextValue of argument index 1false
arg1resourcetextResource key of argument index 1false
arg2valuetextValue of argument index 2false
arg2resourcetextResource key of argument index 2false
arg3valuetextValue of argument index 3false
arg3resourcetextResource key of argument index 3false

@struts.validator-var (0..*)

Defines Struts Validator variable

Applies to: Struts ValidatorForm

ParameterTypeApplicabilityDescriptionMandatory
nametextVariable nametrue
valuetextVariable valuetrue

@struts Field Level Tag Usage