XDoclet Overview News and Status Download/Installation Using XDoclet Best Practices FAQ License Ant Task Reference <ejbdoclet .. /> <webdoclet .. /> <hibernatedoclet .. /> <mockdoclet .. /> <jdodoclet .. /> <jmxdoclet .. /> <doclet .. /> Tag Reference apache (@soap @struts) bea (@weblogic) borland (@bes) caucho (@resin) ejb (@ejb @dao) exolab (@castor) hp (@hpas) hibernate (@hibernate) ibm (@websphere) java (@javabean) jboss (@jboss) jdo (@jdo) jmx (@jmx) macromedia (@jrun) mockobjects (@mock) mvcsoft (@mvcsoft) mx4j (@mx4j) objectweb (@jonas) oracle (@oc4j) orion (@orion) pramati (@pramati) sybase (@easerver) web (@web @jsp) webwork (@webwork) xdoclet (@xdoclet @doc) Feature Documentation Using Value Objects Advanced Maven Plug-in Merge Points Log4J Configuration IDE Integration Migration from EJBDoclet Ant 1.5 Troubleshooting Community Feedback Resources Tools Development Developer Guide Javadoc (API) Template Language (*.xdt) XJavaDoc Site Project Documentation Front Page Project Info Project Reports Development Process | ### Tag Reference for @apacheAxis Tags for declaration of Apache Axis services Class Level Tags @axis.service Method Level Tags @axis.method Field Level Tags ### Tag Usage, Class Level (@apacheAxis) #### @axis.service (0..1) Declares the class an Axis SOAP service.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | Define the service's name. | true
scope | text |  | Define the service scope. Valid options are: Request Session Application Default value(s): Application | true
provider | text |  | Specifies the provider type. | false
include-all | bool |  | If set to true, all methods will be exposed, without regard to whether or not they are tagged with @axis.method. | false
### Tag Usage, Method Level (@apacheAxis) #### @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. ### Tag Usage, Field Level (@apacheAxis) ### Tag Reference for @apacheSoap Tags for declaration of Apache SOAP services Class Level Tags @soap.service Method Level Tags @soap.method Field Level Tags ### Tag Usage, Class Level (@apacheSoap) #### @soap.service (0..1) Declares the class a SOAP service.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
scope | text |  | Define the service scope. Valid options are: Page Request Session Application Default value(s): Page | true
provider | text |  | 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
urn | text |  | The URN for the service. | false
type | text |  | Sets the service type. The only valid value is "message". Valid options are: message | false
checkMustUnderstands | bool |  | 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
### Tag Usage, Method Level (@apacheSoap) #### @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. ### Tag Usage, Field Level (@apacheSoap) ### Tag Reference for @struts Defines a form bean and its attributes. Class Level Tags @struts.form @struts.action @struts.action-forward @struts.action-exception Method Level Tags @struts.form-field @struts.validator @struts.validator-args @struts.validator-var Field Level Tags ### Tag Usage, Class Level (@struts) #### @struts.form (0..*) Defines a form bean and its attributes.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | Define a unique name for the form. | true
extends | text |  | Define which class the generated form must extend. | false
implements | text |  | Define which interface the generated form must implement. | false
include-pk | bool |  | Whether to include pk field in form. Default is true. If set to false, individual pk fields can still be included. | false
include-all | bool |  | Whether to include all persistent fields in form. Default is false. | false
#### @struts.action (0..*) Defines the action class and its attributes
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | The name of the action. Must be unique within the bounds of the Struts application | true
path | text |  | The path that the action will match. | true
scope | text |  | Define the scope of the action. "request" | "session" | "application" Valid options are: request session application Default value(s): request | true
input | text |  | The path to the input for the Action | true
roles | text |  | Comma-delimited list of security role names that are allowed access to this ActionMapping object. Since Struts 1.1. | false
validate | text |  | The validation flag for the action | true
parameter | text |  | The optional parameter for the action | true
#### @struts.action-forward (0..*) Defines local forwards for a Struts action class
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | The name of the forward | true
path | text |  | The path of the forward | true
#### @struts.action-exception (0..*) Defines the action specific exception handling
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
key | text |  | The key to use with this handler's message resource bundle that will retrieve the error message template for this exception. | true
type | text |  | Fully qualified Java class name of the exception type to register with this handler. | true
className | text |  | The configuration bean for this ExceptionHandler object. If specified, className must be a subclass of the default configuration bean. | false
handler | text |  | Fully qualified Java class name for this exception handler. | false
path | text |  | The module-relative URI to the resource that will complete the request/response if this exception occurs. | false
scope | text |  | The context ("request" or "session") that is used to access the ActionError object [org.apache.struts.action.ActionError] for this exception. | false
### Tag Usage, Method Level (@struts) #### @struts.form-field (0..*) Include property in specific struts form
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
form-name | text |  |  | to include this property in specified form.
#### @struts.validator (0..*) Defines Struts Validator for current setter field.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
type | text |  | Validator type, such as "required" | true
msgkey | text |  | Override key for the validator error message | false
page | text |  | Only fields with a "page" attribute value that is equal to or less than the page property on the form JavaBean are processed. | false
arg0value | text |  | Value of argument index 0 | false
arg0resource | text |  | Resource key of argument index 0 | false
arg1value | text |  | Value of argument index 1 | false
arg1resource | text |  | Resource key of argument index 1 | false
arg2value | text |  | Value of argument index 2 | false
arg2resource | text |  | Resource key of argument index 2 | false
arg3value | text |  | Value of argument index 3 | false
arg3resource | text |  | Resource key of argument index 3 | false
#### @struts.validator-args (0..1) Defines arguments for current setter field.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
arg0value | text |  | Value of argument index 0 | false
arg0resource | text |  | Resource key of argument index 0 | false
arg1value | text |  | Value of argument index 1 | false
arg1resource | text |  | Resource key of argument index 1 | false
arg2value | text |  | Value of argument index 2 | false
arg2resource | text |  | Resource key of argument index 2 | false
arg3value | text |  | Value of argument index 3 | false
arg3resource | text |  | Resource key of argument index 3 | false
#### @struts.validator-var (0..*) Defines Struts Validator variable
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | Variable name | true
value | text |  | Variable value | true
### Tag Usage, Field Level (@struts)