User: ko5tik
Date: 02/04/18 08:29:19
Modified: src/java xdoclet-tags.xml
Log:
finished ejb tag descriptions
Revision Changes Path
1.14 +485 -39 xdocletgui/src/java/xdoclet-tags.xml
Index: xdoclet-tags.xml
===================================================================
RCS file: /cvsroot/xdoclet/xdocletgui/src/java/xdoclet-tags.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -w -r1.13 -r1.14
--- xdoclet-tags.xml 18 Apr 2002 14:31:48 -0000 1.13
+++ xdoclet-tags.xml 18 Apr 2002 15:29:18 -0000 1.14
@@ -732,43 +732,6 @@
</parameter>
</tag>
<tag>
- <name>ejb:transaction</name>
- <usage-description>
- Defines the transactional behavior for this method. Applicable to methods
- with @ejb:create-method and @ejb:interface-method tags.
-
- If used on class level applies to all interface methods unless overriden
- </usage-description>
- <unique>true</unique>
- <condition-description>Entity & Session beans</condition-description>
- <condition type="or">
- <condition type="type">
- <condition-parameter>javax.ejb.SessionBean</condition-parameter>
- </condition>
- <condition type="type">
- <condition-parameter>javax.ejb.EntityBean</condition-parameter>
- </condition>
- </condition>
- <parameter type="text">
- <name>type</name>
- <usage-description>Define the type of transactional
behaviour.</usage-description>
- <mandatory>true</mandatory>
- <option-sets>
- <option-set>
- <default>Supports</default>
- <options>
- <option>NotSupported</option>
- <option>Supports</option>
- <option>Required</option>
- <option>RequiresNew</option>
- <option>Mandatory</option>
- <option>Never</option>
- </options>
- </option-set>
- </option-sets>
- </parameter>
- </tag>
- <tag>
<name>ejb:env-entry</name>
<usage-description>Defines an environment entry for an EJB.
</usage-description>
<unique>false</unique>
@@ -905,8 +868,8 @@
<default>none</default>
<options>
<option>none</option>
- <option>Local</option>
- <option>Remote</option>
+ <option>local</option>
+ <option>remote</option>
</options>
</option-set>
</option-sets>
@@ -1394,6 +1357,165 @@
</condition>
</tag>
<tag>
+ <name>ejb:pk</name>
+ <usage-description>
+ <![CDATA[$1
+ Defines the primary key of an entity bean. If the <entitypk/> subtask is
+ included, then primary key classes will be generated for all entity beans
+ unless a generate="false" parameter is present, or the primary class is
in the
+ java.lang package.
+ ]]>
+ </usage-description>
+ <unique>true</unique>
+ <condition-description>Entity beans</condition-description>
+ <condition type="and">
+ <condition type="class">
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.EntityBean</condition-parameter>
+ </condition>
+ </condition>
+ <parameter type="text">
+ <name>class</name>
+ <usage-description>
+ The fully qualified name of the primary key
+ class. If absent the primary key class name will
+ be determined using the pattern and package
+ parameters.
+ </usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>pattern</name>
+ <usage-description>
+ Define the pattern (using {0} for the EJB name)
+ to be used for constructing the unqualified
+ (package specific) name of the primary key
+ class.
+ </usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>package</name>
+ <usage-description>
+ <![CDATA[
+ Define the package the pk class is in (generated
+ or not). Use <packageSubstitution/> to
+ configure which package the PK class should
+ end up in.
+ ]]>
+ </usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
+ <parameter type="bool">
+ <name>generate</name>
+ <usage-description>
+ Indicate if the primary key class should be
+ generated. Defaults to true
+ </usage-description>
+ <mandatory>false</mandatory>
+ <default>true</default>
+ </parameter>
+ <parameter type="text">
+ <name>etends</name>
+ <usage-description>
+ Define which class the generated pk must
+ extend.
+ </usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>implements</name>
+ <usage-description>
+ Define which interface the generated pk must
+ implement.
+ </usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>ver-uid</name>
+ <usage-description>
+ Define the value of a serialVersionUID
+ attribute that will be set in the class. Note that
+ by default ejbdoclet generates a valid
+ serialVersionUID field in the generated PK
+ class. The value of the generated
+ serialVersionUID is equal to the one generated
+ by serialver.exe of JDK. So you can use what
+ ejbdoclet generates with no problem.
+ </usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>role-name</name>
+ <usage-description>
+ A comma-separated list of roles that can
+ execute findByPrimaryKey
+ </usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
+ <parameter type="bool">
+ <name>unchecked</name>
+ <usage-description>
+ Flags the PK-finder as having unchecked
+ permission. EJB2.0 only. If present, role-name
+ must be omitted
+ </usage-description>
+ <mandatory>false</mandatory>
+ <default>true</default>
+ </parameter>
+ <parameter type="text">
+ <name>method-intf</name>
+ <usage-description>
+ Indicates the interface (Home or LocalHome)
+ for which the findByPrimaryKey permissions
+ should be set. Applies only if role-name or
+ unchecked is specified. If the permissions
+ should apply to both Home or LocalHome
+ interfaces, this parameter should not be
+ specified.
+ </usage-description>
+ <mandatory>false</mandatory>
+ <option-sets>
+ <option-set>
+ <default>Home</default>
+ <options>
+ <option>Home</option>
+ <option>LocalHome</option>
+ </options>
+ </option-set>
+ </option-sets>
+ </parameter>
+ </tag>
+ <tag>
+ <name>ejb:pk-field</name>
+ <usage-description>
+ Use this for methods with the following pattern: public abstract Foo
getX().
+ This will denote the persistent field "X" as a primary key field, which
will
+ be included in the generated primary key class. Must be used with the
+ persistent-field tag. This tag is only valid for EntityBeans. It has no
+ parameters.
+ </usage-description>
+ <unique>true</unique>
+ <condition-description>
+ methods with the following pattern: public abstract Foo getX(). Entity
beans only.
+ </condition-description>
+ <condition type="and">
+ <condition type="method">
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.EntityBean</condition-parameter>
+ </condition>
+ <condition type="public">
+ </condition>
+ <condition type="abstract">
+ </condition>
+ <condition type="starts-with">
+ <condition-parameter>get</condition-parameter>
+ </condition>
+ </condition>
+ </tag>
+ <tag>
<name>ejb:relation</name>
<usage-description>
Defines a relationship between Entity beans. Applicable only to EJB2.0
CMP2.x beans.
@@ -1420,6 +1542,330 @@
<mandatory>true</mandatory>
</parameter>
</tag>
+ <tag>
+ <name>ejb:resource-env-ref</name>
+ <usage-description>
+ Defines a resource environment reference with the name name to a resource
+ of type type.
+ </usage-description>
+ <unique>false</unique>
+ <condition-description>Applicable to all EJB types. </condition-description>
+ <condition type="and">
+ <condition type="class">
+ </condition>
+ <condition type="or">
+ <condition type="type">
+ <condition-parameter>javax.ejb.EntityBean</condition-parameter>
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.SessionBean</condition-parameter>
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.MessageDrivenBean</condition-parameter>
+ </condition>
+ </condition>
+ </condition>
+ <parameter type="text">
+ <name>name</name>
+ <usage-description>The name of the resource.</usage-description>
+ <mandatory>true</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>type</name>
+ <usage-description>The type of the resource.</usage-description>
+ <mandatory>true</mandatory>
+ </parameter>
+ </tag>
+ <tag>
+ <name>ejb:resource-ref</name>
+ <usage-description>
+ Defines a resource reference with the name res-name to a resource of type
+ res-type, and the authentication is done by the one specified in res-auth.
+ </usage-description>
+ <unique>false</unique>
+ <condition-description>Applicable to all EJB types.</condition-description>
+ <condition type="and">
+ <condition type="class">
+ </condition>
+ <condition type="or">
+ <condition type="type">
+ <condition-parameter>javax.ejb.EntityBean</condition-parameter>
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.SessionBean</condition-parameter>
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.MessageDrivenBean</condition-parameter>
+ </condition>
+ </condition>
+ </condition>
+ <parameter type="text">
+ <name>res-name</name>
+ <usage-description>The resource name.</usage-description>
+ <mandatory>true</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>res-type</name>
+ <usage-description>The resource type.</usage-description>
+ <mandatory>true</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>res-auth</name>
+ <usage-description>The resource authentication type.</usage-description>
+ <mandatory>true</mandatory>
+ <option-sets>
+ <option-set>
+ <default>Container</default>
+ <options>
+ <option>Container</option>
+ <option>Application</option>
+ </options>
+ </option-set>
+ </option-sets>
+ </parameter>
+ </tag>
+ <tag>
+ <name>ejb:security-identity</name>
+ <usage-description>
+ The security-identity element specifies whether the caller?s security
+ identity is to be used for the execution of the methods of the enterprise
bean
+ or whether a specific run-as identity is to be used. It contains an
optional
+ description and a specification of the security identity to be used.
EJB2.0 only.
+ </usage-description>
+ <unique>true</unique>
+ <condition-description>Applicable to Entity, Session and Message Driven
beans.</condition-description>
+ <condition type="and">
+ <condition type="class">
+ </condition>
+ <condition type="or">
+ <condition type="type">
+ <condition-parameter>javax.ejb.EntityBean</condition-parameter>
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.SessionBean</condition-parameter>
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.MessageDrivenBean</condition-parameter>
+ </condition>
+ </condition>
+ </condition>
+ <parameter type="text">
+ <name>description</name>
+ <usage-description>The description of the security
identity.</usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>use-caller-identity</name>
+ <usage-description>
+ The use-caller-identity element
+ specifies that the caller?s security
+ identity be used as the security identity
+ for the execution of the enterprise
+ bean?s methods.
+ </usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>run-as</name>
+ <usage-description>
+ The run-as element specifies the run-as
+ identity to be used for the execution of
+ the methods of an enterprise bean. It
+ contains an optional description, and the
+ name of a security role.
+ </usage-description>
+ <mandatory></mandatory>
+ </parameter>
+ </tag>
+ <tag>
+ <name>ejb:security-role-ref</name>
+ <usage-description>
+ Defines a security role reference with the name role-name to a security
+ role link named role-link.
+ </usage-description>
+ <unique>false</unique>
+ <condition-description>Applicable to Entity and Session
beans.</condition-description>
+ <condition type="and">
+ <condition type="class">
+ </condition>
+ <condition type="or">
+ <condition type="type">
+ <condition-parameter>javax.ejb.EntityBean</condition-parameter>
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.SessionBean</condition-parameter>
+ </condition>
+ </condition>
+ </condition>
+ <parameter type="text">
+ <name>role-name</name>
+ <usage-description>The name of the role reference</usage-description>
+ <mandatory>true</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>role-link</name>
+ <usage-description>The name of the role link.</usage-description>
+ <mandatory>true</mandatory>
+ </parameter>
+ </tag>
+ <tag>
+ <name>ejb:select</name>
+ <usage-description>
+ Defines a select method for the home interface. An entity bean may have
+ zero or more ejb:select tags. Applicable to EJB2.0 CMP only.
+ </usage-description>
+ <unique>false</unique>
+ <condition-description>Entity bean</condition-description>
+ <condition type="and">
+ <condition type="class">
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.EntityBean</condition-parameter>
+ </condition>
+ </condition>
+ <parameter type="text">
+ <name>signature</name>
+ <usage-description>
+ Defines the signature of the
+ method. E.g.. "java.util.Collection
+ selectAll()". The return type in the
+ signature must be fully qualified.
+ </usage-description>
+ <mandatory>true</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>query</name>
+ <usage-description>EJB-QL query for the select method.</usage-description>
+ <mandatory>true</mandatory>
+ </parameter>
+ <parameter type="text">
+ <name>result-type-mapping</name>
+ <usage-description>Result type mapping for the select
method.</usage-description>
+ <mandatory>true</mandatory>
+ <option-sets>
+ <option-set>
+ <default>none</default>
+ <options>
+ <option>none</option>
+ <option>local</option>
+ <option>remote</option>
+ </options>
+ </option-set>
+ </option-sets>
+ </parameter>
+ </tag>
+ <tag>
+ <name>ejb:transaction</name>
+ <usage-description>
+ Defines the transactional behavior for this method. Applicable to methods
+ with @ejb:create-method and @ejb:interface-method tags.
+
+ If used on class level applies to all interface methods unless overriden
+ </usage-description>
+ <unique>true</unique>
+ <condition-description>Entity & Session beans</condition-description>
+ <condition type="or">
+ <condition type="type">
+ <condition-parameter>javax.ejb.SessionBean</condition-parameter>
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.EntityBean</condition-parameter>
+ </condition>
+ </condition>
+ <parameter type="text">
+ <name>type</name>
+ <usage-description>Define the type of transactional
behaviour.</usage-description>
+ <mandatory>true</mandatory>
+ <option-sets>
+ <option-set>
+ <default>Supports</default>
+ <options>
+ <option>NotSupported</option>
+ <option>Supports</option>
+ <option>Required</option>
+ <option>RequiresNew</option>
+ <option>Mandatory</option>
+ <option>Never</option>
+ </options>
+ </option-set>
+ </option-sets>
+ </parameter>
+ </tag>
+ <tag>
+ <name>ejb:util</name>
+ <usage-description>
+ <![CDATA[
+ This tag is optional, and lets you define whether or not a util class
should be
+ generated, and whether to use the logical component name (java:comp/env)
+ or the physical JNDI name to do the lookup. If this tag is not specified,
the
+ util class will be generated using logical lookups (provided the
<utilobject>
+ subtask is used)
+ ]]>
+ </usage-description>
+ <unique>true</unique>
+ <condition-description></condition-description>
+ <condition type="or">
+ <condition type="type">
+ <condition-parameter>javax.ejb.EntityBean</condition-parameter>
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.SessionBean</condition-parameter>
+ </condition>
+ </condition>
+ <parameter type="text">
+ <name>generate</name>
+ <usage-description>
+ false or no will omit the
+ generation of the util class.
+ logical will generate a util class
+ that uses the component name
+ for lookup, and physical will
+ generate a class that uses the
+ JNDI name for lookups. Default
+ is logical.
+ </usage-description>
+ <mandatory>true</mandatory>
+ <option-sets>
+ <option-set>
+ <default>logical</default>
+ <options>
+ <option>false</option>
+ <option>no</option>
+ <option>logical</option>
+ <option>physical</option>
+ </options>
+ </option-set>
+ </option-sets>
+ </parameter>
+ </tag>
+ <tag>
+ <name>dao:call</name>
+ <usage-description>
+ The method is a call to a data access object; the method will be included
in
+ the DAO interface, and the EJB's generated subclass will contain a call to
+ the DAO's method.
+ </usage-description>
+ <unique>true</unique>
+ <condition-description>Entity beans</condition-description>
+ <condition type="and">
+ <condition type="method">
+ </condition>
+ <condition type="type">
+ <condition-parameter>javax.ejb.EntityBean</condition-parameter>
+ </condition>
+ </condition>
+ <parameter type="text">
+ <name>name</name>
+ <usage-description>
+ Optionally specify the method's name in the DAO (it
+ need not be the same as the calling method in the EJB).
+ If not specified, the default is the usual interface
+ equivalent of the method's name (i.e. generally the
+ same, but ejbFindByX becomes findByX etc.)
+ </usage-description>
+ <mandatory>false</mandatory>
+ </parameter>
+ </tag>
</tags>
</namespace>
<namespace>
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
