WAR (file format)


In software engineering, a WAR file is a file used to distribute a collection of JAR-files, JavaServer Pages, Java Servlets, Java classes, XML files, tag libraries, static web pages and other resources that together constitute a web application.

Content and structure

A WAR file may be digitally signed in the same way as a JAR file in order to allow others to determine where the source code came from.
There are special files and directories within a WAR file:
Assuming production environments do not promote a fix without sufficient testing prior to deployment, a WAR file has a distinct advantage when properties files are used to identify environment specific variables. For example, an LDAP server in a TEST environment may be something like ldaps://testauth.company.com:636. The LDAP server in a production environment is ldaps://auth.company.com:636. An external properties file would define the link with some thing like:
LINKED_PAGE=ldaps://testauth.company.com:636
The source code reads the property file to determine the target LDAP server. In this way, developers can be certain that the WAR file tested and verified is exactly the same as that which is being promoted to production.

Disadvantages of WAR files

Some consider web deployment using WAR files to be disadvantageous when minor changes to source code are required for dynamic environments. Each change to source code must be repackaged and deployed in development. This does not require stopping the web server if configured for runtime deployment.

Example

The following sample web.xml file demonstrates the declaration and association of a servlet:


PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN"
"http://java.sun.com/j2ee/dtds/web-app_2_2.dtd">


HelloServlet
mypackage.HelloServlet


HelloServlet
/HelloServlet



Resource reference to a factory for javax.mail.Session
instances that may be used for sending electronic mail messages,
preconfigured to connect to the appropriate SMTP server.

mail/Session
javax.mail.Session
Container



The /WEB-INF/classes directory is on the ClassLoader's classpath. The /WEB-INF/classes directory contains the classes associated with the web application itself.
Any JAR files placed in the /WEB-INF/lib directory will also be placed on the ClassLoader's classpath.