EJBGen

Introduction

EJBGen is an Enterprise JavaBeans 2.0 code generator. Instead of having to edit and maintain several files (Bean, Remote and Home classes, and the deployment descriptors), EJBGen will allow you to limit your editing to one file (the Bean class) and annotate it with Javadoc tags. EJBGen will then parse your source and will generate all the needed files.

Unzip the package in, say, c:\ejbgen. Then

C:\> cd ejbgen
C:\ejbgen> java -classpath c:\ejbgen\ejbgen.jar;%CLASSPATH% weblogic.tools.EJBGen <your Java file>

EJBGen supports the following options:

Command line	Ant	Property file	Type	Default	Documentation
-checkTags	checkTags	ejbgen.checkTags	[boolean]	N/A	If invoked with this option, EJBGen will not generate any classe but will search the classes supplied on the command line for tags that are not valid EJBGen tags.
-classpath	classPath	sgen.classPath	[classpath]	N/A	Class path.
-d	outputDir	sgen.outputDir	[directory]	N/A	Name of the directory where the files will be generated.
-descriptorDir	descriptorDir	ejbgen.descriptorDir	[directory]	N/A	The directory under which all the descriptor files will be created.
-docTag	docTag	ejbgen.docTag	[string (name of the tag)]	N/A	Display the documentation for one tag
-docTags	docTags	ejbgen.docTags	[boolean]	N/A	Print out all the tags known by EJBGen. Note that even though this option does not need any source file, you still need to specify an existing .java class on the command line, or Javadoc will emit an error message even though it recognized the flag.
-docTagsHtml	docTagsHtml	ejbgen.docTagsHtml	[boolean]	N/A	Display the HTML documentation for one tag.
-ejbPrefix	ejbPrefix	ejbgen.ejbPrefix	[string]	none	The prefix to use when generating the EJB class.
-ejbSuffix	ejbSuffix	ejbgen.ejbSuffix	[string]	EJB,Bean	The suffix to use when generating the EJB class.
-ejbgenQuiet	ejbgenQuiet	ejbgen.quiet	[boolean]	N/A	Make EJBGen less verbose.
-ejbgenVerbose	ejbgenVerbose	ejbgen.ejbgenVerbose	[boolean]	N/A	Verbose mode.
-errorFile	errorFile	ejbgen.errorFile	[file]	N/A	The path of the file where errors will be redirected.
-exitOnError	exitOnError	ejbgen.exitOnError	[boolean]	N/A	EJBGen should exit in case of an error.
-experimental	experimental	ejbgen.experimental	[boolean]	N/A	Enable experimental features.
-extractTemplates	extractTemplates	ejbgen.extractTemplates	[directory]	N/A	The directory where to extract the templates.
-forceGeneration	forceGeneration	ejbgen.forceGeneration	[boolean]	N/A	Force the generation of all files regardless of time stamps.
-help	help	ejbgen.help	[boolean]	N/A	Display the help.
-help	help	sgen.help		N/A	Displays the help.
-homeBaseClass	homeBaseClass	home.baseClass	[string (className)]	N/A	The base class for home remote interfaces.
-ignorePackage	ignorePackage	ejbgen.ignorePackage	[boolean]	N/A	If this flag is set, EJBGen will ignore the package name of the Java files it generates and will create those in the output directory as specified by the -d flag (or in the current directory if no -d was specified).
-jndiPrefix	jndiPrefix	ejbgen.jndiPrefix	[string]	none	The prefix to use for @remote-jndi-name and @local-jndi-name.
-jndiSuffix	jndiSuffix	ejbgen.jndiSuffix	[string]	none	The suffix to use for @remote-jndi-name and @local-jndi-name
-localBaseClass	localBaseClass	local.baseClass	[string (className)]	N/A	The base class for local interfaces.
-localHomeBaseClass	localHomeBaseClass	localHome.baseClass	[className]	N/A	The base class for local home interfaces.
-localHomePrefix	localHomePrefix	ejbgen.localHomePrefix	[string]	none	The prefix to use when generating the local EJB class.
-localHomeSuffix	localHomeSuffix	ejbgen.localHomeSuffix	[string]	LocalHome	The suffix to use when generating the local EJB class.
-localPrefix	localPrefix	ejbgen.localPrefix	[string]	none	The prefix to use when generating the local EJB class.
-localSuffix	localSuffix	ejbgen.localSuffix	[string]	Local	The suffix to use when generating the local EJB class.
-noImports	noImports	ejbgen.noImports	[boolean]	false	Disable propagation of java imports to generated classes.
-noLocalInterfaces	noLocalInterfaces	ejbgen.noLocalInterfaces	[boolean]	N/A	Whether local interfaces should be generated
-noRedirection	noRedirection	ejbgen.noRedirection	[boolean]	N/A	Cancel all redirection performed by EJBGen
-noRemoteInterfaces	noRemoteInterfaces	ejbgen.noRemoteInterfaces	[boolean]	N/A	Whether remote interfaces should be generated.
-noValueClasses	noValueClasses	ejbgen.noValueClasses	[boolean]	N/A	Whether value classes should be generated.
-noticeFile	noticeFile	ejbgen.errorNotice	[file]	N/A	The path of the file where notices will be redirected.
-pfd1	pfd1	ejbgen.pfd1	[boolean]	N/A	Whether EJBGen will generate deployment descriptors compatible with the Public Final Draft 1 of the EJB 2.0 specification. You should use this flag if you are using any version anterior to Weblogic 6.1.
-pfd2	pfd2	ejbgen.pfd2	[boolean]	N/A	Whether EJBGen will generate deployment descriptors compatible with the Public Final Draft 2 of the EJB 2.0 specification. You should use this flag if you are using any version anterior to Weblogic 6.1.
-primaryKeyBaseClass	primaryKeyBaseClass	primaryKey.baseClass	[string (class name)]	N/A	The base class for generated primary keys.
-printDiagnostic	printDiagnostic	ejbgen.printDiagnostic	[boolean]	N/A	Prints a diagnostic of all the tags found by EJBGen.
-printTags	printTags	ejbgen.printTags	[boolean]	N/A	Display all the tags recognized by EJBGen.
-propertyFile	propertyFile	sgen.propertyFile	[file]	N/A	Name of the property file.
-remoteBaseClass	remoteBaseClass	remote.baseClass	[string (className)]	N/A	The base class for remote interfaces.
-remoteHomePrefix	remoteHomePrefix	ejbgen.remoteHomePrefix	[string]	none	The suffix to use when generating the remote home EJB classes.
-remoteHomeSuffix	remoteHomeSuffix	ejbgen.remoteHomeSuffix	[string]	Home	The suffix to use when generating the remote home EJB classes.
-remotePrefix	remotePrefix	ejbgen.remotePrefix	[string]	none	The prefix to use when generating the remote EJB home class.
-remoteSuffix	remoteSuffix	ejbgen.remoteSuffix	[string]	none	The suffix to use when generating the remote EJB home class.
-source	source	sgen.source	[version number]	1.3	Version of the JDK to use.
-sourcepath	sourcePath	sgen.sourcePath	[directory]	N/A	Source path.
-templateDir	templateDir	ejbgen.templateDir	[directory]	N/A	The directory where the templates are stored.
-toStringForPrimitivesOnly	toStringForPrimitivesOnly	ejbgen.toStringForPrimitivesOnly	[boolean]	N/A	toString() on value classes will only include primitive types.
-valueBaseClass	valueBaseClass	value.baseClass	[string (class name)]	N/A	The suffix to use when generating the value object class.
-valueObjectPrefix	valueObjectPrefix	ejbgen.valueObjectPrefix	[string]	none	The prefix to use when generating the value object class.
-valueObjectSuffix	valueObjectSuffix	ejbgen.valueObjectSuffix	[string]	Value	The suffix to use when generating the value object class.
-valuePackage	valuePackage	value.package	[string (package name)]	N/A	Package the value classes belong to.
-verbose	verbose	sgen.verbose	[boolean]	false	Display more information.
-warningFile	warningFile	ejbgen.warningFile	[file]	N/A	The path of the file where warnings will be redirected.
-wls6	wls6	ejbgen.wls6	[boolean]	N/A	Generate WebLogic 6.0 descriptors
-wls7	wls7	ejbgen.wls7	[boolean]	N/A	Generate WebLogic 7.0 descriptors
-wls71	wls71	ejbgen.wls71	[boolean]	N/A	Generate WebLogic 7.1 descriptors
-wls81	wls81	ejbgen.wls81	[boolean]	N/A	Generate WebLogic 8.1 descriptors
-wls9	wls9	ejbgen.wls9	[boolean]	N/A	Generate WebLogic 9 descriptors
-workshopDocTags	workshopDocTags	ejbgen.workshopDocTags	[boolean]	N/A	Display the help in Workshop HTML format.
-xmlEncoding	xmlEncoding	ejbgen.xmlEncoding	[string]	N/A	The encoding to use when generating XML files (default: UTF-8).

Note that each option can be specified in three different ways:

• On the command line.
• In an ant build file.
• In a property file, passed to EJBGen with by -propertyFile.

Examples:

java -classpath c:\ejbgen\ejbgen.jar;%CLASSPATH% weblogic.tools.ejbgen.EJBGen -d foo -valueObjectSuffix DTO AccountBean.java 

java -classpath c:\ejbgen\ejbgen.jar;%CLASSPATH% weblogic.tools.ejbgen.EJBGen
  -valueObjectSuffix none -valueObjectPrefix DTO AccountBean.java 

Tags Documentation

@ejbgen:automatic-key-generation
Where:Class
Applicable on: Entity

Attribute	Description	Required
type	(Oracle|SQLServer|SQLServer2000|NamedSequenceTable) Specifies the type of the key generator.	Yes
cache-size	Specifies the size of the key cache.	No
name	Names the key generator.	No

@ejbgen:cmp-field
Where:Method
Applicable on: Entity

Attribute	Description	Required
column	Specifies the column where this CMP field will be mapped.	Yes
column-type	(OracleClob|OracleBlob) Specifies the type of this column.	No
exclude-from-value-object	(True|False) If True, this field will not be generated in the value object.	No
group-names	Specifies the names of the groups to which this field belongs, separated by commas.	No
ordering-number	(0..n) Specifies the number where this field must appear in signatures and constructors. For this ordering to work, all CMR and CMP fields must have this attribute with a distinct numeric value.	No
primkey-field	(True|False) Sets whether this field is part of the compound primary key.	No
read-only-in-value-object	(True|False) If True, only the getter will be generated for this field in the value object.	No
table-name	Specifies the table(s) where this field should be mapped.	No

@ejbgen:cmr-field
Where:Method
Applicable on: Entity

Attribute	Description	Required
exclude-from-value-object	(True|False) If True, this field will not be generated in the value object.	No
group-names	Specifies the names of the groups to which this field belongs, separated by commas.	No
ordering-number	(0..n) Specifies the number where this field must appear in signatures and constructors. For this ordering to work, all CMR and CMP fields must have this attribute with a distinct numeric value.	No
read-only-in-value-object	(True|False) If True, only the getter will be generated for this field in the value object.	No

@ejbgen:compatibility
Where:Class
Applicable on:All

Attribute	Description	Required
serialize-byte-array-to-oracle-blob	(True|False) Whether a cmp-field of type byte[] mappedto a OracleBlob should be serialized	No

@ejbgen:create-default-dbms-tables
Where:Class
Applicable on: Entity

Attribute	Description	Required
value	This tag is deprecated; please use @ejbgen:jar-settings.	No

@ejbgen:ejb-client-jar
Where:Class
Applicable on:All

Attribute	Description	Required
file-name	This tag is deprecated; please use @ejbgen:jar-settings.	Yes

@ejbgen:ejb-interface
Where:Class
Applicable on:All

Attribute	Description	Required
ejb-type	(javax.ejb.MessageDrivenBean|javax.ejb.EntityBean|javax.ejb.SessionBean) Specifies the type of this EJB. This tag is not normally used.	Yes

@ejbgen:ejb-local-ref
Where:Class
Applicable on:All

Attribute	Description	Required
home	Names the Home class of the bean.	No
id	The identity of this tag (used for tag inheritance only).	No
jndi-name	Specifies the JNDI name of the reference.	No
link	Names the link of the bean.	No
local	Names the Local class of the bean.	No
name	Names the reference.	No
type	(Entity|Session) Specifies the reference type.	No

@ejbgen:ejb-ref
Where:Class
Applicable on:All

Attribute	Description	Required
home	Specifies the Home class of the bean.	No
id	The identity of this tag (used for tag inheritance only).	No
jndi-name	Specifies the JNDI name of the reference.	No
link	Specifies the link of the bean.	No
name	Names the reference.	No
remote	Specifies the Remote class of the bean.	No
type	(Entity|Session) Specifies the type of the reference.	No

@ejbgen:entity
Where:Class
Applicable on: Entity

Attribute	Description	Required
ejb-name	Names this Entity bean.	Yes
prim-key-class	Names the Java class of the primary key. In case of a compound primary key, this class will be generated by EJBGen.	Yes
abstract-schema-name	Gives the abstract schema name for this EJB. If not specified, the ejb-name value will be used.	No
cache-between-transactions	(True|False) Specifies whether to cache the persistent data of an entity bean across (between) transactions.	No
check-exists-on-method	(True|False) Specifies whether the container checks for the existence of a bean for each method call.	No
clients-on-same-server	(True|False) Specifies whether the clients are colocated with the EJB on the same server.	No
concurrency-strategy	(ReadOnly|Exclusive|Database|Optimistic) Defines the concurrency strategy for this bean.	No
data-source-name	Names the DataSource declared in config.xml.	No
database-type	(DB2|Informix|Oracle|SQLServer|Sybase|PointBase|SQLServer2000) Specifies the database type of the underlying DBMS.	No
db-is-shared	(True|False)	No
default-dbms-tables-ddl	Specifies the DDL file name.	No
default-transaction	(NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Sets the default transaction attribute to be applied to all methods that do not have a transaction attribute setting.	No
delay-database-insert-until	(ejbCreate|ejbPostCreate)	No
delay-updates-until-end-of-tx	(True|False) Determines whether updates will be sent after the transaction has been committed.	No
disable-warning	Deprecated, use @ejbgen:jar-settings	No
dispatch-policy	Specifies the dispatch policy queue for this bean.	No
enable-batch-operations	(True|False) Determines whether to perform batch operations.	No
enable-call-by-reference	(True|False) Specifies whether the container will call this EJB by reference.	No
enable-dynamic-queries	(True|False) Specifies whether dynamic queries are enabled.	No
finders-load-bean	(True|False) If set to True, the beans will immediately be loaded into the cache by the finder.	No
home-call-router-class-name	Names the class to be used for routing home method calls.	No
home-is-clusterable	(True|False) Determines whether this bean can be deployed from multiple servers in a cluster.	No
home-load-algorithm	(RoundRobin|Random|WeightBased|RoundRobinAffinity|RandomAffinity|WeightBasedAffinity) Specifies the algorithm to use for load-balancing between replicas of this home.	No
idle-timeout-seconds	Sets the maximum duration an EJB should stay in the cache, in seconds.	No
initial-beans-in-free-pool	Specifies the initial number of beans in the free pool.	No
instance-lock-order	(AccessOrder|ValueOrder) The locking order for this Entity bean.	No
invalidation-target	Targets the ejb-name of a read-only Entity bean to be invalidated when this Container-Managed Persistence Entity EJB is modified.	No
lock-order	Sets the database locking order of this bean when a transaction involves multiple beans.	No
max-beans-in-cache	Sets the maximum number of beans in cache.	No
max-beans-in-free-pool	Specifies the maximum number of beans in the free pool.	No
optimistic-column	Specifies the column that holds the timestamp for optimistic concurrency.	No
order-database-operations	(True|False) Determines whether to sort the database operations.	No
prim-key-class-nogen	(True|False) If this keyword is specified, EJBGen will not generate the primary key class (it is assumed that you are providing it).	No
read-timeout-seconds	Sets the number of seconds between each ejbLoad() call on a read-only Entity bean.	No
reentrant	(True|False)	No
run-as	Specifies the role-name for this EJB.	No
run-as-identity-principal	Gives the name of the principal in case the role maps to several principals.	No
table-name	Names the table to which this Entity bean is mapped.	No
trans-timeout-seconds	Sets the transaction timeout (in seconds).	No
use-caller-identity	(True|False) Determines whether or not this EJB uses the callers identity.	No
use-select-for-update	(True|False) If true, causes SELECT ... FOR UPDATE to be used whenever the bean is loaded from the database.	No
validate-db-schema-with	(MetaData|TableQuery) Specifies the method used to validate the tables created by the EJB container.	No
verify-columns	(Read|Modified|Version|Timestamp) Specifies how optimistic concurrency verifies that the columns have or have not been modified during transactions.	No
verify-rows	(Read|Modified) Specifies the rows in a table that should be checked when optimistic concurrency is used.	No

@ejbgen:entity-cache-ref
Where:Class
Applicable on: Entity

Attribute	Description	Required
concurrency-strategy	(ReadOnly|Exclusive|Database) Defines the concurrency strategy for this bean.	Yes
name	Names the cache.	Yes
cache-between-transactions	(True|False) Sets whether to cache the persistent data of an entity bean across (between) transactions.	No
estimated-bean-size	Specifies the estimated average size of the instances of an entity bean, in bytes.	No

@ejbgen:env-entry
Where:Class
Applicable on:All

Attribute	Description	Required
name	Names this environment entry.	Yes
type	(java.lang.Boolean|java.lang.String|java.lang.Character|java.lang.Integer|java.lang.Double|java.lang.Byte|java.lang.Short|java.lang.Long|java.lang.Float) Specifies the Java type for this environment entry (must be fully qualified, even if the type is java.lang).	Yes
value	Specifies the value for this environment entry.	Yes

@ejbgen:file-generation
Where:Class
Applicable on:All

Attribute	Description	Required
local-class	(True|False) Whether to generate the local interface for this EJB.	No
local-class-name	The name of the local class to be generated.	No
local-home	(True|False) Whether to generate the local home interface for this EJB.	No
local-home-name	The name of the local home class to be generated.	No
local-home-package	The package for the local home interface.	No
local-package	The package for the local interface.	No
pk-class	(True|False) Whether to generate the primary key class for this EJB.	No
remote-class	(True|False) Whether to generate the remote interface for this EJB.	No
remote-class-name	The name of the remote class to be generated.	No
remote-home	(True|False) Whether to generate the remote home interface for this EJB.	No
remote-home-name	The name of the remote home class to be generated.	No
remote-home-package	The package for the remote home interface.	No
remote-package	The package for the remote interface.	No
value-class	(True|False) Whether to generate the value class for this EJB.	No
value-class-name	The name of the value class to be generated.	No

@ejbgen:finder
Where:Class
Applicable on: Entity

Attribute	Description	Required
caching-name	Specifies the name of an eager relationship caching.	No
comment	Defines a comment that will be reproduced above the generated finder Java method.	No
ejb-ql	Specifies the EJB QL request as it will appear in the deployment descriptor.	No
generate-on	(Local|Remote) Determines which Home this finder will be generated on. If unspecified, it will be generated on both.	No
group-name	Names the group for the WebLogic Server query.	No
id	The identity of this tag (used for tag inheritance only).	No
include-updates	(True|False) Determines whether updates made during the current transaction must be reflected in the result of a query.	No
isolation-level	(TransactionSerializable|TransactionReadCommitted|TransactionReadUncommitted|TransactionRepeatableRead) Specifies the type of transaction isolation for this method.	No
max-elements	Specifies the maximum number of elements that should be returned by a multi-valued query.	No
signature	Specifies exactly the signature to be generated on the Home class. EJBGen will add the conformant exceptions, but you must specify the fully qualified type of each parameter, even if it belongs to java.lang.	No
sql-select-distinct	(True|False) Determines whether the generated SQL SELECT will contain a DISTINCT qualifier.	No
transaction-attribute	(NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Specifies the transaction attribute for this local method. If not specified, the default transaction attribute will be used. Methods with this tag will be generated on the Local class.	No
weblogic-ejb-ql	Specifies the Weblogic Server EJB QL request as it will appear in the deployment descriptor. Note: if this request is needed, enclose both EJB-QL and Weblogic Server EJB-QL within double quotes.	No

@ejbgen:foreign-jms-provider
Where:Class
Applicable on: Message-Driven

Attribute	Description	Required
connection-factory-jndi-name	Specifies the connection factory JNDI name.	No
initial-context-factory	Specifies the initial JNDI context factory.	No
provider-url	Specifies the provider URL.	No

@ejbgen:jar-settings
Where:Class
Applicable on:All

Attribute	Description	Required
create-tables	Whether to create tables.	No
disable-warning	A comma-separated line of warnings to disable when running ejbc.	No
ejb-client-jar	Specifies the name of the client JAR to be generated. If multiple EJBs have this tag, only one of the specified JAR files will be included in the deployment descriptor.	No
enable-bean-class-redeploy	(True|False) Determines whether this EJB can be redeployed without redeploying the entire module.	No

@ejbgen:jndi-name
Where:Class
Applicable on:All

Attribute	Description	Required
local	Specifies the local JNDI name of this EJB. If a local JNDI name is not specified, no local interfaces will be generated.	No
remote	Specifies the remote JNDI name of this EJB. If a remote JNDI name is not specified, no remote interfaces will be generated.	No

@ejbgen:local-home-method
Where:Method
Applicable on: Entity Session

Attribute	Description	Required
is-idempotent	(True|False) Sets whether this method is idempotent.	No
isolation-level	(TransactionSerializable|TransactionReadCommitted|TransactionReadUncommitted|TransactionRepeatableRead) Specifies the type of transaction isolation for this method.	No
ordering-number	(0..n) Specifies the number where this method must appear in the generated class.	No
roles	Defines a comma-separated list of roles that are allowed to invoke this method.	No
transaction-attribute	(NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Specifies the transaction attribute for this local method. If not specified, the default transaction attribute will be used. Methods with this tag will be generated on the Local class.	No

@ejbgen:local-method
Where:Method
Applicable on: Entity Session

Attribute	Description	Required
is-idempotent	(True|False) Specifies whether this method is idempotent.	No
isolation-level	(TransactionSerializable|TransactionReadCommitted|TransactionReadUncommitted|TransactionRepeatableRead) Specifies the type of transaction isolation for this method.	No
ordering-number	(0..n) Specifies the number where this method must appear in the generated class.	No
roles	Defines a comma-separated list of roles that are allowed to invoke this method.	No
transaction-attribute	(NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Specifies the transaction attribute for this local method. If not specified, the default transaction attribute will be used. Methods with this tag will be generated on the Local class.	No

@ejbgen:message-driven
Where:Class
Applicable on: Message-Driven

Attribute	Description	Required
destination-jndi-name	Gives the JNDI name of the destination of this Message-Driven bean.	Yes
destination-type	(javax.jms.Queue|javax.jms.Topic) Specifies the destination type of the Message-Driven bean.	Yes
ejb-name	Specifies the name of this Message-Driven bean.	Yes
acknowledge-mode	(auto-acknowledge|dups-ok-acknowledge) Specifies the acknowledgement mode of this Message-Driven bean.	No
clients-on-same-server	(True|False) Specifies whether the clients are colocated with the EJB on the same server.	No
create-as-principal-name	Names the principal to be used when ejbCreate would otherwise run with an anonymous principal.	No
default-transaction	(NotSupported|Required) Specifies the transaction attribute to be applied to all methods that do not have a specific transaction attribute setting.	No
dispatch-policy	Specifies the dispatch policy queue for this bean.	No
durable	(True|False) If the destination-type is Topic, setting this attribute to True will make the subscription durable.	No
initial-beans-in-free-pool	Specifies the initial number of beans in the free pool.	No
jms-client-id	The client id of this EJB.	No
jms-polling-interval-seconds	The number of seconds between each attempt to reconnect to the JMS destination.	No
max-beans-in-free-pool	Specifies the maximum number of beans in the free pool.	No
message-selector	Specifies the JMS message selector of this Message-Driven bean.	No
passivate-as-principal-name	Names the principal to be used when ejbPassivate would otherwise run with an anonymous principal.	No
remove-as-principal-name	Names the principal to be used when ejbRemove would otherwise run with an anonymous principal.	No
run-as	Specifies the role-name for this EJB.	No
run-as-identity-principal	Specifies the name of the principal in case the role maps to several principals.	No
trans-timeout-seconds	Specifies the transaction timeout (in seconds).	No
transaction-type	(Bean|Container) Specifies where the transactions for this EJB are managed.	No
use-caller-identity	(True|False) Specifies whether this EJB uses callers identity.	No

@ejbgen:method-isolation-level-pattern
Where:Class
Applicable on:All

Attribute	Description	Required
isolation-level	(TransactionSerializable|TransactionReadCommitted|TransactionReadUncommitted|TransactionRepeatableRead) Specifies the isolation level for the methods specified in the pattern tag.	Yes
pattern	Specifies the pattern that matches all methods that will receive this isolation level (e.g. "*").	Yes
id	The identity of this tag (used for tag inheritance only).	No

@ejbgen:method-permission-pattern
Where:Class
Applicable on:All

Attribute	Description	Required
pattern	Specifies the pattern that matches all methods that will receive this method permission (e.g. "*").	Yes
roles	Specifies the roles for the methods specified in the pattern tag, separated by a comma.	Yes
id	The identity of this tag (used for tag inheritance only).	No
interface	(Home|Remote|LocalHome|Local) Specifies the interface to which this permission pattern applies.	No
itf	(Home|Remote|LocalHome|Local) Specifies the interface to which this permission pattern applies.	No

@ejbgen:relation
Where:Class
Applicable on: Entity

Attribute	Description	Required
multiplicity	(one|many) Sets the multiplicity of the relationship.	Yes
name	Specifies the name of the relationship. Use the same name on both ends of a relationship (note that this constraint applies to unidirectional relationships as well).	Yes
cascade-delete	(True|False)	No
cmr-field	Specifies the CMR field where this relationship will be kept. This field is optional. If it not present, the relationship is unidirectional. If it is present, the attribute fk-column must be specified as well.	No
db-cascade-delete	(True|False) Determines whether a cascade delete will use the built-in cascade delete facilities of the underlying DBMS.	No
fk-column	Needed only in a relationship having at least one One side. The non-One side EJB must declare the column that it will use to store the primary key of its counterpart.	No
foreign-key-table	The name of a DBMS table that contains a foreign-key.	No
id	The identity of this tag (used for tag inheritance only).	No
joint-table	Only needed in a Many-Many relationship. Must be the name of an existing table that will be used to hold the joint table containing the relationships. If you are using a compound primary key, specify a set of corresponding foreign keys separated by a comma.	No
primary-key-table	The name of a DBMS table that contains a primary-key.	No
role-name	The name of this role (such as "ParentHasChildren"). If no role name is given, EJBGen will generate one for you. You must specify a role-name in order to inherit relations.	No
target-ejb	Specifies the EJB name of the target of this relationship, which is used to generate the role name. If not supplied, a unique string will be generated.	No

@ejbgen:relationship-caching-element
Where:Class
Applicable on: Entity

Attribute	Description	Required
caching-name	Specifies the name of an eager relationship caching.	Yes
cmr-field	Provides a comma-separated list of CMR field names.	Yes
group-name	Specifies the name of the group to be loaded for the CMR field.	No
id	The identity of this tag (used for tag inheritance only).	No
parent-id	Specifies the parent ID of this element.	No

@ejbgen:remote-home-method
Where:Method
Applicable on: Entity Session

Attribute	Description	Required
is-idempotent	(True|False) Specifies whether this method is idempotent.	No
isolation-level	(TransactionSerializable|TransactionReadCommitted|TransactionReadUncommitted|TransactionRepeatableRead) Specifies the type of transaction isolation for this method.	No
ordering-number	(0..n) Specifies the number where this method must appear in the generated class.	No
roles	Specifies a comma-separated list of roles that are allowed to invoke this method.	No
transaction-attribute	(NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Specifies the transaction attribute for this remote method. If not specified, the default transaction attribute will be used. Methods with this tag will be generated on the Remote class.	No

@ejbgen:remote-method
Where:Method
Applicable on: Entity Session

Attribute	Description	Required
is-idempotent	(True|False) Determines whether this method is idempotent.	No
isolation-level	(TransactionSerializable|TransactionReadCommitted|TransactionReadUncommitted|TransactionRepeatableRead) Specifies the type of transaction isolation for this method.	No
ordering-number	(0..n) Specifies the number where this method must appear in the generated class.	No
roles	Defines a comma-separated list of roles that are allowed to invoke this method.	No
transaction-attribute	(NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Specifies the transaction attribute for this remote method. If not specified, the default transaction attribute will be used. Methods with this tag will be generated on the Remote class.	No

@ejbgen:resource-env-ref
Where:Class
Applicable on:All

Attribute	Description	Required
name	Names the resource environment reference.	Yes
type	Specifies the type of the environment resource references (e.g., javax.jms.Queue).	Yes
id	The identity of this tag (used for tag inheritance only).	No
jndi-name	Gives the JNDI name of the resource.	No

@ejbgen:resource-ref
Where:Class
Applicable on:All

Attribute	Description	Required
auth	(Application|Container)	Yes
jndi-name	Specifies the JNDI name of the resource.	Yes
name	Names the resource.	Yes
type	Specifies the type of the resource (e.g., javax.sql.DataSource).	Yes
id	The identity of this tag (used for tag inheritance only).	No
sharing-scope	(Shareable|Unshareable)	No

@ejbgen:role-mapping
Where:Class
Applicable on:All

Attribute	Description	Required
role-name	Specifies the name of the role.	Yes
externally-defined	(True|False) Trus if this role is defined externally.	No
global-role	(True|False) True if this role is global.	No
id	The identity of this tag (used for tag inheritance only).	No
principals	Specifies the names of the principals in this role (separated by commas).	No

@ejbgen:security-role-ref
Where:Class
Applicable on: Entity Session

Attribute	Description	Required
role-name	Specifies the name of the security role.	Yes
id	The identity of this tag (used for tag inheritance only).	No
role-link	References a defined security role.	No

@ejbgen:select
Where:Method
Applicable on: Entity

Attribute	Description	Required
caching-name	Specifies the name of an eager relationship caching.	No
ejb-ql	Specifies the EJB-QL that defines this select method. The method name must start with ejbSelect.	No
group-name	Names the group for the WebLogic Server query.	No
include-updates	(True|False) Determines whether updates made during the current transaction must be reflected in the result of a query.	No
max-elements	Specifies the maximum number of elements that should be returned by a multi-valued query.	No
ordering-number	(0..n) Specifies the number where this method must appear in the generated class.	No
result-type-mapping	(Remote|Local) Specifies whether the returned objects are mapped to EJBLocalObject or EJBObject.	No
sql-select-distinct	(True|False) Determines whether the generated SQL SELECT will contain a DISTINCT qualifier.	No
weblogic-ejb-ql	Specifies the Weblogic Server EJB-QL request as it will appear in the deployment descriptor. Note: if this request is needed, enclose both EJB-QL and Weblogic Server EJB-QL within double quotes.	No

@ejbgen:service-ref
Where:Class
Applicable on:All

Attribute	Description	Required
name	Name of this service in the WSDL fi.	Yes
wsdl-uri	Location of the WSDL file.	Yes
handler-chain-uri	The location of the XML file that contains the handler chain information.	No
jaxrpc-mapping-file	Name of the jax-rpc mapping file. If not provided, clientgen will choose a name.	No
package-name	Package name for the clientgen generated classes/interfaces.	No

@ejbgen:session
Where:Class
Applicable on: Session

Attribute	Description	Required
ejb-name	Names this Session bean.	Yes
allow-concurrent-calls	(True|False) Specifies whether to allow concurrent calls on that EJB.	No
allow-remove-during-transaction	(True|False) Specifies whether remove() can be invoked during a transaction.	No
bean-load-algorithm	Specifies the algorithm to be used for load-balancing among replicas of this bean.	No
cache-type	(NRU|LRU) Specifies the type of the cache for this stateful Session bean.	No
call-router-class-name	Gives class name to be used for routing home method calls.	No
clients-on-same-server	(True|False) Specifies whether the clients are colocated with the EJB on the same server.	No
create-as-principal-name	Names the principal to be used when ejbCreate would otherwise run with an anonymous principal.	No
default-transaction	(NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Specifies the transaction attribute to be applied to all methods that do not have a specific transaction attribute setting.	No
dispatch-policy	Specifies the dispatch policy queue for this bean.	No
enable-call-by-reference	(True|False) Specifies whether the container will call this EJB by reference.	No
home-call-router-class-name	Names class to be used for routing home method calls.	No
home-is-clusterable	(True|False) Specifies whether this bean can be deployed from multiple servers in a cluster.	No
home-load-algorithm	(RoundRobin|Random|WeightBased|RoundRobinAffinity|RandomAffinity|WeightBasedAffinity) Specifies the algorithm to use for load-balancing between replicas of this home.	No
idle-timeout-seconds	Specifies the maximum duration an EJB remains cached.	No
initial-beans-in-free-pool	Specifies the initial number of beans in the free pool.	No
is-clusterable	(True|False) Sets whether this bean is clusterable.	No
max-beans-in-cache	Specifies the maximum number of beans in the cache.	No
max-beans-in-free-pool	Specifies the maximum number of beans in the free pool.	No
methods-are-idempotent	(True|False) Specifies whether the methods for this stateless session bean are idempotent or not.	No
passivate-as-principal-name	Names the principal to be used when ejbPassivate would otherwise run with an anonymous principal.	No
persistent-store-dir	Specifies the directory in which to store the passivated beans.	No
remove-as-principal-name	Names the principal to be used when ejbRemove would otherwise run with an anonymous principal.	No
replication-type	(InMemory|None) Specifies how to replicate stateful session beans in a cluster.	No
run-as	Specifies the role-name for this EJB.	No
run-as-identity-principal	Specifies the name of the principal when the role maps to several principals.	No
service-endpoint	The fully-qualified name of the enterprise beans web service endpoint interface.	No
session-timeout-seconds	Specifies the number of seconds an EJB stays alive before being passivated.	No
trans-timeout-seconds	Specifies the transaction timeout (in seconds).	No
transaction-type	(Bean|Container) Specifies who manages the transactions for this EJB.	No
type	(Stateless|Stateful) Specifies the type of the Session bean. If this attribute is not specified, EJBGen will guess the right type by looking at the ejbCreate() methods on your class.	No
use-caller-identity	(True|False) Specifies whether this EJB uses callers identity.	No

@ejbgen:value-object
Where:Class
Applicable on:All

Attribute	Description	Required
reference	(Local|Value) Specifies what objects the value object class should reference when accessing other EJBs.	No

You can selectively disable the generation of these files by using the @ejbgen:file-generation tag. This can be done on a per-bean basis. For example, if you are not interested in the generation of value classes for a bean:

/**
 * @ejbgen:file-generation
 *   value-class = False
 */

• Unidirectional relationships are achieved by specifying only the first two parameters of the relation tag (no CMR_field, no joint table).
• Many to many relationships must specify an extra table (parameter "joint table") which must contain at least two columns. The names of these columns must match the names of the columns containing the foreign keys ot the two beans being joined. See the examples "examples/many2many/" in the distribution.

Upgrading relationships to use local interfaces

If you have EJB's based on a version of the EJB 2.0 specification that predates PFD2, you will need to update them. As of PFD2, relationships must be based on local interfaces, not remote ones. Here are the steps you need to take up upgrade your EJB's:

• Add a JNDI name for your local home interface:

  @ejbgen:jndi-name
    remote = AccountHome
    local = AccountLocalHome
  

• Add @ejbgen:local-method tags to any method you want to see appear on the local home interface. A method can have both @ejbgen:local-method and @ejbgen:remote-method
• Change the return type of your CMR accessors to that of the local EJB object (this only applies to single-valued CMR fields since multi-valued CMR fields are Collections. Keep in mind that these Collections will contain Local EJB objects, though):

    /**
     * @ejbgen:cmr-field
     *
     * @ejbgen:remote-method
     * @ejbgen:local-method
     */
    abstract public LocalCustomer getCustomer();
  

One of the main features in EJBGen 2.0 is the possibility to inherit tags. You can now inherit EJBGen annotations the same way you do it in Java. For example, assume that you have an EJB named AccountEJB with a base class BaseAccount:

/**
 * @ejbgen:jndi-name
 *     remote="BaseRemote"
 */
public class BaseAccount implements EntityBean {
  // ...
}

/**
 * @ejbgen:entity
 *   ejb-name = containerManaged
 *   table-name = ejbAccounts
 *   data-source-name = examples-dataSource-demoPool
 *
 *  Note that we inherit the JNDI name defined in BaseAccount
 */
public class AccountEJB extends BaseAccount {
  // ...

/**
 * @ejbgen:entity
 *    max-beans-in-cache = 300
 */
public class BaseAccount implements EntityBean {
  // ...
}

/**
 * @ejbgen:entity
 *   ejb-name = containerManaged
 *   table-name = ejbAccounts
 *   data-source-name = examples-dataSource-demoPool
 *
 *   // automatically inherit the attribute max-beans-in-cache = 300
 */
public class AccountEJB extends BaseAccount {
  // ...

/**
 * @ejbgen:entity
 *   ejb-name = containerManaged
 *   table-name = ejbAccounts
 *   data-source-name = examples-dataSource-demoPool
 *   max-beans-in-cache = 400
 *
 *   // the above setting overrides the one defined in the base class
 */
public class AccountEJB extends BaseAccount {
  // ...

When you decide to use inheritance on tags that can appear more than once (such as @ejbgen:relation, or @ejbgen:env-entry), you need to specify an attribute called "id" in order for EJBGen to be able to resolve your inheritance hierarchy.

Here is an example of an inherited relation. The parent class first, which defines a partial relation (no cmr-field). Note the presence of the "id" attribute:

/**
 * @ejbgen:relation
 *   id = MyRelation
 *   name = Many1-Many2
 *   role-name = Many1HasMany2
 *   multiplicity = many
 *   role-name = Many1HasMany2
 *   target-ejb = Many2EJB
 *   fk-column = many2_fk
 *   joint-table = join_table
 */

abstract public class BaseMany1 extends BaseEntityBean {

/**
 * @ejbgen:relation
 *   id = MyRelation
 *   cmr-field = many2
 *
 */
abstract public class Many1EJB extends BaseMany1 {

With this information, EJBGen will generate a compound primary key class for you with the following characteristics:

• The CMP fields you flagged with @primkey-field
• Implementations of equals() and hashCode()
• A default paramaterless constructor
• A constructor with all the CMP fields as parameters, allowing you to create a fully populated primary key with one call

Please refer to the example in examples/ejb20/basic/compoundPK/ for an illustration of compound primary key generation.

 * @ejbgen:ejb-ref
 *   link = PortalStudio_Group     // must be the EJB name of another EJB
 *   name = MyName    // EJBGen will reuse this value and guess the missing ones
 *

A: You must use double quotes in all tags that have spaces in them. I recommend you do that for all tags anyway, since it will make your migration to JSR 175 easier:

  * group-names = "group1, group2"

This section only lists the major changes between versions. If you need to know exactly what changed from one revision to the other, please consult the file REVISIONS in the distribution.

2.15 (August, 2003)

• Added templates.

2.10 (October 25, 2002)

• Added documentation section: mapping an Entity bean to multiple tables
• Added documentation section: FAQ an Entity bean to multiple tables

2.7 (June 27, 2002)

• Added file generation tags
• WebLogic 7 support

2.2 (Oct 30, 2001)