XDoclet Overview News and Status Download/Installation Using XDoclet Best Practices FAQ License Ant Task Reference <ejbdoclet .. /> <webdoclet .. /> <hibernatedoclet .. /> <jdodoclet .. /> <jmxdoclet .. /> <doclet .. /> <documentdoclet .. /> Tag Reference apache (@soap @struts) bea (@weblogic) caucho (@resin) ejb (@ejb @dao) exolab (@castor) hp (@hpas) hibernate (@hibernate) ibm (@websphere) java (@javabean) jboss (@jboss) jdo (@jdo) jmx (@jmx) macromedia (@jrun) mvcsoft (@mvcsoft) mx4j (@mx4j) objectweb (@jonas) 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 Developer Resources Developer Guide Architecture Branches and Tags CVS Directory Layout XDoclet 2.0 Design Planning Development Reference Javadoc (API) Template Language (*.xdt) Todo List Project Documentation Front Page Project Info Project Reports Development Process | ### Tag Reference for @apacheSoap Class Level Tags @soap.service Method Level Tags @soap.method ### Tag Usage, Class Level (@apacheSoap) Tags for declaration of Apache SOAP services #### @soap.service (0..1) Declares the class a SOAP service.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
scope | text |  | Define the service scope. | 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
### Tag Usage, Method Level (@apacheSoap) Tags for declaration of Apache SOAP services #### @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 Reference for @struts Class Level Tags @struts.form @struts.action @struts.action-forward Method Level Tags @struts.form-field @struts.validator @struts.validator-args @struts.validator-var ### Tag Usage, Class Level (@struts) Defines a form bean and its attributes. #### @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" | true
input | text |  | The path to the input for the Action | true
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
### Tag Usage, Method Level (@struts) Defines a form bean and its attributes. #### @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
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