www.ironjacamar.orgCommunity Documentation

IronJacamar 1.1 User's Guide

Connecting your Enterprise Information Systems

To all Java EE Connector Architecture users, and especially the IronJacamar community

Table of Contents

Preface
1. About IronJacamar
2. Why IronJacamar ?
3. Versions
3.1. IronJacamar 1.1
3.2. IronJacamar 1.0
4. The team
5. Thanks to
6. License
1. Introduction
1.1. What's New
1.1.1. Java Connector Architecture 1.7
1.1.2. Java Connector Architecture 1.6
1.2. Overview
1.2.1. Outbound resource adapter
1.2.2. Inbound resource adapter
2. Download
2.1. Download
2.2. Maven repository
2.3. Git Access
3. Installation
3.1. Compressed Tape Archive (.tar.gz)
3.2. Zip Archive (.zip)
3.3. Directory structure
3.4. WildFly
4. Configuration
4.1. IronJacamar server
4.1.1. Using the leak detector pool
4.1.2. Allow obtaining connections during MARKED_FOR_ROLLBACK
4.1.3. Disable enlistment trace
4.1.4. Disable delistResource calls
4.2. Logging service
4.3. Transaction service
4.4. JCA
4.4.1. Deployer
4.4.2. Work manager
4.4.3. Security
4.5. Datasources
4.6. Web server
5. Deployment
5.1. Packaging requirements
5.2. Deploying resource adapters
5.2.1. Resource adapter descriptor
5.2.2. Resource adapter extensions
5.2.3. Resource adapter statistics
5.3. Deploying datasources
5.3.1. Datasource descriptor
5.3.2. Datasource extensions
5.3.3. Datasource statistics
5.4. General deployment settings
5.4.1. Flush strategies
5.4.2. Capacity policies
6. Running
6.1. Starting the container
6.2. Stopping the container
6.3. Command line interface
6.3.1. Deploy
6.3.2. Undeploy
6.3.3. Shutdown
6.4. Apache Ant
6.4.1. Start
6.4.2. Stop
6.4.3. Deploy
6.4.4. Undeploy
6.4.5. Ping
6.5. Apache Maven
6.5.1. Start
6.5.2. Stop
6.5.3. Deploy
6.5.4. Undeploy
6.5.5. Ping
7. Validator
7.1. Introduction
7.2. Reports
7.3. Running the standalone validator
7.4. Apache Ant integration
7.4.1. Usage
7.5. Apache Maven integration
7.5.1. Usage
8. Code generator
8.1. Introduction
8.2. Functionality
8.3. Running the tool
8.3.1. Developer Input
8.4. Generated code
8.4.1. Apache Ant build environment
8.4.2. Apache Ant + Ivy build environment
8.4.3. Gradle build environment
8.4.4. Apache Maven build environment
9. Eclipse plugin
9.1. Installation of the plugin
9.2. Configuration of the plugin
9.3. The toolbar
9.4. The menu
9.5. Creating a new IronJacamar project
9.5.1. Project and package name
9.5.2. Creating a ResourceAdapter
9.5.3. Creating a ManagedConnectionFactory
9.5.4. Creating a MessageListener
9.5.5. Creating an AdminObject
9.5.6. Selecting the build environment
9.6. Validate IronJacamar project
9.7. Deploying an IronJacamar project
9.7.1. Deploying a RAR file to an IronJacamar server
9.7.2. Generate the -ra.xml and deploy it to IronJacamar server
10. Other tools
10.1. Resource adapter information tool
10.2. Migration tool
10.2.1. Resource adapters
10.2.2. Data sources
11. Embedded
11.1. Overview
11.2. Configuration
11.3. Usage
11.3.1. Simple usage
11.3.2. Advanced usage
12. EIS test server
12.1. Overview
12.2. Apache Ant
12.3. Apache Maven
13. Community
13.1. Website
13.2. User forum
13.3. Developer forum
13.4. Issue tracking
14. Troubleshooting
14.1. I think I have found a bug
14.2. I would like to implement a feature
14.3. How do I ?
A. Schemas
A.1. Java EE Connector Architecture 1.7
A.2. Java EE Connector Architecture 1.6
A.3. Java EE Connector Architecture 1.5
A.4. Java EE Connector Architecture 1.0
A.5. IronJacamar 1.0
A.6. IronJacamar 1.1
A.7. Resource adapters 1.0
A.8. Resource adapters 1.1
A.9. Datasources 1.0
A.10. Datasources 1.1
A.11. Datasources 1.2
B. Samples
B.1. HelloWorld example
B.1.1. Introduction
B.1.2. HelloWorld Resource Adapter
B.1.3. HelloWorld Managed Connection Factory
B.1.4. HelloWorld Managed Connection
B.1.5. HelloWorld Connection Factory
B.1.6. HelloWorld Connection Factory Implementation
B.1.7. HelloWorld Connection
B.1.8. HelloWorld Connection Implementation
B.1.9. HelloWorld Managed Connection MetaData
B.1.10. HelloWorld ironjacamar.xml
B.1.11. HelloWorld Connection Test Case
B.1.12. HelloWorld Ant build.xml
B.2. HelloWorld/Native example
B.2.1. Introduction
B.2.2. HelloWorld/Native Resource Adapter
B.2.3. HelloWorld/Native Managed Connection Factory
B.2.4. HelloWorld/Native Managed Connection
B.2.5. HelloWorld/Native Connection Factory
B.2.6. HelloWorld/Native Connection Factory Implementation
B.2.7. HelloWorld/Native Connection
B.2.8. HelloWorld/Native Connection Implementation
B.2.9. HelloWorld/Native Managed Connection MetaData
B.2.10. HelloWorld/Native ironjacamar.xml
B.2.11. HelloWorld/Native C
B.2.12. HelloWorld/Native Connection Test Case
B.2.13. HelloWorld/Native Ant build.xml
B.2.14. HelloWorld/Native cmake
B.3. HelloWorld/Lazy example
B.3.1. Introduction
B.3.2. HelloWorld/Lazy Resource Adapter
B.3.3. HelloWorld/Lazy Managed Connection Factory
B.3.4. HelloWorld/Lazy Managed Connection
B.3.5. HelloWorld/Lazy Connection Factory
B.3.6. HelloWorld/Lazy Connection Factory Implementation
B.3.7. HelloWorld/Lazy Connection
B.3.8. HelloWorld/Lazy Connection Implementation
B.3.9. HelloWorld/Lazy Managed Connection MetaData
B.3.10. HelloWorld/Lazy ironjacamar.xml
B.3.11. HelloWorld/Lazy Connection Test Case
B.3.12. HelloWorld/Lazy Ant build.xml
C. Datasources
C.1. PosgreSQL
C.2. PosgreSQL XA
C.3. MySQL
C.4. MySQL XA
C.5. H2
C.6. H2 XA
C.7. Derby
C.8. Derby XA
C.9. Oracle
C.10. Oracle XA
C.11. Microsoft SQLServer
C.12. Microsoft SQLServer XA
C.13. IBM DB2
C.14. IBM DB2 XA
D. Logging codes
D.1. Core: 000000 - 009999
D.2. Common: 010000 - 019999
D.3. Deployers: 020000 - 029999
E. Licenses
E.1. GNU Lesser General Public License 2.1
E.1.1. Preamble
E.1.2. Terms and Conditions for Copying, Distribution and Modification
E.1.3. How to Apply These Terms to Your New Libraries
E.2. Creative Commons Attribution–Share Alike 3.0 Unported License
E.2.1. Definitions
E.2.2. Fair Dealing Rights
E.2.3. License Grant
E.2.4. Restrictions
E.2.5. Representations, Warranties and Disclaimer
E.2.6. Termination
E.2.7. Miscellaneous
E.3. Apache License, Version 2.0
E.3.1. Definitions
E.3.2. Grant of Copyright License
E.3.3. Grant of Patent License
E.3.4. Redistribution
E.3.5. Submission of Contributions
E.3.6. Trademarks
E.3.7. Disclaimer of Warranty
E.3.8. Limitation of Liability
E.3.9. Accepting Warranty or Additional Liability

List of Tables

2.1. Maven artifacts
4.1. IronJacamar options
4.2. Resource adapter deployer configuration
4.3. Resource adapter deployer
4.4. Resource adapter metadata deployer
4.5. Resource adapter activator
4.6. DsXmlDeployer
4.7. Web server
5.1. Main elements
5.2. Bean validation groups elements
5.3. Connection definition / admin object attributes
5.4. Connection definition elements
5.5. Pool elements
5.6. XA pool elements
5.7. Security elements
5.8. Time out elements
5.9. Validation elements
5.10. Admin object elements
5.11. Recovery elements
5.12. Core statistics
5.13. Common datasource attributes
5.14. datasource elements
5.15. xa-datasource elements
5.16. Pool settings
5.17. XA pool settings
5.18. Security settings
5.19. Validation settings
5.20. Time out settings
5.21. Statement settings
5.22. Recovery elements
5.23. Driver attributes
5.24. Driver elements
5.25. Core statistics
5.26. JDBC statistics
5.27. Flush strategies
5.28. Size policy properties
5.29. Watermark policy properties
5.30. Size policy properties
5.31. Watermark policy properties
7.1. Validator report
7.2. Apache Ant: validator
7.3. Apache Maven: validator
8.1. Code generator arguments
8.2. Developer input
8.3. Apache Ant build environment
8.4. Apache Ant + Ivy build environment
8.5. Gradle build environment
8.6. Apache Maven build environment
D.1. Logging codes for core
D.2. Logging codes for common
D.3. Logging codes for deployers