Portal: Portlet packaging structure

Developing > Persistence layer > WebSphere Commerce integration with WebSphere Portal

Portlet packaging structure

The WebSphere Commerce Portlet is provided as a WAR file for the portal administrator to install to the Portal Server.
These are the major items in this package:

WebSphere Commerce MVCPortlet class
Communication service library
WebSphere Commerce service client libraries
WebSphere Commerce foundation tag library
Web application deployment descriptor, portlet deployment descriptor, tag library configuration files, and MVC configuration files
Portlet JSP files and resource bundles
This portlet application requires two deployment descriptors:

The portlet deployment descriptor provides the portal server with information about the portlet resources in the application, including configuration, support characteristics, and localized titles. The portal server uses this information to provide services for the portlet. This file is always named portlet.xml.
The Web application descriptor provides the application server with information about the Web resources in the application. This file is always named web.xml.
Directory structure
The WAR file of the Portlet application has the following directory structure.

Directory Description

/ Root directory of the portlet file structure.
/wsdl Location for cooperative portlet configuration files.
/jsp Location for JSP files.
/WEB-INF Location for all protected resources. The /WEB-INF directory stores the portlet descriptor document and all of the runtime executable JAR files and classes that the packaged portlet requires. The portlet information directory is not part of the public document tree of the application. Files that reside in /WEB-INF are not served directly to a client.
/WEB-INF/config/base Location of all the core and bootstrap configuration files that cannot be customized.
/WEB-INF/config/ext Location of all customizable configuration files.
/WEB-INF/lib Location for storing portlet JAR files, such as component client libraries.
/WEB-INF/classes Location for portlet class files. Individual class files should be stored in a directory structure within /WEB-INF/classes that reflects the class package.
/WEB-INF/classes/nl Location for portlet resource bundles.
/WEB-INF/classes/config Location for WebSphere Commerce service binding configuration files.
/WEB-INF/wsdl Location for WebSphere Commerce service deployment configuration files.
/META-INF Location for the manifest file, manifest.mf. The manifest is in the standard JAR file format as defined by the Java 1.3 specification. Files that reside in /META-INF are not served to clients.

Packaging portlets
When development is complete, portlets are packaged into WAR files for deployment to the WebSphere Portal Server.

Related concepts

WebSphere Commerce integration with WebSphere Portal
Related tasks

Packaging portlets

Configure the sample portlets in the server environment
Last updated: 25 November 2009

Directory	Description
/	Root directory of the portlet file structure.
/wsdl	Location for cooperative portlet configuration files.
/jsp	Location for JSP files.
/WEB-INF	Location for all protected resources. The /WEB-INF directory stores the portlet descriptor document and all of the runtime executable JAR files and classes that the packaged portlet requires. The portlet information directory is not part of the public document tree of the application. Files that reside in /WEB-INF are not served directly to a client.
/WEB-INF/config/base	Location of all the core and bootstrap configuration files that cannot be customized.
/WEB-INF/config/ext	Location of all customizable configuration files.
/WEB-INF/lib	Location for storing portlet JAR files, such as component client libraries.
/WEB-INF/classes	Location for portlet class files. Individual class files should be stored in a directory structure within /WEB-INF/classes that reflects the class package.
/WEB-INF/classes/nl	Location for portlet resource bundles.
/WEB-INF/classes/config	Location for WebSphere Commerce service binding configuration files.
/WEB-INF/wsdl	Location for WebSphere Commerce service deployment configuration files.
/META-INF	Location for the manifest file, manifest.mf. The manifest is in the standard JAR file format as defined by the Java 1.3 specification. Files that reside in /META-INF are not served to clients.