Home > Articles > Programming > Java

  • Print
  • + Share This
This chapter is from the book

4.4 Recording Dependencies on Server Libraries

With servlet and JSP engines (or "containers") supporting the servlet 2.2 and JSP 1.1 API, there is no portable way to designate that a Web app depends on some shared library that is not part of the servlet or JSP API itself. You have to either copy the library's JAR file into the WEB-INF/lib directory of each and every Web application, or you have to make server-specific changes that lack mechanisms for verification.

With servlet version 2.3 (JSP version 1.2), you can use the META-INF/MANI-FEST.MF file to express dependencies on shared libraries. Compliant containers are required to detect when these dependencies are unfulfilled and provide a warning. Note that although support for these dependencies is a new capability in servlet version 2.3, the actual method of expressing the dependencies is the standard one for the Java 2 Platform Standard Edition, as described at http://java.sun.com/j2se/ 1.3/docs/guide/extensions/versioning.html. Furthermore, although the method for expressing dependencies is now standardized, the way to actually implement shared libraries is nonstandard. For example, with Tomcat 4, individual class files placed in install_dir/classes and JAR files placed in install_dir/lib are made available to all Web applications. Other servers might use an entirely different approach or might completely disallow code sharing across Web applications.

Creating a Manifest File

The MANIFEST.MF file is created automatically by the jar utility. Unless you are using shared libraries, you normally ignore this file altogether. Even if you do want to customize the manifest file so that you can use shared libraries more portably, you rarely edit it directly. Instead, you typically create a text file with a subset of manifest file entries and then use the m option to tell jar to add the contents of the text file to the autogenerated manifest file. For example, suppose that you have a file called myAppdependencies.txt that is in the top-level directory of your Web application. You can create a WAR file called myApp.war by changing directory to the top-level Web application directory and then issuing the following jar command.

jar cvmf myAppDependencies.txt myApp.war * 

There are two small problems with this approach, however. First, myApp-Dependencies.txt is actually part of the WAR file. This inclusion is unnecessary and may confuse the deployer who sees an unneeded file mixed in with index.jsp and other top-level Web files. Second, the WAR file itself (myApp.war) is created in the top-level directory of the Web application. It is slightly more convenient to place the WAR file one directory level up from there, so that configuration and archive files are kept distinct from the Web application contents. Both of these minor problems can be solved by use of the C option to jar, which instructs jar to change directories before adding files to the archive. You place myAppDependencies.txt one level up from the main Web application directory (myApp in the following example), change directory to the location containing myAppDependencies.txt, and issue the following jar command:

jar cvmf myAppDependencies.txt myApp.war -C myApp * 

This way, the dependency file and the WAR file itself are located in the directory that contains the top-level Web application directory (myApp), not in myApp itself. Note that it is not legal to go to the parent directory of myApp and then use a directory name when specifying the files, as below.

jar cvmf myAppDependencies.txt myApp.war myApp/* // Wrong! 

The reason this fails is that the name myApp incorrectly becomes part of all of the WAR entries except for MANIFEST.MF.

Contents of the Manifest File

OK, ok. So you know how to use jar to create manifest files. But what do you put in the manifest file that lets you specify dependencies on shared libraries? There are four main entries that you need, each of which consists of a single plain-text line of the form "Entry: value".

  • Extension-List. This entry designates one or more names of your choosing, separated by spaces. The names will be used in the rest of the manifest file to identify the library of interest. For example, suppose that several of your Web applications use JavaMail to send email. Rather than repeating the JavaMail JAR file in each and every Web application, you might use a server-specific mechanism to make it available to all Web applications. Then, your dependency file would contain a line like the following.

    Extension-List: javaMail 
  • name-Extension-Name. This entry designates the standard name for the library of interest. You cannot choose an arbitrary name here; you must supply the name exactly as it is given in the Extension-Name entry of the JAR file that contains the actual library of interest. For most standard extensions, the package name is used as the extension name. Note that the leading name must match whatever you specified for Extension-List. So, if the standard JavaMail JAR file uses an Extension-Nameof javax.mail, the first two entries in your dependency file would look like the following.

    Extension-List: javaMail javaMail-Extension-Name: javax.mail
  • name-Specification-Version. This entry gives the minimum required specification version of the library of interest. When the server finds an installed library, it compares the listed Specification-Versionto the minimum specified here. For example, if your Web apps require JavaMail version 1.2 or later, your dependency file might start as follows.

    Extension-List: javaMail 
    javaMail-Extension-Name: javax.mail 
    javaMail-Specification-Version: 1.2 
  • name-Implementation-URL. This entry lets you specify the location where the server can find the JAR file. Note, however, that it is unclear how many servers (if any) will automatically download the JAR file when necessary, rather than simply generating an error message. Combining all four entries results in a dependency file like the following.

    Extension-List: javaMail 
    javaMail-Extension-Name: javax.mail
    javaMail-Specification-Version: 1.2 
    javaMail-Implementation-URL: http://somehost.com/javaMail.jar 

Although these are the four most important entries, there are a number of other possible entries. For details, see http://java.sun.com/j2se/1.3/docs/guide/extensions/ver-sioning.html. For information on JavaMail, see http://java.sun.com/products/javamail/.

  • + 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