Specifies the username and password to use for connecting to the database via JTS. Example:

...
     (weblogicJTSConnPoolProperties
          user username
          password password
     ); end weblogicJTSConnPoolProperties
); end jdbc 

Note: The weblogicJTSConnPoolProperties property must be manually added to the deployment description.

JDBC Finders (finderDescriptors)

This property applies to JDBC persistent storage.

Finder properties are WebLogic's implementation of the EJB find methods. The finder properties are pairs of method signatures and expressions. The methods can be used to find EJBeans and always return an enumeration of EJBeans.

There are two steps to using the finder descriptors:

1. Define method signatures in the home interface. The method names must always start with the prefix "find". The Wizard will list all the finder methods in the home interface.

2. Using the Wizard, define the expression for each method signature.

Notes:

• If you use a non-primitive data type in a finder descriptor, you need to use a fully qualified name, such as java.sql.Timestamp.
• Finder descriptors always use EJB field names, not column names, excpet as shown below for the ordering of the returned beans.

The syntax of the expression is not fixed, and will change in the future.

Syntax

Expression prefix notation of [operator operand1 operand2]
where:

• operators:

  (   )   =   <   >   <=   >=   /   !   &   |   like isNull   isNotNull   orderBy

  ! is the Boolean not,   & is the Boolean and,   | is the Boolean or

• operands:
  • another expression;
  • an EJBean field or
  • when preceded by "$", a finder method parameter.

Examples

• Here is an expression that tests if balance > amount:

  "(> balance $amount)"

• Compound expressions can be used; note use of single quotes (') to distinguish strings:

  "(& (> bal $amount) (! (= accountType 'checking')))"

• This example is a method signature and an expression that is converted to a findBigAccounts method in the generated persistent storage class. The method returns an enumeration of beans of this class that satisfy this expression.

  "findBigAccounts(double amount)" "(> balance $amount)"

• Here is a method that finds all the EJBeans in a table:

  "findAll()" "(= 1 1)"

• Here is a method that finds all EJBeans whose lastName field starts with "M":

  "findNamesStartingWithM()" "(like lastName M%)"

• Here is a method that finds all EJBeans whose firstName field is null (you can use isNotNull for the opposite):

  "findNullFirstNames()" "(isNull firstName)"

• Here is a method that finds all EJBeans whose balance field is greater than balanceGreaterThan, and returns the beans ordered by the database column 'id'. Notice that this should all be on one line, and that no column mapping is performed -- the database column must be specified directly:

  "findOrderedAccounts(double balanceGreaterThan)"
    "(orderBy 'id' (> balance $balanceGreaterThan))"

• Identical to the previous, but returns the beans in descending order:

  "findOrderedAccounts(double balanceGreaterThan)"
    "(orderBy 'id desc' (> balance $balanceGreaterThan))"

Example: (from EJB Deployment Wizard)
This shows editing the expression for a finder "findBigAccounts".

Session-specific properties

Some properties are session bean-specific.

In the EJBean section:

 Stateful or stateless (stateManagementType)

This is the type of session EJBean; valid values are either STATELESS_SESSION or STATEFUL_SESSION.

 Timeout (sessionTimeout)

The transaction timeout for container-managed transactions of this EJBean.

Note that by definition all session EJBeans cannot be reentrant and the property Reentrant must be false.

In the Environment section:

 Stateful only (persistentDirectoryRoot)

The location for storing passivated stateful session beans using file persistence.

In the Clustering section:

 Stateless bean stub is clusterable (statelessBeanIsClusterable)

 Stateless bean methods are idempotent
  (statelessBeanMethodsAreIdempotent)

Reviewing the deployment descriptor settings

On this page, a list of all the deployment descriptor settings is shown for your review.

Check that everything has been entered correctly before proceeding to the next step of specifying the list of tasks to complete.

Specifying the tasks to complete

On this page you specify the tasks that you want the Wizard to complete. There are three different tasks that the Wizard will perform:

1. Update descriptor source

   This will update the source of the deployment descriptor.

2. Generate WebLogic interfaces for this bean

   This will take all the files and generate the WebLogic interfaces for this bean using the WebLogic EJB compiler ejbc. You need to specify the destination directory for the interface class files; typically, this is the point in your directory structure from where you want to deploy your EJBean. If you specify "Keep generated sources", the intermediate Java files generated by the compiler will be retained.

3. Create ASCII description file

   You can also write out the deployment descriptor to an ASCII file. This file can be input into the WebLogic EJB utility program DDCreator to create a serialized deployment descriptor.

Once you have specified the tasks, press Done to begin processing of the tasks by the Wizard.

Completing tasks and deploying the EJBean

On this final page, the Wizard performs the tasks you specified in the previous section. It will complete each task in order; the status for each task is shown to the right of the task name.

Note: when you are done and all tasks have successfully completed, you will still need to edit your weblogic.properties file to complete the deployment of your EJBean.

If any task fails, the entire task list is canceled. If there are any errors for a task, you can see messages and stack traces for that task by selecting the name of the task and then clicking the Error tab. You can then use the Back button to move to an earlier step, make changes, and then try the task list again.

You can also cancel the task list by pressing the Cancel button before the task list completes. Any changes to the deployment descriptor will be discarded and the temporary files deleted. You can then use the Back button to move to an earlier step, make changes, and then redeploy the EJBean.

IV. Text file format and index

Format for text deployment descriptor files

An alternative method for creating deployment descriptors is to enter the information into a text file and then use the WebLogic EJB utility DDCreator to create a serialized deployment descriptor that's to be included in the EJB-JAR (.jar) file. You specify that .jar file in the weblogic.ejb.deploy property in your weblogic.properties file.

You can use the textual description file to maintain a persistent form of your EJB deployment information.

The format of the text file is a series of nested sections that list the different properties that you are setting. A section begins with an opening parenthesis and ends with a closing parenthesis. Comments may be included in the text file; anything that appears after a semicolon (";") on a line is considered a comment.

The properties that you can use depend on whether you are describing an Entity EJBean or a Session EJBean. Examples for both entity and session beans are shown below.

• Comments are used to indicate the end of each section
• The examples show which sections are to be included
• At any level of nesting, the order of the sections doesn't matter
• Certain properties are included but have been commented out as not applicable
• The start of each section is show in bold face
• An index of different properties is included

Entity Descriptor

(EntityDescriptor
; For entity EJBeans, this file 
; must start with "(EntityDescriptor"
  beanHomeName                    entity.AccountHome
  enterpriseBeanClassName         example.entity.AccountBean
  homeInterfaceClassName          example.entity.AccountHome
  remoteInterfaceClassName        example.entity.Account
  isReentrant                     false
  (accessControlEntries
   DEFAULT                       [admin managers] 
  ); end accessControlEntries
  (controlDescriptors
    (DEFAULT
       isolationLevel             TRANSACTION_SERIALIZABLE
       transactionAttribute       TX_REQUIRED
       runAsMode                  CLIENT_IDENTITY
       runAsIdentity              admin
    ); end DEFAULT
  ); end controlDescriptors
  (environmentProperties
;   homeClassName               
;   ejbObjectClassName
    maxBeansInFreePool            20
    maxBeansInCache               100
    idleTimeoutSeconds            10
    isModifiedMethodName          isModified
    (finderDescriptors
      "findBigAccounts(double amount)" "> balance $amount"
    ); end finderDescriptors
    (clusterProperties
    ; Cluster-specific environment properties
      homeIsClusterable             true
    ; homeLoadAlgorithm
      statelessBeanIsClusterable    true
      statelessBeanMethodsAreIdempotent  false
    ); end clusterProperties
    (persistentStoreProperties
      persistentStoreType         jdbc 
      (jdbc
        tableName                ejbAccounts
        dbIsShared               false
        poolName                 ejbPool
        (attributeMap
          ; EJBean field     Database column name
          ; -----------------------------------------
          accountId              id
          balance                bal
        ); end attributeMap
      ); end jdbc
    ); end persistentStoreProperties
  ); end environmentProperties
  ; Entity EJBean-specific properties:
  primaryKeyClassName             example.entity.AccountPK
  containerManagedFields          [accountId balance]
  ; end entity EJBean-specific properties
); end EntityDescriptor

Session Descriptor

(SessionDescriptor
; For session EJBeans, this file 
; must start with "(SessionDescriptor"
  beanHomeName                    session.TraderHome 
  enterpriseBeanClassName         example.session.TraderBean
  homeInterfaceClassName          example.session.TraderHome
  remoteInterfaceClassName        example.session.Trader
  isReentrant                     false 
  ; Session EJBean-specific properties:
  stateManagementType             STATEFUL_SESSION
  sessionTimeout                  5; seconds
  ; end session EJBean-specific properties
  (accessControlEntries
    DEFAULT                       [admin traderAdmin] 
  ); end accessControlEntries
  (controlDescriptors
    (DEFAULT
       isolationLevel             TRANSACTION_SERIALIZABLE
       transactionAttribute       TX_REQUIRED
       runAsMode                  CLIENT_IDENTITY
       runAsIdentity              traderAdmin
    ); end DEFAULT
    (buy
       isolationLevel          TRANSACTION_SERIALIZABLE
       transactionAttribute    TX_REQUIRED
       runAsMode               CLIENT_IDENTITY
    ); end buy
  ); end controlDescriptors
  (environmentProperties
    (clusterProperties
    ; Cluster-specific environment properties
      homeIsClusterable             true
    ; homeLoadAlgorithm
    ; statelessBeanIsClusterable    true
    ; statelessBeanMethodsAreIdempotent  false
    ); end clusterProperties
    ; Application-specific environment properties
    (StockPrices
      ; Stock prices is a nested hash table
      WEBL   10.0
      INTL   15.0
    ); end Stock Prices
    tradeLimit                    500
    ; end Application-specific environment properties
;   homeClassName               
;   ejbObjectClassName
    maxBeansInFreePool            100
    maxBeansInCache               100
    idleTimeoutSeconds            5
    persistentDirectoryRoot       c:\mystore
  ); end environmentProperties
); end SessionDescriptor

Index of deployment descriptor properties

• accessControlEntries
• attributeMap
• beanHomeName
• clusterProperties
• containerManagedFields
• controlDescriptors
• dbIsShared
• delayUpdatesUntilEndOfTx
• ejbObjectClassName
• enterpriseBeanClassName
• EntityDescriptor
• environmentProperties
• file
• finderDescriptors
• homeClassName
• homeInterfaceClassName
• homeRouterClassName
• homeIsClusterable
• homeLoadAlgorithm
• homeStubIsReplicaAware
• homeStubReplicaHandler
• idleTimeoutSeconds
• isModifiedMethodName
• isolationLevel
• isReentrant
• jdbc
• weblogicJTSConnPoolProperties
• maxBeansInCache
• maxBeansInFreePool
• persistentDirectoryRoot
• persistentStoreProperties
• persistentStoreType
• poolName
• primaryKeyClassName
• remoteInterfaceClassName
• runAsIdentity
• runAsMode
• SessionDescriptor
• sessionTimeout
• statelessBeanCallRouterClassName
• statelessBeanLoadAlgorithm
• statelessBeanIsClusterable
• statelessBeanMethodsAreIdempotent
• statelessBeanStubIsReplicaAware
• stateManagementType
• tableName
• transactionAttribute

V. Change history

Release 4.0.3

We have added a new Deployment Descriptor environmental property called "delayUpdatesUntilEndOfTx". This optional optimization affects when changes to a bean's state are propogated to the persistent store. If the property is set to "true" (the default), updates of the persistent store of all beans in the transaction will be performed at the end of the transaction. If this is set to "false", the update of a bean's persistent store will be performed at the conclusion of each method invoke.

Previously, this optimization was enabled automatically which can cause problems in applications that utilize integrity constraints on the underlying database tables.

Fixed a problem with EJB Deployment Wizard passing the classpath to the EJB compiler.

Fixed a problem when the EJB Deployment Wizard opened a corrupted preferences file.

Fixed a problem with our extensions to the standard DeploymentDescriptors not implementing equals() correctly.

Added a note to this document that if you use a non-primitive data type in a finder descriptor, you need to use a fully qualified name, such as java.sql.Timestamp.

Release 4.0

Help is now available from within the deployment wizard by selecting "Help ¬ Using the Deployment Wizard".

The user interface has been simplified with new icons and displays.

A new option has been added under the "options" menu allowing you to specify colors used for display of selected information.

Clustering features can be specified.

New finder operators are documented.

Release 3.1.1

The behavior of the ejbc compiler has changed; if given a jar file, it will now unpack the jar file automatically.

Added caching for opened wizards to improve initialization performance on subsequent uses.

Added support for storing filenames of loaded deployment descriptors and other GUI-related startup information in the .ini file.

Added support to write out PersistenceDescriptor info to ASCII description file.

Set FieldTable to get reflection information about the bean's dependent class from the deployment descriptor.

Release 3.1

Fixed problems related to ObjectStorage configuration.

Fixed problems with loading and configuring .ser files.

Added support for reverting the deployment descriptor's state when cancelled.