Skip to main content

By clicking Submit, you agree to the developerWorks terms of use.

The first time you sign into developerWorks, a profile is created for you. Select information in your developerWorks profile is displayed to the public, but you may edit the information at any time. Your first name, last name (unless you choose to hide them), and display name will accompany the content that you post.

All information submitted is secure.

  • Close [x]

The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerworks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

By clicking Submit, you agree to the developerWorks terms of use.

All information submitted is secure.

  • Close [x]

Entity management in XML applications

Control how your XML app discovers and accesses entities

Leigh Dodds (leigh@xmlhack.com), Developer and editor, Ingenta, Ltd.
Photo of Leigh Dodds
Leigh Dodds is currently employed as an Engineering Manager at Ingenta. He has been developing applications on the Java platform since 1997, and has spent the last four years working with XML and related technologies. Leigh is also a contributing editor to xmlhack, and between February 2000 and June 2002, wrote the weekly "XML-Deviant" column for XML.com. He holds a Bachelors degree in biological Science, and a Masters in computing. As being the father of a lively 18 month old (Ethan) is a full-time job in itself, Leigh currently spends his copious amount of free time investigating how to improve the speed of manufacturing of Round Tuits, which he believes will revolutionize the parenting business.

Summary:  Entity management is the term used to describe the process for controlling how an XML application discovers and accesses external resources known as entities. Entity management is an often overlooked aspect of XML application development. However, the technique offers a number of advantages. This tutorial presents the basic principles of entity management through the concept of an XML catalog -- an address book that defines mappings from resources referenced in XML documents (such as a stylesheet or schema) to URI references (such as file system paths or URLs).

Date:  30 Sep 2003
Level:  Introductory PDF:  A4 and Letter (144 KB | 33 pages)Get Adobe® Reader®

Activity:  3552 views
Comments:  

Introduction

What is this tutorial about?

Entity management is the term used to describe the process for controlling how an XML application discovers and accesses external resources known as entities. Entity management is an often overlooked aspect of XML application development; however, the technique offers a number of advantages, including:

  • Increased robustness, by removing sensitivity to network failures
  • Better security, by reducing the opportunity for external resources to be compromised
  • Improved performance, by reducing sensitivity to network bottlenecks
  • Greater interoperability, by granting local control over how resources are located

This tutorial presents the basic principles of entity management through the concept of an XML catalog -- an address book that defines mappings from resources referenced in XML documents (such as a stylesheet or schema) to URI references (such as file system paths or URLs). A catalog is therefore used to control the external resources that an application accesses. The XML Catalog specification, which provides a standard means of describing these catalogs using a simple XML format, is also introduced using working examples.

Tutorial examples use the open source Resolver API, provided as part of the Apache XML Commons project, to demonstrate entity management in practice as well as to illustrate how to implement an XML application with XML catalog support through the Java API for XML Parsing (JAXP).

Should I take this tutorial?

This tutorial is aimed at Java developers who are already familiar with XML application development, particularly JAXP. While some examples illustrate how entity management works in conjunction with XSL transformations, no detailed knowledge of XSLT is required. For pointers to other tutorials covering JAXP and XSLT, see Resources.

This tutorial will also be of interest to application developers who want to learn more about XML catalogs in general so that they may get the most flexibility from applications that already provide support for entity management using the OASIS XML Catalog format. A number of open source XML frameworks and parsers, including Apache Cocoon, already include this support.

Tools

To compile and run the Java examples and applications introduced later in the tutorial, the reader will need a Java 2 Development Kit installed. The Java 2 SDK 1.4.2 can be downloaded from http://java.sun.com/j2se/.

Other than a text or XML editor for viewing the example documents, no other tools are required.

See Installing the XML Commons Resolver classes for instructions on how to download and configure the Apache XML Resolver classes used throughout the examples.

The tutorial examples are available from x-entmngexamples.zip. To install the examples, simply extract the files from the archive (preserving the directory structure) into a newly created directory. This directory, referred to as $EXAMPLES_HOME throughout the rest of the tutorial, contains the following sub-directories:

1 of 9 | Next

Comments



Help: Update or add to My dW interests

What's this?

This little timesaver lets you update your My developerWorks profile with just one click! The general subject of this content (AIX and UNIX, Information Management, Lotus, Rational, Tivoli, WebSphere, Java, Linux, Open source, SOA and Web services, Web development, or XML) will be added to the interests section of your profile, if it's not there already. You only need to be logged in to My developerWorks.

And what's the point of adding your interests to your profile? That's how you find other users with the same interests as yours, and see what they're reading and contributing to the community. Your interests also help us recommend relevant developerWorks content to you.

View your My developerWorks profile

Return from help

Help: Remove from My dW interests

What's this?

Removing this interest does not alter your profile, but rather removes this piece of content from a list of all content for which you've indicated interest. In a future enhancement to My developerWorks, you'll be able to see a record of that content.

View your My developerWorks profile

Return from help

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=XML
ArticleID=153752
TutorialTitle=Entity management in XML applications
publish-date=09302003
author1-email=leigh@xmlhack.com
author1-email-cc=dwxed@us.ibm.com

Tags

Help
Use the search field to find all types of content in My developerWorks with that tag.

Use the slider bar to see more or fewer tags.

Popular tags shows the top tags for this particular content zone (for example, Java technology, Linux, WebSphere).

My tags shows your tags for this particular content zone (for example, Java technology, Linux, WebSphere).

Use the search field to find all types of content in My developerWorks with that tag. Popular tags shows the top tags for this particular content zone (for example, Java technology, Linux, WebSphere). My tags shows your tags for this particular content zone (for example, Java technology, Linux, WebSphere).

Try IBM PureSystems. No charge.