JBoss.orgCommunity Documentation

Apache jUDDI Guide


Alex O'Ree

Apache Software Foundation (ASF)
Apache Software Foundation (ASF), http://juddi.apache.org
Legal Notice

We’d like to dedicate this guide to Steve Viens and Andy Cutright who started this project back in 2003.

Table of Contents

1. Universal Description, Discovery and Integration (UDDI)
1.1. UDDI Protocol, Specification
1.2. UDDI Registry
1.3. jUDDI Project
2. Getting Started
2.1. Prerequisites
2.2. What should I Download?
2.3. Running jUDDI
2.4. Using the jUDDI Administrative Interface
2.5. Using jUDDI Web Services
2.6. Using jUDDI GUI to create your keygenerator and business
2.7. Running the demos in the disto
2.8. Examples on the jUDDI blog
2.9. What is new in jUDDI 3.2?
3. jUDDI Architecture
3.1. jUDDI Server
3.1.1. UDDI API layer uddi-ws using JAX-WS
3.1.2. Core UDDI juddi-core using JPA
3.1.3. Relational Databases
3.1.4. Servlet Containers
3.2. jUDDI GUI juddi-gui.war
4. Administration
4.1. Changing the Web Server Listen Port
4.2. Administering Users and Access Control
4.2.1. Administrative Users
4.2.2. End Users
4.3. Configuration Database Connections
4.3.1. Derby Out-of-the-Box
4.3.2. Switching to another Database
4.3.3. Switch to MySQL on Tomcat using OpenJPA
4.3.4. Switch to Postgres on Tomcat using OpenJPA
4.3.5. Switch to Postgres on JBoss using Hibernate
4.3.6. Switch to Oracle on Tomcat using Hibernate
4.3.7. Switch to HSQL on Tomcat using Hibernate
4.3.8. Switch to other db
4.3.9. Override persistence properties in the juddiv3.xml
4.4. Logging
4.5. Administering the GUI (juddi-gui.war)
4.6. Task: Signing the Digital Signature Applet jar file
4.7. Administrating your jUDDI Instance using the Administrative Console
4.8. Configure jUDDI
4.8.1. Enabling Remote Access
4.9. Monitoring the Status and Statistics
4.9.1. Statistics
4.9.2. Status
4.10. Accessing the jUDDIv3 API
4.11. Security Guidance
4.11.1. jUDDI Server
4.11.2. jUDDI Client (and developers)
4.11.3. jUDDI GUI (Web user interface)
4.12. Backups, Upgrading and Data Migration
4.12.1. Database Backups
4.12.2. Config Backup
4.13. Upgrading jUDDI
4.14. Scaling jUDDI and Federation
4.14.1. Scaling the jUDDI Services (multiple servers)
4.14.2. Limitations of jUDDI
5. jUDDI Server Configuration (juddiv3.xml)
5.1. Authentication
5.2. Startup
5.3. Email
5.4. Query Properties
5.5. RMI Proxy
5.6. Key Generation and Cryptography
5.7. Subscription
5.8. Custody Transfer
5.9. Validation
5.10. Deploying two or more jUDDI server on the same application server
5.11. jUDDI GUI Configuration
5.12. jUDDI Client uddi.xml Settings
5.13. Encryption Keys
5.14. Customizing the juddi-gui
6. UDDI Seed Data
6.1. Seed Data Files
6.2. Tokens in the Seed Data
6.3. Customer Seed Data
7. How to deploy jUDDI To?
7.1. Tomcat
7.1.1. OpenJPA and CXF
7.1.2. Hibernate and CXF
7.1.3. OpenJPA and Axis2
7.2. JBoss
7.2.1. JBossAS 6.0.0.GA
7.2.2. JBossAS 7.x/JBossEAP-6.x
7.3. Deploying to Glassfish
7.3.1. Glassfish jars
7.3.2. Configure the JUDDI datasource
7.3.3. Add juddiv3-cxf.war
7.3.4. Run jUDDI
8. Extending UDDI
8.1. Authentication modules
8.2. Subscription Notification Handlers
8.3. KeyedReference Value Set Validation Services
8.4. Cryptographic Providers
8.5. jUDDI Client Transport
9. Digital Signatures
9.1. Requirements
9.2. Using Digital Signatures using the jUDDI GUI
9.3. Frequently Asked Questions
10. Troubleshooting jUDDI
10.1. jUDDI Web Services, juddiv3.war
10.1.1. Enable debugging logging
10.2. jUDDI GUI, juddi-gui.war
10.3. jUDDI Client Java
10.3.1. Enable debugging logging
10.4. jUDDI Client .NET
10.5. Getting help
11. Contributing to jUDDI
11.1. License guidance
11.2. SVN access
11.3. Project structure
11.4. Building and testing jUDDI
11.4.1. All Java Components
11.4.2. .NET
11.5. Other ways to Contribute to jUDDI
11.5.1. Bug Reports
11.5.2. Internationalization
11.5.3. Contributing Source code
11.5.4. Releases
11.6. What the?

List of Figures

1.1. Invocation Pattern using the UDDI Registry
2.1. jUDDI welcome page
2.2. jUDDI admin
2.3. Happy jUDDI.
2.4. Form login
2.5. Add Publisher
2.6. jUDDI Services
2.7. Getting an authToken using SoapUI
2.8. Create Key Generator
2.9. Create Business
3.1. jUDDI Architecture
3.2. jUDDI Client and Console Architecture
3.3. jUDDI Console Architecture
4.1. jUDDI Server Configuration Page.
4.2. jUDDI Server Statistics.
4.3. jUDDI MBeans.
4.4. jUDDI Server Status.
4.5. jUDDI API.

List of Tables

1.1. Supported UDDI Interfaces
1.2. jUDDI Features
1.3. Supported Sort Orders
1.4. Supported Find Qualifiers
4.1. Hibernate properties that can be referenced in the juddiv3.xml file
5.1. Authentication properties that can be referenced in the juddiv3.xml file
5.2. Startup properties that can be referenced in the juddiv3.xml file
5.3. As of 3.1.5, jUDDI supports Email delivery options for Subscription API functions. Email properties can be referenced in the juddiv3.xml file
5.4. Query properties that can be referenced in the juddiv3.xml file
5.5. UDDI Key generation properties that can be referenced in the juddiv3.xml file.
5.6. Subscription properties that can be referenced in the juddiv3.xml file.
5.7. Transfer properties that can be referenced in the _juddiv3.xml file.
5.8. These settings are for validating the data that users store in jUDDI. They can be referenced in the _juddiv3.xml file.
5.9. jUDDI GUI Configuration