Home > Articles > Programming > Java

  • Print
  • + Share This
Like this article? We recommend

Like this article? We recommend

The Apache Jakarta Commons Digester Code Deployment Model

Given that I want to illustrate role-based IT management and dynamic upgrading, let’s now take a look at a mechanism for automatically creating the above Java classes from XML. This is done by unmarshalling the following XML document.

Notice that the XML tags correspond with the above class and subclass names and the associated data member names. For example, the tag <permanentstaff> matches the name of the subclass PermanentStaff. Once this tag is encountered during parsing, an object of the PermanentStaff class is instantiated with its data members set to the values indicated in the tags below it: <personName> and <socialSecurityNumber>. The XML file is well-formed, so all tags consist of start and end elements: <socialSecurityNumber> and </socialSecurityNumber>.

<?xml version="1.0"?>
<hrstaffdetails company="company">
  <permanentstaff>
  <personName>Francis Bacon</personName>
  <socialSecurityNumber>1111111</socialSecurityNumber>
  </permanentstaff>

  <permanentstaff>
  <personName>Francesca Bacon</personName>
  <socialSecurityNumber>2222222</socialSecurityNumber>
  </permanentstaff>

  <contractstaff>
  <personName>Francisco Bacon</personName>
  <socialSecurityNumber>3333333</socialSecurityNumber>
  </contractstaff>
</hrstaffdetails>

This is the key to using the Commons Digester: You can parse the XML files and create instances of arbitrarily complex class structures. This is a powerful facility because it allows for the flexible creation of objects in a location-independent fashion.

In other words, if I want to create an object of class A on machine X, I can simply define the XML file and run the Digester against it. The result is a newly instantiated object where I want it, when I want it.

I’ll be using this mechanism a little later to show how to upgrade classes. Again, this is just another case of using the flexibility of the Digester mechanism.

The Commons Digester class is used to process the above XML document based on the following patterns and rules:

<?xml version="1.0"?>
<digester-rules>
  <object-create-rule pattern="hrstaffdetails" classname="HRStaffDetails" />
  <set-properties-rule pattern="hrstaffdetails" >
  <alias attr-name="company" prop-name="company" />
  </set-properties-rule>

  <pattern value="hrstaffdetails/permanentstaff">
   <object-create-rule classname="PermanentStaff" />
   <call-method-rule pattern="personName" methodname="setPersonName"
   paramcount="0" />
   <call-method-rule pattern="socialSecurityNumber" 
    methodname="setSocialSecurityNumber" paramcount="0" />
   <set-next-rule methodname="addPermanentStaff" />
  </pattern>

  <pattern value="hrstaffdetails/contractstaff">
   <object-create-rule classname="ContractStaff" />
   <call-method-rule pattern="personName"
    methodname="setPersonName" paramcount="0" />
   <call-method-rule pattern="socialSecurityNumber" 
    methodname="setSocialSecurityNumber" paramcount="0" />
   <set-next-rule methodname="addContractor" />
  </pattern>
</digester-rules>

The above looks very complicated, but it’s really not! Let’s break it down a bit. The object-create-rule is invoked when the pattern hrstaffdetails is encountered. When this occurs, an object of the class HRStaffDetails is instantiated.

The next rule sets the properties of the class; in this case a company name is set. The next rule is called a pattern value and serves to create an instance of the class PermanentStaff.

The contained rule call-method-rule is used to invoke the base class method setPersonName, using the <personName> rule from the previous XML file.

The same mechanism occurs for the socialSecurityNumber pattern. The last rule for the PermanentStaff class is called set-next-rule, which in this case refers to the method HRStaffDetails.addPermanentStaff.

This completes the first part of unmarshalling an instance of HRStaffDetails. The rest of HRStaffDetails is unmarshalled using the remainder of the rules. The latter apply to the class ContractStaff and operate in a manner identical to that for the class PermanentStaff.

The last piece of the puzzle is the class that creates the Digester:

import org.apache.commons.digester.*;
import org.apache.commons.digester.xmlrules.*;

import java.io.*;
import java.util.*;

public class XmlRulesDriver
{
  public static void main(String[] args)
  {
   try
   {
     File input = new File(args[0]);
     File rules = new File(args[1]);
     Digester digester = DigesterLoader.createDigester(rules.toURL());
     HRStaffDetails staffDetails = (HRStaffDetails)digester.parse(input);
     System.out.println(staffDetails.toString());
   }
   catch(Exception e)
   {
     e.printStackTrace();
   }
  }
}

The above code reads the two XML files described earlier, namely hrstaffdetails.xml and rules.xml. Then, an instance of Digester is created, into which the file rules.xml is passed.

The Digester then parses the file hrstaffdetails.xml in conjunction with the rules file to produce an instance of the class HRStaffDetails.

All you need to get the code built are the following:

  • The above five Java classes
  • A copy of the commons-digester JAR file in your classpath

Specifically, you may find you’ll need the following JAR files in your CLASSPATH:

  • commons-digester-1.7.jar
  • commons-collections-3.2.jar
  • commons-logging-api-1.1.jar
  • commons-beanutils-core.jar

To manually run the program, type this command:

java XmlRulesDriver hrstaffdetails.xml rules.xml

The above command should produce the output displayed earlier in Figure 3. There is also a batch file (called ToRun.bat) supplied with the code to help you run the program.

Let’s now go back to Figure 3 and assume that the view in Figure 3 is that of all users—privileged and non-privileged.

Our HR director now decides that access is required to salary data. We want to be able to display salary and hourly rate details for the HR director as per Figure 2.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020