The structure of REST application WAR files

The REST application root directory. All the other files and folders described in this table are children of this directory.

You can add any files or sub-directories to the root directory.

A template for an application's welcome page.

The META-INF folderis a standard component of JAVA Web applications. and it contains the MANIFEST.MF file.

MANIFEST.MF contains context information about the environment in which the web application runs and is inserted as a standard addition to any WAR file generation. It can be used on the production deployment site to tailor some of the Web application context information.

Contains static files (HTML pages, graphics, JavaScript, etc.). It contains the default files and folders supplied.

Application developers may add any files and sub-directories to this folder.

A template for a page that appears after successful login and logout operations. It is the default referred to in:

/WEB-INF/appSecurity-form-local.xml

Contains the HTML files used for logging into and out of a REST application.

The files login.html, logout.html, and loginfail.html are templates that support HTTP form-based authentication, which is implemented in:

/WEB-INF/appSecurity-form-local.xml

Application developers and administrators may edit or extend these files.

Contains templates for customizing HTTP error messages.

The errorxxx. html files override the Java container's default error pages and provide a consistent output for all Java containers.

Application developers may add to or modify the error pages in this folder. New error pages must be defined in the /WEB-INF/web.xml deployment descriptor file.

The errorxxx. html files override the Java container's default error pages and provide a consistent output for all Java containers.

Application developers may add to or modify these error pages.

(Data Object Services only) Contains Data Service Catalog (.json) files that define Data Object Services hosted by the Web application.

Application developers can add other HTML, JavaScript (.js) or JSON data files for client upload in this folder. This can include entire web apps and their libraries that access the Data Object Services hosted by the Web application.

Contains configuration files (at the top level and in sub-directories) for the Web application.

Spring Framework security configuration templates for common authentication models. Only one of these models can be declared as active in the web.xml Web application deployment description file.

In addition, these files set the role-based access to URI resources, and set the authentication provider.

Application developers and administrators may edit or extend these files.

Configuration file that instantiates the Spring Framework enhancements, which extend the Web application framework. It is referenced in the Web application deployment descriptor, web.xml.

Application developers and administrators may edit or extend this file.

Defines test user accounts and is referenced by the /WEB-INF/appSecurity-xxxx.xml files as the default authentication provider.

The test user accounts should be deleted from a production deployment and replaced with more secure account storage.

The Web application deployment descriptor that references the objects for managing security, dynamic content, static content, and AppServer data services.

An application developer must modify web.xml to set the user authentication model. If the application is used by a mobile or Web app to access a hosted Data Object Service, the authentication model needs to match the mobile or Web app's authentication model.

An application administrator can modify web.xml to change the user authentication model.

Contains application properties, mapping, and log files.

Do not modify, or add to the contents of this folder.

Contains the service definition (.paar) file, which defines the Web application, AppName.

There can be multiple AppName folders in /WEB-INF/adapters but each folder can contain only one AppName.paar file.

PAAR files include all of the mappings (procedures, datasources and parameters) and other artifacts that define a service. They are created in the process of defining REST services in Progress Developers Studio. If there are multiple PAAR files, each must have its own unique URI space.

You should not manually edit AppName.paar files.

You can add additional AppName folders after deployment, however. see Manually Adding Additional Services to a REST Application for more information.

An XML file containing the runtime properties for connecting to an AppServer. This file is created at deployment time by the REST Management Agent using its default application properties.

Contains Web application log files.

Do not modify, or add to the contents of this folder, except for the .log files that require periodic maintenance.

Contains individual Java class files that can be loaded by a Web application.

Application developers add additional class files in this folder.

A production administrator will find the log4j.properties file here and control the logging for security, the 1pAdapters framework, and gateway to the AppServer Java client.

A properties file that controls the logging for security, the 1pAdapters framework, and the gateway to the AppServer Java client.

Application administrators modify this file to facilitate debugging.

Contains the runtime library files.

An application developer may add JAR files to support any dynamic JSP content generation or to extend the Spring Security framework functionality.