GlassFish - World's first Java EE 7 Application Server


JDBC and Connectors GlassFish v3 Documentation Plan

People and Roles

Name Role Location Time Zone Email
Chinmayee Srivathsa Documentation Feature Owner Bangalore, India IST chinmayee.srivathsa@sun.com
TBD Additional Writers - - -
Jagadish Ramu Engineer Bangalore, India IST jagadish.ramu@sun.com
Shalini Muthukrishnan Engineer Bangalore, India IST shalini.muthukrishnan@sun.com

Audience

  • Developers use JDBC resources and connection pools to connect to databases from their applications.
  • Administrators configure/change the settings of JDBC resources, connector resources, connection pools, and the connector service to improve performance
  • Developers create and deploy standalone connector modules and embedded resource adapters.

Summary of the Feature

Changes to JDBC and Connectors are visible to the user through the Admin Console, CLI commands, and through the domain.xml file.

Users would use the JDBC and Connector Resources for:

  • Setting up Database Access (involves creating and configuring JDBC resources and connection pools, setting up database drivers)
  • Deploying a Standalone Connector Module (involves creating and configuring connector resources, connection pools, and administered objects)
  • Deploying an Embedded Resource Adapter (involves creating and configuring connector resources and connection pools)
  • Configuring Resources and Connection Pools
  • Tuning Resources and Connection Pools
  • Creating and Configuring JDBC Realms for Web and EJB applications

Availability

This feature is part of the all GlassFish v3 distributions.

Statement of Work

This section describes in detail for each document the work that is required by the introduction of the feature, such as changes, addition of new material, relocation of existing material, and removal of existing material.

Documentation Impact:

  • None
  • Minor
  • Moderate
  • Major
  • New

Note - If a document is task based (as opposed to reference), the changes should be determined from the user task analysis for the feature.

Changes to Books

Support for generating resource definitions in NetBeans and Eclipse should be documented in the NetBeans and Eclipse plugin docs.

Administration Guide Changes

Section Doc Impact Writer Reviewers Description of Change
Setting up the Database None Dixie Pine Jagadish, Shalini, Shaline No change. Retain the v3 Prelude content as is.
Creating/Deleting a Connector Resource None Dixie Pine Jagadish, Shalini, Shaline No change
Editing a Connector Resource Moderate Dixie Pine Jagadish, Shalini, Shaline Add list of connector resource attributes that can be modified . Specify if any of these changes require a restart.
Creating/Deleting a Connector Connection Pool Minor Dixie Pine Jagadish, Shalini, Shaline The connection pool will be automatically tested for valid connectivity when it is created, by setting a new attribute ping to true.
Editing a Connector Connection Pool Minor Dixie Pine Jagadish, Shalini, Shaline Add new attributes and changes to attributes, if any.
Creating/Deleting an Administered Resource Object None Dixie Pine Jagadish, Shalini, Shaline None
Editing an Administered Resource Object Moderate Dixie Pine Jagadish, Shalini, Shaline Add list of administered resource object attributes
Configuring the Connector Service NEW Dixie Pine Jagadish, Shalini, Shaline Add link to MQ documenation
Creating/Deleting a JDBC Resource NEW Dixie Pine Jagadish, Shalini, Shaline For content for this topic, refer the Admin Console online help, create-jdbc-resource man page, and this blog entry by Jagadish
Editing a JDBC Resource NEW Dixie Pine Jagadish, Shalini, Shaline For content for this topic, refer the Admin Console online help, create-jdbc-resource man page, and this blog entry by Jagadish
Creating/Deleting a JDBC Connection Pool None Dixie Pine Jagadish, Shalini, Shaline No change
Editing a JDBC Connection Pool Moderate Dixie Pine Jagadish, Shalini, Shaline Add new attributes and changes to attributes: statement-cache-size, connection-validation-method, init-sql, sql-trace-listeners, associate-with-thread-connections-count, switch-off-pooling, ping. Certain tasks listed in the user task analysis page, such as Enabling Statement Caching, are covered within this topic.
Supported JDBC Drivers Moderate Dixie Pine Jagadish, Shalini, Shaline Update the list of JDBC drivers
How JDBC Resources and Connection Pools Work Together None Dixie Pine Jagadish, Shalini, Shaline No change
Setting Up Database Access Minor Dixie Pine Jagadish, Shalini, Shaline Add links for each step (creating, configuring JDBC resources)
Testing and Flushing the Connection Pool NEW Dixie Pine Jagadish, Shalini, Shaline New attribute called ping and new asadmin command called flush-connection-pool
Monitoring the JDBC Connection Pool NEW Dixie Pine Jagadish, Shalini, Shaline Uses the new GFProbes framework . ]
Monitoring Application-Scoped Resources NEW Dixie Pine Jagadish, Shalini, Shaline Application scoped resources is a new concept being introduced in v3. See one-pager for more details.
Dotted Names Moderate Dixie Pine Jagadish, Shalini, Shaline List the dotted names of the new elements (for example. the dotted name for connector work-security-map)
How GlassFish v3 automatically detects newly installed JDBC drivers NEW Dixie Pine Jagadish, Shalini, Shaline New feature in v3.
How JDBC resources and Connection pools work together None Dixie Pine Jagadish, Shalini, Shaline No change
Concepts::JDBC Resources, Connector Resources, JDBC Connection Pools, Connector Connection Pool None Dixie Pine Jagadish, Shalini, Shaline No change
Connector Security Map, Connector Work Context Security Maps , Application Scoped Resources NEW Dixie Pine Jagadish, Shalini, Shaline Descriptions for these new features. Connector Security Map is an old feature but has no description in the docs.

Note: All JDBC-related topics to be grouped under the Administering Database Connectivity chapter that has been created in the GFv3 Prelude Admin guide. All Connector-related topics to be grouped under another chapter (called Administering Connectors?).

Application Deployment Guide Changes

Section Doc Impact Writer Reviewers Description of Change
Deploying a Java EE CA Connector Module (move from Developer's guide) Moderate Dixie Pine Jagadish, Shalini, Shaline - Move deployment-related content from Developer's guide - Add links to configuration tasks in Administration Guide
Redeploying a Connector Module (move from Developer's guide) Moderate Dixie Pine Jagadish, Shalini, Shaline Mention new option called --cascade-resources
Deploying and Configuring an Embedded Resource Adapter (move from Developer's guide) Moderate Dixie Pine Jagadish, Shalini, Shaline Need to expand this topic. More information required before we can improve this topic
Application Scoped Resources NEW Dixie Pine Jagadish, Shalini, Shaline See one-pager
Viewing Application Scoped Resources NEW Dixie Pine Jagadish, Shalini, Shaline list-resources or list-XXX-resources commands with the --appname option
Creating and Removing Application Scoped Resources during Deployment NEW Dixie Pine Jagadish, Shalini, Shaline deploy command with the new --cascade-resources option
sun-resources.xml file NEW June Parks Jagadish, Shalini, Shaline New deployment descriptor for application scoped resources

Application Development Guide Changes

Section Doc Impact Writer Reviewers Description of Change
Developing Connectors Moderate June Parks Jagadish, Shalini, Shaline - Update link to Java EE tutorial - Mention the latest Connector 1.6 spec
Developing Connectors > Connector Support in Enterprise Server Moderate June Parks Jagadish, Shalini, Shaline Connector 1.6 support in GF v3
Developing Connectors > Advanced Connector Configuration Options Moderate June Parks Jagadish, Shalini, Shaline Connector Work Security Maps associate-with-thread attribute flush-connection-pool ping attribute invalid connections changes disabling pooling application-scoped connectors
Developing Connectors > Advanced Connector Configuration Options > Creating a Resource Adapter Config -   - Move to Application Deployment Guide
Developing Connectors > Deploying and Configuring a Stand-Alone Connector Module -   - Move to Application Deployment Guide
Developing Connectors > Deploying and Configuring an Embedded Resource Adapter -   - Move to Application Deployment Guide
Inbound Communication Support Minor June Parks Jagadish, Shalini, Shaline TBD
Outbound Communication Support NEW June Parks Jagadish, Shalini, Shaline TBD
Resource Adapters for Inbound and Outbound Communication Support NEW June Parks Jagadish, Shalini, Shaline TBD
Configuring a Message-Driven Bean to use a Resource Adapter Minor June Parks Jagadish, Shalini, Shaline TBD
Built-In Custom Resource Factories NEW June Parks Jagadish, Shalini, Shaline Use built-in factories to create custom resources
Using the JDBC API for Database Access Minor June Parks Jagadish, Shalini, Shaline (Refer June's Doc plan for the Dev guide) - Statements - Connections - Transactions

Domain File Format Reference Changes

Section Doc Impact Writer Reviewers Description of Change
jdbc-resource None June Parks Jagadish, Shalini, Shaline No change.
connector-resource None June Parks Jagadish, Shalini, Shaline No change.
admin-object-resource None June Parks Jagadish, Shalini, Shaline No change.
connector-service None June Parks Jagadish, Shalini, Shaline No change.
jdbc-resource None June Parks Jagadish, Shalini, Shaline No change.
connector-connection-pool Moderate June Parks Jagadish, Shalini, Shaline Changes to this element are listed here
jdbc-connection-pool Moderate June Parks Jagadish, Shalini, Shaline Changes to this element are listed here
work-security-map NEW June Parks Jagadish, Shalini, Shaline New element under the connector-module element. See here

Upgrade Guide Changes

Section Doc Impact Writer Reviewers Description of Change
Compatibility Impact Moderate Chinmayee Jagadish, Shalini, Shaline Default values for a few attributes have changed.

Performance Tuning Guide Changes

Section DocImpact Writer Reviewers Description of Change
Tuning the Server > Resources > Moderate   Jagadish, Shalini, Shaline More information about maxpoolsize?

Changes to Online Help

Topic Title Doc Impact Writer Reviewers Description of Change
Clearing the JDBC Connection Pool NEW Kim Haase Jagadish, Shalini, Shaline New button called "flush" in the GUI, in the JDBC Connection Pool page.
Creating the Connector Work Security Map NEW Kim Haase Jagadish, Shalini, Shaline New page or tab for creating the work security map, under the connector connection pool page
Automatic detection of JDBC drivers NEW Kim Haase Jagadish, Shalini, Shaline A drop-down list of JDBC drivers will automatically include newly installed JDBC drivers. Mention this point in the JDBC Resources page.
Monitoring JDBC Connection Pools Moderate Kim Haase Jagadish, Shalini, Shaline  
Monitoring Application-Scoped Resources NEW Kim Haase Jagadish, Shalini, Shaline Application scoped resources is a new concept being introduced in v3. See one-pager for more details.
Editing JDBC Connection Pool Moderate Kim Haase Jagadish, Shalini, Shaline Mention the new attributes and changes to default values.
Editing Connection Connection Pool Moderate Kim Haase Jagadish, Shalini, Shaline Mention the new attributes and changes to default values.

Changes to Man Pages

Man Page Name and Section Doc Impact Writer Reviewers Description of Change
flush-connection-pool NEW Paul Davies Jagadish, Shalini, Shaline New command for clearing the connection pool.
create-connector-connection-pool Moderate Paul Davies Jagadish, Shalini, Shaline Mention the new options for the new attributes and changes to default values.
create-jdbc-connection-pool Moderate Paul Davies Jagadish, Shalini, Shaline Mention the new options for the new attributes and changes to default values.
create-jdbc-resource None Paul Davies Jagadish, Shalini, Shaline No change.
create-connector-resource None Paul Davies Jagadish, Shalini, Shaline No change
create-connector-security-map None Paul Davies Jagadish, Shalini, Shaline No change
create-connector-work-security-map NEW Paul Davies Jagadish, Shalini, Shaline New asadmin command
delete-connector-work-security-map NEW Paul Davies Jagadish, Shalini, Shaline New asadmin command
list-connector-work-security-maps NEW Paul Davies Jagadish, Shalini, Shaline New asadmin command
update-connector-work-security-map NEW Paul Davies Jagadish, Shalini, Shaline New asadmin command
set Moderate Paul Davies Jagadish, Shalini, Shaline Add sample commands to change connector-service attributes. There is no CLI command for configuring connector-service attributes.
deploy Minor Paul Davies Jagadish, Shalini, Shaline When the deploy command, is used for reploying (with --force=true), you can use a new option called --cascade-resources.
list-jdbc-resources Minor Paul Davies Jagadish, Shalini, Shaline New option called --appname
list-connector-resources Minor Paul Davies Jagadish, Shalini, Shaline New option called --appname. This option applies to list-XXX-resources.
Other man pages None Paul Davies - No changes

Review Schedule

The review schedule for the documentation items that are affected by this feature is provided in the following table.

Item First Draft Start Date First Draft End Date Second Draft Start Date Second Draft End Date Final Version End Date Final Version End Date
             
             
             

Reviewers are listed in the Statement of Work.

Related Information

Email aliases:

  • [admin@glassfish.java.net]
  • [users@glassfish.java.net]
  • [docs@glassfish.java.net]