SpringSource dm Server™ User Guide

Rob Harrop

Paul Kuzan

Sam Brannen

Damilola Senbanjo

Paul Harris

Christopher Frost

Ben Hale

SpringSource dm Server™

1.0.2.RELEASE

Copyright © SpringSource Inc., 2009


Table of Contents

1. Installing
1.1. Prerequisites
1.2. Installing from the ZIP Download
1.2.1. Downloading the ZIP file
1.2.2. Installing
1.2.2.1. Linux
1.2.2.2. Microsoft Windows
1.3. Post-installation steps
1.3.1. Set environment variable variables
1.3.1.1. JAVA_HOME
1.3.1.2. SERVER_HOME
2. Start and Stop SpringSource dm Server
2.1. Start
2.1.1. Linux
2.1.2. Microsoft Windows
2.2. Clean Start
2.2.1. Linux
2.2.2. Microsoft Windows
2.3. Start in debug mode
2.3.1. Linux
2.3.2. Microsoft Windows
2.4. Start with JMX Access Modifications
2.4.1. Linux
2.4.2. Microsoft Windows
2.5. Start with custom configuration directory
2.5.1. Linux
2.5.2. Windows
2.6. Stop
2.6.1. Linux
2.6.2. Microsoft Windows
3. The Web based Administration Console
3.1. Authentication with the Admin Console
3.2. The sections of the Admin Console
4. Provisioning Repository
4.1. Introduction
4.2. Repository Structure
4.3. Installing Bundles
4.4. Installing Libraries
4.5. Finding Bundles in the SpringSource Enterprise Bundle Repository
4.6. Configuring the repository
5. Serviceability
5.1. Log Files
5.2. Trace
5.2.1. Application Output
5.2.1.1. Per-application trace
5.2.1.2. System.out and System.err
5.2.2. Roll-over of trace files
5.3. Service Dumps
6. Working with Applications
6.1. Deploying Artifact
6.1.1. Hot Deploy
6.1.2. Manually Deploy
6.1.3. What Happens When You Deploy
6.1.4. Deployment Ordering
6.1.5. Restrictions
6.2. Undeploying an Artifact
6.2.1. Hot Undeploy
6.2.2. Manually Undeploy
7. Configuring the SpringSource dm Server
7.1. Configuring Serviceability
7.1.1. Configuring tracing
7.1.2. Configuring logging
7.1.3. Configuring dump files
7.2. Configuring the Embedded Tomcat Servlet Container
7.2.1. Servlet Container Configuration
7.2.2. Connector Configuration
7.2.3. Load Balancing Configuration
7.2.4. Cluster Configuration
7.2.5. Tomcat Configuration Files
7.3. Configuring Equinox
7.3.1. Configuring the telnet console
7.4. Configuring Deployment
7.4.1. Configuring the Deployment Timeout
7.5. Configuring the Provisioning Repository
7.5.1. Search Paths
7.5.1.1. Wildcards
7.5.1.2. System properties
7.5.2. Example configurations
7.5.2.1. Replace bundles/usr with an Ivy cache
7.5.2.2. Replace bundles/usr with a Maven local repository
8. Known Issues
8.1. Timeout During Startup Due to Firewall Settings
8.2. OutOfMemoryError: PermGen space running on Sun VM
9. Log Error Codes
9.1. Log Codes
9.1.1. Subsystem Codes
9.1.2. Error Number
9.1.3. Event Severity
9.2. Detailed Log Codes
9.2.1. Concurrent Log Codes
9.2.2. Control Log Codes
9.2.3. Config Log Codes
9.2.4. Deployer Log Codes
9.2.5. FFDC Log Codes
9.2.6. Bootstrap Log Codes
9.2.7. Kernel Log Codes
9.2.8. OSGi Log Codes
9.2.9. Profile Log Codes
9.2.10. Servlet Log Codes
9.2.11. Web Log Codes
10. Further Reading

1. Installing

1.1 Prerequisites

The SpringSource dm Server requires Java SE 5 or later to be installed. Java is available from Sun and elsewhere.

1.2 Installing from the ZIP Download

1.2.1 Downloading the ZIP file

SpringSource dm Server is distributed as a ZIP file. This can be downloaded from here. Follow the instructions to obtain a username and password.

1.2.2 Installing

1.2.2.1 Linux

To install the SpringSource dm Server on Linux, unzip the distribution package to the desired installation directory. For example, to install into /opt:

unzip springsource-dm-server-1.0.2.RELEASE.zip -d /opt

This creates a directory called springsource-dm-server-1.0.2.RELEASE under /opt.

SpringSource dm Server requires write access to the installation directory, in this case /opt/springsource-dm-server-1.0.2.RELEASE. Typically this means it must be run as the user that installed it, or the installation directory's ownership must be changed.

1.2.2.2 Microsoft Windows

To install the SpringSource dm Server on Windows, unzip the distribution package to the desired installation directory. You should use a zip application such as 7zip, not the built-in folder decompression. Note that both Windows and Java 5 have some issues with long file names and file paths, so we recommend installing to the root directory of your chosen drive.

1.3 Post-installation steps

1.3.1 Set environment variable variables

1.3.1.1 JAVA_HOME

The SpringSource dm Server uses the JAVA_HOME environment variable to locate the java executable. This environment variable must be configured to point to the home of a Java 5 or Java 6 installation.

1.3.1.2 SERVER_HOME

As a convenience it is recommended to create an environment variable that points to the SpringSource dm Server installation directory. Note that the SpringSource dm Server does not require that such an environment variable has been set. This variable may have any name of your choosing. The SpringSource dm Server's documentation assumes that the variable is named SERVER_HOME.

Linux

Edit the .profile file in your home directory to add the SERVER_HOME environment variable. For example, if you installed into /opt:

export SERVER_HOME=/opt/springsource-dm-server-1.0.2.RELEASE/
Microsoft Windows

From the Start menu, open the Control Panel and double-click on 'System'.

Click the 'Advanced' tab and select 'Environment Variables'. Next, click the 'Edit' button in the 'System Variables' section.

This will display the 'Edit System Variable' window. Enter SERVER_HOME as the 'Variable name' and the installation directory as the 'Variable value'. Click OK.

2. Start and Stop SpringSource dm Server

2.1 Start

To start SpringSource dm Server run the startup script for your platform.

2.1.1 Linux

To start SpringSource dm Server run startup.sh:

cd $SERVER_HOME
bin/startup.sh
	

Once SpringSource dm Server has started, the console will display a log message similar to the one shown below:

ingOsgiExtenderThread-38 <SPPM0002I> Server open for business with profile 'web'.
	

2.1.2 Microsoft Windows

To start SpringSource dm Server run startup.bat:

(Open a command line)
cd %SERVER_HOME%
bin\startup.bat
	

Once SpringSource dm Server has started console will display a log message similar to the one shown below:

ingOsgiExtenderThread-38 <SPPM0002I> Server open for business with profile 'web'.
		

2.2 Clean Start

To clean start SpringSource dm Server run the startup script for your platform. Clean starting removes the SERVER_HOME/work directory (and hence all) running applications, and all trace, log and dump files. It leaves the SERVER_HOME/repository and SERVER_HOME/pickup directories untouched, so any applications previously hot deployed will be reinstalled.

2.2.1 Linux

To start SpringSource dm Server run startup.sh -clean:

cd $SERVER_HOME
bin/startup.sh -clean
	

Once SpringSource dm Server has started, the console will display a log message similar to the one shown below:

ingOsgiExtenderThread-38 <SPPM0002I> Server open for business with profile 'web'.
	

2.2.2 Microsoft Windows

To start SpringSource dm Server run startup.bat -clean:

(Open a command line)
cd %SERVER_HOME%
bin\startup.bat -clean
	

Once SpringSource dm Server has started console will display a log message similar to the one shown below:

ingOsgiExtenderThread-38 <SPPM0002I> Server open for business with profile 'web'.
		

2.3 Start in debug mode

2.3.1 Linux

To start SpringSource dm Server in debug mode, run startup.sh passing in the -debug argument:

cd $SERVER_HOME
bin/startup.sh -debug
	

This will start the debug agent listening on port 8000 which is the default remote debug port used by Eclipse. To start in debug mode with a specific port number, pass this in as the value for the -debug argument:

cd $SERVER_HOME
bin/startup.sh -debug 8001
	

This will start the debug agent listening on port 8001. To start in debug mode and suspend the VM until a debugger attaches, pass in the -suspend argument along with the -debug argument:

cd $SERVER_HOME
bin/startup.sh -debug -suspend
	

This starts the debug agent, but prevents SpringSource dm Server from starting until a debugger attaches to the agent. This can be useful when trying to diagnose problems that occur during startup.

2.3.2 Microsoft Windows

To start SpringSource dm Server in debug mode, run startup.bat passing in the -debug argument:

cd %SERVER_HOME%
bin\startup.bat -debug
	

This will start the debug agent listening on port 8000 which is the default remote debug port used by Eclipse. To start in debug mode with a specific port number, pass this in as the value for the -debug argument:

cd %SERVER_HOME%
bin\startup.bat -debug 8001
	

This will start the debug agent listening on port 8001. To start in debug mode and suspend the VM until a debugger attaches, pass in the -suspend argument along with the -debug argument:

cd %SERVER_HOME%
bin\startup.bat -debug -suspend
	

This starts the debug agent, but prevents SpringSource dm Server from starting until a debugger attaches to the agent. This can be useful when trying to diagnose problems that occur during startup.

2.4 Start with JMX Access Modifications

The SpringSource dm Server always starts with JMX access enabled, allowing a management tool such as JConsole to be attached. By default both local attach access and remote access over SSL with username and password authentication are provided.

2.4.1 Linux

To start SpringSource dm Server with default JMX access enabled, run startup.sh passing in no arguments:

cd $SERVER_HOME
bin/startup.sh
				

This will start the SpringSource dm Server with JMX enabled for local attach. This allows for JConsole to be attached using the local connection option.

This will also start the SpringSource dm Server with JMX enabled for remote attach over SSL with username and password authentication. This allows for JConsole to be attached using the remote connection option on port 9875 with a default username and password of admin and springsource.

To start with the JMX remote access on a specific port number, pass this port number in as the value for the -jmxport argument:

cd $SERVER_HOME
bin/startup.sh -jmxport 9009
				

This will start the SpringSource dm Server with JMX enabled for remote attach on port 9009.

To start the JMX remote access using a custom username and password edit the file located at $SERVER_HOME/control/jmx-users.properties. If you wish to use a different file for authentication, pass this filename in as the value for the -jmxusers argument:

cd $SERVER_HOME
bin/startup.sh -jmxusers custom-jmx-users.properties
				

This will start the SpringSource dm Server with JMX enabled for remote attach using authentication credentials from custom-jmx-users.properties.

To start the JMX remote access using a custom SSL certificate edit the file located at $SERVER_HOME/control/keystore. If you wish to use a different keystore, pass this filename in as the value for the -keystore argument and the keystore password in as the value for the -keystorePassword argument:

cd $SERVER_HOME
bin/startup.sh -keystore customKeystore -keystorePassword customeKeystorePassword
				

This will start the SpringSource dm Server with JMX enabled for remote attach using an SSL certificate from customKeystore with a password of customKeystorePassword.

2.4.2 Microsoft Windows

To start SpringSource dm Server with default JMX access enabled, run startup.sh passing in no arguments:

cd %SERVER_HOME%
bin\startup.sh
				

This will start the SpringSource dm Server with JMX enabled for local attach. This allows for JConsole to be attached using the local connection option.

This will also start the SpringSource dm Server with JMX enabled for remote attach over SSL with username and password authentication. This allows for JConsole to be attached using the remote connection option on port 9875 with a default username and password of admin and springsource.

To start with the JMX remote access on a specific port number, pass this port number in as the value for the -jmxport argument:

cd %SERVER_HOME%
bin\startup.sh -jmxport 9009
				

This will start the SpringSource dm Server with JMX enabled for remote attach on port 9009.

To start the JMX remote access using a custom username and password edit the file located at %SERVER_HOME%\control\jmx-users.properties. If you wish to use a different file for authentication, pass this filename in as the value for the -jmxusers argument:

cd %SERVER_HOME%
bin\startup.sh -jmxusers custom-jmx-users.properties
				

This will start the SpringSource dm Server with JMX enabled for remote attach using authentication credentials from custom-jmx-users.properties.

To start the JMX remote access using a custom SSL certificate edit the file located at %SERVER_HOME%\control\keystore. If you wish to use a different keystore, pass this filename in as the value for the -keystore argument and the keystore password in as the value for the -keystorePassword argument:

cd %SERVER_HOME%
bin\startup.sh -keystore customKeystore -keystorePassword customeKeystorePassword
				

This will start the SpringSource dm Server with JMX enabled for remote attach using an SSL certificate from customKeystore with a password of customKeystorePassword.

2.5 Start with custom configuration directory

The -configDir option can be used to specify a config directory rather than using the default SERVER_HOME/config directory. This option allows the same SpringSource dm Server installation to be used to run multiple instances. Simply create a config directory for each instance, specifying unique port numbers, logging and tracing directories, etc. and specify that directory when starting SpringSource dm Server.

Note that if the path specified with -configDir is relative it will be interpreted as being relative to the root of the SpringSource dm Server installation.

2.5.1 Linux

To start SpringSource dm Server using a config directory of /config/node1:
cd $SERVER_HOME
bin/startup.sh -configDir /config/node1
			

2.5.2 Windows

To start SpringSource dm Server using a config directory of c:\config\node1:
cd $SERVER_HOME
bin/startup.sh -configDir c:\config\node1
			

2.6 Stop

2.6.1 Linux

To stop a running instance of SpringSource dm Server, run shutdown.sh from a new console prompt:

cd $SERVER_HOME
bin/shutdown.sh
	

To stop a running instance of SpringSource dm Server immediately, bypassing normal shutdown processing, run shutdown.sh from a new console prompt with the -immediate option:

cd $SERVER_HOME
bin/shutdown.sh -immediate
	

2.6.2 Microsoft Windows

To stop a running instance of SpringSource dm Server, run shutdown.bat:

cd %SERVER_HOME%
bin\shutdown.bat
	

To stop a running instance of SpringSource dm Server immediately, bypassing normal shutdown processing, run shutdown.bat with the -immediate option:

cd %SERVER_HOME%
bin\shutdown.bat -immediate
	

3. The Web based Administration Console

3.1 Authentication with the Admin Console

To use the SpringSource Admin Console, you must start the SpringSource dm Server and then enter the following address in your browser of choice.

http://localhost:8080/admin

Replace 'localhost' with the hostname of the system on which the SpringSource dm Server is running if it is not your local machine. The Admin Console uses basic security, therefore you will need to enter the default id and password.

ID: admin 
Password: springsource
		

To change the id and password for the Admin Console, go to the following file, which is in the standard Tomcat format. Change the 'username' and 'password' values. The Admin Console runs against the admin role, therefore this cannot be changed.

$SERVER_HOME/config/servlet/tomcat-users.xml

3.2 The sections of the Admin Console

The main page displays several sections. The main section is a list of the installed artifacts and the modules that comprise them. The standard install of the dm Server will have two artifacts - the Admin Console itself and a splash screen application. As these artifacts both contain web components, a link is provided to view them in your browser.

The other fields in the table give the 'Name' of the artifact, which will be the file name if none is supplied. The 'Origin' describes how the artifact was deployed. The possible values are 'Hot Deployed' as described above, 'Admin Console' if deployed through the console and 'Programmatic' if deployed programmatically, that is, through the integrated artifact deployer in the SpringSource dm Server Tools. The version will be '0' if none is supplied from the artifact. The 'Date' shows when the artifact was last deployed to the dm Server.

The Admin Console allows you to upload a file, which will be deployed automatically to the SpringSource dm Server. Once the artifact is deployed it will appear in the list of artifacts in the Admin Console. Please note that the GUI for uploading varies according to the browser and operating system used.

When clicked, the 'Upload' button reloads the page. This may take a few seconds while the file is uploaded and deployed. The list of artifacts will display the newly deployed artifacts. If there have been any problems, you can check the status message at the top of the page. This message will otherwise report 'Application deployed'.

For more information on how to work with artifacts see the chapter entitled Chapter 6, Working with Applications.

At the bottom of the main page is a section giving details of the dm Server you have accessed. This may be useful for verifying that you have accessed the correct instance.

4. Provisioning Repository

4.1 Introduction

In SpringSource dm Server, all third-party dependencies needed by your applications, such as Spring Framework and Hibernate, are stored in the provisioning repository. All of these dependencies are stored as valid OSGi bundles in the provisioning repository. Dependencies that are not valid OSGi bundles are not supported.

When an application is installed, if it has a dependency that cannot be satisfied from the bundles that have already been installed, the SpringSource dm Server will search the repository for a bundle that can satisfy that dependency. Dependencies between applications and third-party libraries are typically expressed using Import-Package or Import-Library (see Programmer's Guide).

Some third-party dependencies consist of multiple bundles but are logically one unit. To support this, the SpringSource dm Server introduces the concept of a library. A library is a collection of related bundles that can be referenced as a whole. More details on the creation and usage of libraries can be found in the Programmer's Guide.

Making a third-party dependency available to your application is simply a matter of adding its bundle or library to the appropriate location in the provisioning repository.

4.2 Repository Structure

By default, the provisioning repository is located at $SERVER_HOME/repository and consists of three main directories: bundles, libraries and installed.

The bundles directory contains all the bundles available in the repository. The libraries directory contains all the library definitions. Note that libraries reference bundles that are installed elsewhere in the repository, e.g. by default under the bundles directory. The installed directory is used by the SpringSource dm Server at runtime, and should not contain used bundles or libraries.

The bundles directory is further subdivided into three directories: ext, subsystems and usr.

The ext and usr directories are intended to contain third-party bundles, with ext containing bundles supplied with the SpringSource dm Server and usr containing bundles installed by the end user. The subsystems directory is for internal use only.

The libraries directory is similarly organized, with an ext and usr directory. As with bundles, new libraries should be installed into libraries/usr.

4.3 Installing Bundles

To install a bundle into the bundle repository, copy it into the $SERVER_HOME/repository/bundles/usr directory. Bundles must have unique names so it is considered best practice to include the version number in the file name, allowing for multiple versions of the bundle to be installed.

In some cases the SpringSource dm Server manages to automatically detect changes in its provisioning repository at runtime, thereby avoiding the need to restart the dm Server.

Of specific relevance during development is picking up changes to an application's direct dependencies during deployment of the application. For example, if you deploy an application and receive a message that a dependency is missing, you can simply add the dependency to the repository and then redeploy the application. The redeploy will cause the new dependency to be picked up, allowing progress to be made without restarting the dm Server. For other changes such as addition of indirect dependencies, the SpringSource dm Server must be restarted to pick up any changes to the provisioning repository.

4.4 Installing Libraries

To install a library, copy its definition into the $SERVER_HOME/repository/libraries/usr directory. Ensure that all referenced bundles have been installed as well.

4.5 Finding Bundles in the SpringSource Enterprise Bundle Repository

The SpringSource Enterprise Bundle Repository is located here.

You can find bundles in the repository using a number of options. You use the 'Search' facility by typing in a keyword. The matching criteria returned can be explored by name, symbolic name, class, package or resource.

There is also the option of clicking on 'Browse by Bundle'. This gives an alphabetical list of bundles. You can select the desired bundle to see details and find the download link. Finally, you can also choose to 'Browse by Library', which allows you to browse the alphabetical list of libraries in the repository.

4.6 Configuring the repository

Details of how to configure a SpringSource dm Server installation's provisioning repository can be found in the Configuration chapter.

5. Serviceability

5.1 Log Files

Log files are low-volume logs of important events in SpringSource dm Server. Each message written to a log file is accompanied by a 9-digit log code enclosed in angle brackets. An example is shown below:

[2008-03-08 17:25:28.007] server-dm-13 <SPSC0000I> - Creating ServletContainer on port 8080
		

For a breakdown of the code meanings, see the Section 9.1, “Log Codes”. By default, log files are stored in $SERVER_HOME/serviceability/logs.

5.2 Trace

The SpringSource dm Server's trace support serve two main purposes:

  • It provides global trace files that capture high-volume information regarding the SpringSource dm Server's internal events. The files are intended for use by support personnel to diagnose runtime problems.
  • It provides application trace files that contain application-generated output. This includes output generated using popular logging and tracing APIs, as well as output generated by calls to System.out and System.err. These files are intended for use by application developers and system administrators.

Entries in trace files are of the form <timestamp> <thread-name> <source> <level> <entry-text>. For example:

[2008-05-15 09:09:46.940] server-dm-2 org.apache.coyote.http11.Http11Protocol I Initializing Coyote HTTP/1.1 on http-48080
	    

By default, trace files are stored in $SERVER_HOME/serviceability/trace.

5.2.1 Application Output

SpringSource dm Server provides advanced support for capturing and tracing application-generated output. It automatically partitions trace on a per-application basis and will also capture any System.out and System.err output and direct it to the generating application's trace.log file.

5.2.1.1 Per-application trace

SpringSource dm Server uses SLF4J-based implementations of both Commons Logging and Log4J to route output generated by applications using those APIs to its trace files. In addition to appending such output to the global trace.log it will also append it to an application-specific trace file.

SpringSource dm Server writes application-specific trace to a file in a subdirectory of the configured trace directory. As described above this directory is, by default, SERVER_HOME/serviceability/trace. The subdirectory's name is of the form <application-name>-<version>. So, for example, an application named com.myapp at version 1 will write its trace to a file in SERVER_HOME/serviceability/trace/com.myapp-1/.

The levels used to filter per-application trace can be configured by using a header in the application's manifest specifying a comma-separated list of package and class names. For example:

Application-TraceLevels: *=info,com.myapp.*=verbose
                

This example manifest header will enable info level tracing for everything other than classes in the com.myapp package for which verbose level tracing will be enabled.

5.2.1.2 System.out and System.err

SpringSource dm Server captures, and traces, all output generated via System.out and System.err. This means that such output will be written to both the global trace.log file and to the trace file specific to the application that generated the output. The trace entries for System.out and System.err output are of the form:

[2008-05-16 09:28:45.874] server-tomcat-thread-1 System.out I Hello world!
[2008-05-16 09:28:45.874] server-tomcat-thread-1 System.err E Hello world!
			

As you can see the third column indicates where the output came from, i.e. System.out or System.err and, as indicated by the fourth column, System.out is traced at the Info level, and System.err is traced at the error level.

5.2.2 Roll-over of trace files

SpringSource dm Server will automatically roll-over a trace file once it reaches a size of 100MB. Up to four rolled-over files will be retained in addition to the trace.log file to which new output is appended.

5.3 Service Dumps

A service dump is triggered when one of the following events occurs:

  1. A failure is detected in the SpringSource dm Server code

  2. A thread deadlock is detected

A service dump contains a snapshot of all the important state from the running SpringSource dm Server instance. This snapshot is not intended for end user consumption but is useful for service personnel.

By default, service dumps are created in $SERVER_HOME/serviceability/dump.

6. Working with Applications

6.1 Deploying Artifact

Artifacts can be deployed into the SpringSource dm Server using either the hot-deploy directory on the file system or by using the admin console.

6.1.1 Hot Deploy

To hot deploy an artifact, copy it into the $SERVER_HOME/pickup directory:

cp myapp.par $SERVER_HOME/pickup

When the artifact is deployed, a message similar to the following will appear in the log (time stamps omitted):

[2008-03-08 17:00:00.000] <SPDE0010I> - Deployment of 'myapp.par' version '0' completed.

If there is a problem with the deployment the console and log will both show an error message to help with troubleshooting.

6.1.2 Manually Deploy

To use the SpringSource Admin Console please see the chapter entitled Chapter 3, The Web based Administration Console.

The Admin Console allows you to upload a file, which will be deployed automatically, from your local system to the SpringSource dm Server. Once the artifact is deployed it will appear in the list of artifacts in the Admin Console. Using the upload panel shown below, you can select a file. Please note that the GUI for uploading varies according to the browser and operating system used.

When clicked, the 'Upload' button reloads the page. This may take a few seconds while the file is transmitted and deployed. The list of artifacts will display the newly deployed artifact. If there have been any problems, you can check the status message at the top of the page. This message will otherwise report that 'Application deployed'.

The other fields in the table give the 'Name' of the artifact, which will be the file name if none is supplied. The 'Origin' describes how the artifact was deployed. The possible values are 'Hot Deployed' as described above, 'Admin Console' if deployed through the console and 'Programmatic' if deployed programmatically, that is, through the integrated artifact deployer in the SpringSource dm Server Tools. The version will be '0' if none is supplied. The 'Date' shows when the artifact was last deployed to the dm Server. Finally, the 'Type' tells you if it is an OSGi application or not.

6.1.3 What Happens When You Deploy

When an artifact is deployed by either method it is copied to the 'work' directory of the SpringSource dm Server file structure. Several other activities take place, for example: it is registered with the SpringSource dm Server, any dependencies it has are checked to see if deployment can go ahead, and finally it is started. Because of this just dropping an artifact into the 'work' directory will not deploy the artifact.

6.1.4 Deployment Ordering

When deploying bundles that have dependencies it is important that you deploy them in the correct order. The SpringSource dm Server will honor this ordering when redeploying artifacts on startup.

If you are using hot deployment, be sure to copy artifacts into the pickup directory one-by-one. Copying the files in one group provides no guarantees of ordering.

6.1.5 Restrictions

The SpringSource dm Server does not support deploying fragment bundles.

6.2 Undeploying an Artifact

Artifacts can be undeployed from the SpringSource dm Server using either the hot-deploy directory on the file system, or by using the admin console.

6.2.1 Hot Undeploy

To hot-undeploy an artifact, remove the corresponding artifact from the $SERVER_HOME/pickup directory:

cd $SERVER_HOME/pickup rm myapp.par

When the artifact is undeployed, a message similar to the following will appear in the log:

[2008-03-08 17:00:05.000] <SPDE0012I> - Undeployment of 'myapp.war' version '0' completed.

6.2.2 Manually Undeploy

When undeploying an artifact you can only undeploy a whole artifact. You cannot undeploy the separate modules/bundles of an application. Each artifact that can be undeployed has a link to the right of the list of artifacts. Once you click the undeploy link, the page will be reloaded with that artifact removed from the list.

The only artifact that cannot be undeployed from the Admin Console is the Admin Console itself. This can be undeployed manually from the hot deploy directory if needed.

If any problems have occurred the status message at the top of the page will report the error.

7. Configuring the SpringSource dm Server

7.1 Configuring Serviceability

The serviceability subsystem of the SpringSource dm Server is configured in the server.config file found in the config directory of the dm Server installation. Any relative paths in this file are relative to the root of the installation.

7.1.1 Configuring tracing

The tracing component provides two configurable settings. For example:

"trace": {
    "directory": "serviceability/trace",
    "levels": {
        "*" : "info",
        "com.foo.*" : "verbose",
        "com.foo.TheClass" : "debug",
        "com.bar.AnotherClass" : "verbose"
    }
}

In this example, the tracing component will write its output to the SERVER_HOME/serviceability/trace directory. The trace component provides five different levels at which trace can be output. These are, in descending order of severity: error, warn, info, debug, and verbose. The configured levels govern what trace is output and what trace is filtered out. Trace levels can be configured for individual classes or for entire packages and package trees. In this example, every class has info level tracing enabled except for those in the com.foo package and its subpackages which have verbose level tracing enabled, com.foo.TheClass which has debug level tracing enabled, and com.bar.AnotherClass which has verbose level tracing enabled. When determining what level of trace is enabled for any given class, the tracing component will use the level of the most specific match, e.g. com.foo.TheClass is a more specific match than com.foo.*. Any classes that are not matched by any of the configured levels will have trace disabled.

7.1.2 Configuring logging

The logging component provides a single configurable setting. For example:

"logs": {
    "directory": "serviceability/logs"
}

In this example the logging component will write its output to the SERVER_HOME/serviceability/logs directory.

7.1.3 Configuring dump files

The dump file component provides a single configurable setting. For example:

"dump": {
    "directory": "serviceability/dump"
}

In this example, the dump file component will write its output to the SERVER_HOME/serviceability/dump directory.

7.2 Configuring the Embedded Tomcat Servlet Container

The SpringSource dm Server embeds an OSGi-enhanced version of the Tomcat Servlet Container in order to provide support for deploying Java EE WARs and Web Modules. The embedded Servlet container can be configured via the servletContainer.config file located in the SERVER_HOME/config directory. The following listing displays the default configuration distributed with the dm Server.

{
   "servletContainer": {
      "version": 1.0,
      /* configDir should be either an absolute path or relative to the SERVER_HOME directory */
      "configDir": "config/servlet",
      "hostName": "localhost",
      "jvmRoute": "jvm1",
      "listeners": [
         {
            /*
             * APR library loader.
             * Documentation at http://tomcat.apache.org/tomcat-6.0-doc/apr.html
             */
            "enabled": true,
            "className": "org.apache.catalina.core.AprLifecycleListener",
            "SSLEngine": "on"
         },
         {
            /*
             * Initialize Jasper prior to loading webapps.
             * Documentation at http://tomcat.apache.org/tomcat-6.0-doc/jasper-howto.html
             */
            "enabled": true,
            "className": "org.apache.catalina.core.JasperListener"
         }
      ],
      "connectors": [
         {
            /* 
             * HTTP Connector.
             * Documentation at http://tomcat.apache.org/tomcat-6.0-doc/config/http.html
             */
            "enabled": true,
            "port": 8080,
            "protocol": "HTTP/1.1",
            "connectionTimeout": 20000,
            "maxThreads": 150,
            "emptySessionPath": false,
            "redirectPort": 8443
         },
         {
            /* 
             * HTTPS Connector.
             * Documentation at http://tomcat.apache.org/tomcat-6.0-doc/config/http.html
             * and http://tomcat.apache.org/tomcat-6.0-doc/ssl-howto.html
             */
            "enabled": true,
            "port": 8443,
            "protocol": "HTTP/1.1",
            "scheme": "https",
            "connectionTimeout": 20000,
            "maxThreads": 150,
            "emptySessionPath": false,
            "clientAuth": false,
            /* keystoreFile should be a path relative to the configured value for servletContainer:configDir */
            "keystoreFile": "../control/keystore",
            "keystorePass": "changeit",
            "secure": true,
            "SSLEnabled": true,
            "sslProtocol": "TLS"
         },
         {
            /*
             * AJP Connector.
             * Documentation at http://tomcat.apache.org/tomcat-6.0-doc/config/ajp.html
             */
            "enabled": true,
            "port": 8009,
            "protocol": "AJP/1.3",
            "connectionTimeout": 20000,
            "redirectPort": 8443
         }
      ],
      "logs": {
         "perApplicationLogging": true,
         /* accessLogDir should be either an absolute path or relative to the SERVER_HOME directory */
         "accessLogDir": "serviceability/logs/access",
         "accessLogFormat": "long"
      },
      "threadPool": {
         "minSize": 25,
         "maxSize": 200,
         "keepAlivePeriod": 60000
      }
      /*
       * The next section of this file is configuration for Tomcat clustering.  By default this is disabled.
       */
      /*,
      "cluster": {
         "className": "org.apache.catalina.ha.tcp.SimpleTcpCluster",
         "channelSendOptions": 8,
         "heartbeatBackgroundEnabled": false,
         "manager": {
            "className": "org.apache.catalina.ha.session.DeltaManager",
            "expireSessionsOnShutdown": false,
            "notifyListenersOnReplication": true
         },
         "channel": {
            "className": "org.apache.catalina.tribes.group.GroupChannel",
            "membership": {
               "className": "org.apache.catalina.tribes.membership.McastService",
               "address": "228.0.0.4",
               "port": 45564,
               "frequency": 500,
               "dropTime": 3000
            },
            "receiver": {
               "className": "org.apache.catalina.tribes.transport.nio.NioReceiver",
               "address": "auto",
               "port": 4000,
               "autoBind": 100,
               "selectorTimeout": 5000,
               "maxThreads": 6
            },
            "sender": {
               "className": "org.apache.catalina.tribes.transport.ReplicationTransmitter",
               "transport": {
                  "className": "org.apache.catalina.tribes.transport.nio.PooledParallelSender"
               }
            },
            "interceptors": [
               {
                  "className": "org.apache.catalina.tribes.group.interceptors.TcpFailureDetector"
               },
               {
                  "className": "org.apache.catalina.tribes.group.interceptors.MessageDispatch15Interceptor"
               }
            ]
         },
         "valves": [
            {
               "className": "org.apache.catalina.ha.tcp.ReplicationValve",
               "filter": ""
            },
            {
               "className": "org.apache.catalina.ha.session.JvmRouteBinderValve"
            }
         ],
         "deployer": {
            "className": "org.apache.catalina.ha.deploy.FarmWarDeployer",
            "tempDir": "/tmp/war-temp/",
            "deployDir": "/tmp/war-deploy/",
            "watchDir": "/tmp/war-listen/",
            "watchEnabled": false
         },
         "clusterListeners": [
            {
               "className": "org.apache.catalina.ha.session.JvmRouteSessionIDBinderListener"
            },
            {
               "className": "org.apache.catalina.ha.session.ClusterSessionListener"
            }
         ]
      }*/
   }
}
[Tip]Disabling configuration elements

Listener and Connector configuration elements can be disabled by setting the enabled flag to false. This allows you to disable but still retain the configuration for such elements without the need to delete the configuration.

7.2.1 Servlet Container Configuration

The following table lists all top-level options for configuring the embedded Servlet container.

[Tip]Relative paths

If the configured path to a directory or file does not represent an absolute path, it will typically be interpreted as a path relative to the SERVER_HOME directory.

Table 7.1. Servlet Container Configuration Values

EntryDescriptionSupported ValuesDefault Value
version

The configuration schema version.

1.0N/A
configDir

The path to the Servlet container's config directory. This directory serves as the central location for implementation-specific configuration files. The config directory also serves as the base directory for any relative-path-based configuration resources for the Servlet container.

If the configured value does not represent an absolute path, it will be interpreted as a directory relative to the SERVER_HOME directory.

config/servletN/A
hostName

The host name to use for the Servlet container's default host.

Any valid hostname for the system on which the dm Server is running.localhost
jvmRoute A unique identifier for the Servlet container instance, used to configure a JVM route for load balancing. A unique text value, typically purely alpha-numeric.jvm1
listeners A list of LifecycleListener configuration elements. Consult the official Tomcat documentation for further information on available listeners. N/AN/A
connectors A list of Connector configuration elements. See the connector configuration section for details. N/AN/A
logs - perApplicationLogging

Boolean flag for enabling access logging on a per-application basis.

true or falsetrue
logs - accessLogDir

The path to the access log directory where HTTP requests to the Servlet container will be logged.

If the configured value does not represent an absolute path, it will be interpreted as a directory relative to the SERVER_HOME directory.

(see description)serviceability/logs/access
logs - accessLogFormat

The style to use for formatting the access log.

short or longlong
threadPool - minSize

The minimum number of threads to be kept in the Servlet Container's threadpool.

Any positive int25
threadPool - maxSize

The maximum number of threads to be kept in the Servlet Container's threadpool.

Any positive int200
threadPool - keepAlivePeriod

The period of time, in milliseconds, that an idle thread will be kept alive in the Servlet Container's threadpool.

Any positive int60000

7.2.2 Connector Configuration

The SpringSource dm Server supports JSON-based configuration of any connector supported by Apache Tomcat. See the default configuration above for syntax examples, and for further details on the configuration properties supported for various Connector implementations, consult the official Tomcat HTTP Connector documentation.

[Tip]Configuring SSL for Tomcat

The SpringSource dm Server distribution includes a preconfigured keystore file which contains a single self-signed SSL Certificate. The password for this keystore file is changeit. Please note that the provided keystore file is intended for testing purposes only. For detailed instructions on how to configure Tomcat's SSL support, consult the official Tomcat SSL Configuration HOW-TO.

7.2.3 Load Balancing Configuration

The SpringSource dm Server supports JSON-based configuration of the load balancing supported by tomcat. See the default configuration for syntax examples.

7.2.4 Cluster Configuration

The SpringSource dm Server supports JSON-based configuration of the clustering supported by Apache Tomcat. See the default configuration (which is disabled) for syntax examples, and for further details on the configuration properties support for Cluster implementations, consult the official Tomcat Clustering/Session Replication HOW-TO documentation.

7.2.5 Tomcat Configuration Files

In addition to the aforementioned configuration options, various parts of the embedded Tomcat Servlet container can be configured via the following files located in the Servlet container's configuration directory (see configDir above). The syntax and usage of each file comply with that of a standard Tomcat installation.

  • context.xml: XML based configuration file which will be loaded for each web application Context deployed on the dm Server.

  • tomcat-users.xml: XML based configuration file used to manage users, passwords, and roles for an in-memory security realm. This file is used by the dm Server to configure a MemoryRealm for the embedded Tomcat Servlet container.

  • web.xml: The default web.xml deployment descriptor used for all web applications deployed on the dm Server. As each web application is deployed, this file is processed, followed by the /WEB-INF/web.xml deployment descriptor packaged with the web application itself, if present.

7.3 Configuring Equinox

7.3.1 Configuring the telnet console

To change the telnet console's configuration, find the server.config file in the SERVER_HOME/config directory and edit the 'enabled' and 'port' entries in the 'osgiConsole' section. By default the console is enabled and listens on port 2401:

"osgiConsole" : {
    "enabled" : true,
    "port" : 2401
}

7.4 Configuring Deployment

7.4.1 Configuring the Deployment Timeout

To change the deployment timeout, edit the deployer.config file in the SERVER_HOME/config directory. The following listing displays the default configuration distributed with the dm Server.

{
    "deployer" : {
        "version" : 1.0,
        "deploymentTimeoutSeconds" : 30
    }
}

7.5 Configuring the Provisioning Repository

The locations which the SpringSource dm Server will include in its provisioning repository can be configured by editing the server.config file in the SERVER_HOME/config directory. The default locations are implied, rather than being explicitly defined in the configuration file. The default configuration is equivalent to the following node in the configuration file:

"provisioning" : {
    "searchPaths": [
        "repository/bundles/subsystems/{name}/{bundle}.jar",
        "repository/bundles/ext/{bundle}",
        "repository/bundles/usr/{bundle}",
        "repository/libraries/ext/{library}",
        "repository/libraries/usr/{library}"
    ]
}

This default configuration has five paths, each of which will be searched when locating entries for inclusion in the provisioning repository. The repository/bundles/subsystems/{name}/{bundle}.jar, repository/bundles/ext/{bundle}, and repository/libraries/ext/{library} are all required by a default installation and should always be included in a custom configuration.

7.5.1 Search Paths

Each search path defines a location that is included in that SpringSource dm Server's provisioning repository and will therefore be searched when looking for a library or bundle dependency. If a search path is relative its location is taken as being relative to the root of the installation, i.e. the SERVER_HOMEdirectory.

7.5.1.1 Wildcards

Search paths provide support for wildcards. In the entries above, the path segments surrounded by curly braces, e.g. {bundle} and {library}, are wildcards entries for a directory with any name. Allowing wildcards to be named in this way is intended to improve the readability of search path configuration.

In addition to supporting the above-described form of wildcards, SpringSource dm Server also supports Ant-style paths, i.e. * and ** can be used to represent any directory and any series of directories respectively. For example, repository/bundles/usr/{bundle} and repository/bundles/usr/* are directly equivalent.

A common usage of the ** wildcard is to allow dependencies stored in a directory structure of varying depth, e.g. a local Maven repository, to be provisioned by the SpringSource dm Server.

7.5.1.2 System properties

In addition to support for wildcards, system properties can also be used within a search path. System properties are referenced as ${system.property.name}, e.g. a search path of ${user.home}/repository/bundles will reference the repository/bundles directory in the user's home directory.

7.5.2 Example configurations

The following examples provide sample configuration that could be used for some common use cases.

7.5.2.1 Replace bundles/usr with an Ivy cache

"provisioning" : {
    "searchPaths": [
        "repository/bundles/subsystems/{name}/{bundle}.jar",
        "repository/bundles/ext/{bundle}",
        "${user.home}/.ivy2/cache/{org}/{name}/{version}/{bundle}.jar",
        "repository/libraries/ext/{library}",
        "repository/libraries/usr/{library}"
    ]
}

7.5.2.2 Replace bundles/usr with a Maven local repository

"provisioning" : {
    "searchPaths": [
        "repository/bundles/subsystems/{name}/{bundle}.jar",
        "repository/bundles/ext/{bundle}",
        "${user.home}/.maven/repository/**/{bundle}.jar",
        "repository/libraries/ext/{library}",
        "repository/libraries/usr/{library}"
    ]
}

8. Known Issues

8.1 Timeout During Startup Due to Firewall Settings

The dm Server will fail to start correctly if it is prevented from connecting to needed ports by the firewall. Typically this manifests as error SPPM0003E . Configuring the firewall to allow the dm Server process to bind to the necessary ports will prevent this error from occurring.

8.2 OutOfMemoryError: PermGen space running on Sun VM

As a result of Sun Java bug 4957990, the SpringSource dm Server may consume more PermGen space than expected when running with the server HotSpot compiler. This problem may be resolved by configuring the JAVA_OPTS environment variable to specify an increased MaxPermSize, for example -XX:MaxPermSize=128M.

9. Log Error Codes

9.1 Log Codes

Each log message is accompanied by a log code which is useful in understanding the current state of the dm Server. Log codes are of the form: 'SPXY1234L', where SP stands for Spring Server, XY stands for the subsystem code, 1234 represents the error number, and L conveys the level of severity of the event being logged.

9.1.1 Subsystem Codes

Below is the list of subsystem codes and their corresponding subsystems:

  • CC - Concurrent
  • CN - Control
  • CO - Config
  • DE - Deployer
  • FF - FFDC
  • KB - Bootstrap
  • KE - Kernel
  • OP - OSGi
  • PM - Profile
  • SC - Servlet
  • WE - Web

9.1.2 Error Number

The error numbers start from 0000 and typically increase by 1. There is no upper limit for error numbers.

9.1.3 Event Severity

  • E - Error
  • W - Warn
  • I - Info

Error denotes that there are problems in the dm Server, such as incorrect behaviour of the system. This is the most serious of the log events.

Warn denotes that errors exist, but they are not critical and may be overlooked.

Info provides information about events in the system that may be useful in diagnosing warnings and errors. Such events are not severe.

9.2 Detailed Log Codes

In each instance where they appear, %s represents a variable which will be substituted with a string, and %d represents a variable which will be substituted with a number.

9.2.1 Concurrent Log Codes

Table 9.1. Concurrent Log Codes

CodeMessage
CC0000E
  • Deadlock(s) detected. Generating dump file. See dump for more details.

9.2.2 Control Log Codes

Table 9.2. Control Log Codes

CodeMessage
CN0000E
  • The attempt to register a control MBean for the service ${service} with definition interface ${interface} failed. The cause of the failure follows:
InsertsDescription
  • service
  • interface
  • The service
  • The definition interface
CN0001E
  • The class ${class} under which service reference ${reference} was registered could not be loaded from bundle ${bundle}.
InsertsDescription
  • class
  • reference
  • bundle
  • The class under which the service reference is registered
  • Service reference
  • The bundle where the registered class should be loaded from
CN0002E
  • The attempt to unregister the control MBean registered as ${mbean} failed. The cause of the failure follows:
InsertsDescription
  • mbean
  • The name which the control MBean is registered as
CN0003E
  • Immediate shutdown initiated.
CN0004I
  • Shutdown initiated.

9.2.3 Config Log Codes

Table 9.3. Config Log Codes

CodeMessage
CO0000E
  • Configuration list not found at '${path}'.
InsertsDescription
  • path
  • configuration list path
CO0001E
  • Configuration map not found at path '${path}'.
InsertsDescription
  • path
  • The configuration map's path location
CO0002E
  • Configuration map at path '${path}' contained an invalid key '${key}'.
InsertsDescription
  • path
  • key
  • The configuration map's path location
  • The key
CO0003E
  • Configuration map at path '${path}' omitted the key '${key}'.
InsertsDescription
  • path
  • key
  • The configuration map's path location
  • The key
CO0004E
  • Configuration scalar not found at path '${path}'
InsertsDescription
  • path
  • The configuration scalar's path location
CO0005E
  • Configuration enumeration at path '${path}' contained an invalid value '${value}'.
InsertsDescription
  • path
  • value
  • The configuration enumeration's location path
  • A value
CO0006E
  • Configuration integer at path '${path}' contained an unrecognized value '${value}'.
InsertsDescription
  • path
  • value
  • The configuration integer's path location
  • A value
CO0007E
  • Configuration integer at path '${path}'contained a value '${value}' outside the permitted range.
InsertsDescription
  • path
  • value
  • The configuration integer's location path
  • A value
CO0008E
  • Configuration version at path '${path}' contained an unrecognized value '${value}'.
InsertsDescription
  • path
  • value
  • The configuration version's path location
  • A value
CO0009E
  • Configuration version at path '${path}' contained a value '${value}' outside the permitted range.
InsertsDescription
  • path
  • value
  • The configuration version's path location
  • A value
CO0010W
  • Invalid configuration directory '${directory}'.
InsertsDescription
  • directory
  • Configuration directory
CO0011E
  • Unrecognized configuration point '${point}'.
InsertsDescription
  • point
  • The configuration point
CO0012W
  • Invalid configuration filename '${filename}'.
InsertsDescription
  • filename
  • Configuration filename
CO1000E
  • Parser error [line=${line}, column=${column}]. Numbers should never have a leading zero.
InsertsDescription
  • line
  • column
  • line number
  • column number
CO1001E
  • Parser error [line=${line}, column=${column}]. Strings must be quoted.
InsertsDescription
  • line
  • column
  • line number
  • column number
CO1002E
  • Parser error [line=${line}, column=${column}]. Invalid exponent.
InsertsDescription
  • line
  • column
  • line number
  • column number
CO1003E
  • Parser error [line=${line}, column=${column}]. Extraneous data found at end of input.
InsertsDescription
  • line
  • column
  • line number
  • column number
CO1004E
  • Parser error [line=${line}, column=${column}]. Unexpectedly run out of data. Expecting to find '%s1'.
InsertsDescription
  • line
  • column
  • line number
  • column number
CO1005E
  • Parser error [line=${line}, column=${column}]. Mismatched input '%s1' expecting '%s2'.
InsertsDescription
  • line
  • column
  • line number
  • column number
CO1006E
  • Parser error [line=${line}, column=${column}]. Mismatched tree node: '%s1' expecting '%s2'.
InsertsDescription
  • line
  • column
  • line number
  • column number
CO1007E
  • Parser error [line=${line}, column=${column}]. No viable alternative at input '%s1'.
InsertsDescription
  • line
  • column
  • line number
  • column number
CO1008E
  • Parser error [line=${line}, column=${column}]. Mismatched input '%s1' expecting set '%s2'.
InsertsDescription
  • line
  • column
  • line number
  • column number
CO1009E
  • Parser error [line=${line}, column=${column}]. Rule '%s1' failed predicate: '%s2'.
InsertsDescription
  • line
  • column
  • line number
  • column number
CO1010E
  • Parser error [line=${line}, column=${column}]. Required (...)+ loop did not match anything at input '%s1'.
InsertsDescription
  • line
  • column
  • line number
  • column number
CO1011E
  • Parser error [line=${line}, column=${column}]. Unexpected character. Expecting '%s1', got '%s2'.
InsertsDescription
  • line
  • column
  • line number
  • column number
CO1100E
  • Parser error [line=${line}, column=${column}]. Recognition error.
InsertsDescription
  • line
  • column
  • line number
  • column number

9.2.4 Deployer Log Codes

Table 9.4. Deployer Log Codes

CodeMessage
DE0000E
  • Application symbolic name omitted from application descriptor '${descriptor}'.
InsertsDescription
  • descriptor
  • application descriptor
DE0002E
  • Application version '${version}' invalid in application descriptor '${descriptor}'.
InsertsDescription
  • version
  • descriptor
  • application version number
  • application descriptor
DE0003E
  • Application '${application}' version '${version}' exports the package(s) '${package}' more than once.
InsertsDescription
  • application
  • version
  • package
  • application name
  • version number
  • export package(s)
DE0004E
  • Application '${application}' version '${version}' has unsatisfied constraints: '${constraints}' more than once.
InsertsDescription
  • application
  • version
  • constraints
  • application name
  • version number
  • constraints
DE0005E
  • Hot deploy failed for resource '${resource}'.
InsertsDescription
  • resource
  • resource name
DE0006E
  • Hot re-deploy failed for resource '${resource}'.
InsertsDescription
  • resource
  • resource name
DE0007E
  • Hot un-deploy failed for resource '${resource}'.
InsertsDescription
  • resource
  • resource name
DE0008E
  • Automatic re-deployment failed for resource '${resource}'.
InsertsDescription
  • resource
  • resource name
DE0009E
  • Application '${name}' version '${version}' exports package '${package}' from more than one bundle: ${bundle}.
InsertsDescription
  • name
  • version
  • package
  • bundle
  • application name
  • version number
  • export package
  • export bundle
DE0010I
  • Deployment of '${application}' version '${version}' completed.
InsertsDescription
  • application
  • version
  • application name
  • version number
DE0011E
  • Deployment failed.
DE0012I
  • Undeployment of '${application}' version '${version}' completed.
InsertsDescription
  • application
  • version
  • application name
  • version number
DE0013E
  • Undeployment of '${application}' version '${version}' failed.
InsertsDescription
  • application
  • version
  • application name
  • version number
DE0014I
  • Refresh of module '${module}' of '${application}' version '${version}' completed.
InsertsDescription
  • module
  • application
  • version
  • module name
  • application name
  • version number
DE0015E
  • Refresh of module '${module}' of '${application}' version '${version}' failed.
InsertsDescription
  • module
  • application
  • version
  • module name
  • application name
  • version number
DE0016E
  • Application symbolic name in application descriptor '${descriptor}' has invalid syntax.
InsertsDescription
  • descriptor
  • descriptor name
DE0017W
  • Discarding bundle update location '${location}' of module '${module}' of '${application}' version '${version}' so it will not interfere with refresh.
InsertsDescription
  • location
  • module
  • application
  • version
  • bundle update location
  • module name
  • application name
  • version number
DE0018E
  • Unable to install application from location '${location}'. Could not satisfy constraints for bundle '${bundle}' at version '${version}'.\n ${application}.
InsertsDescription
  • location
  • bundle
  • version
  • application
  • application location
  • bundle name
  • version number
  • application name
DE0019I
  • Ignoring undeployment of artifact '${artifact}', application is not currently deployed.
InsertsDescription
  • artifact
  • artifact name
DE0020E
  • Application context creation failure for bundle '${bundle}'.
InsertsDescription
  • bundle
  • bundle name
DE0021E
  • Artifact at URI '${uri}' cannot be deployed as application ${application} is already deployed.
InsertsDescription
  • uri
  • application
  • uri address
  • application name
DE0022E
  • Artifact at URI '${uri}' cannot be deployed as it has the same file or directory name '${name}' as application ${application}.
InsertsDescription
  • uri
  • name
  • application
  • uri address
  • file or directory name
  • application name
DE0023E
  • Error parsing application manifest.
DE0024E
  • Error parsing Spring configuration file '${file}'.
InsertsDescription
  • file
  • configuration file name
DE0025E
  • Exception after module '{module}' started.
DE0026E
  • Exception after module '{module}' stopped.
DE0027E
  • Exception deploying module '{module}'.
DE0028E
  • Exception stopping module '{module}'.
DE0029E
  • Starting the bundle for module '{module}' threw an exception.
DE0030E
  • Stopping the bundle for module '{module}' threw an exception.
DE0031E
  • Updated module '{module}' has unsatisfied dependencies.
DE0032E
  • Update of module '{module}' took too long and timed out.
DE0033E
  • Wait for update of module '{module}' was interrupted.
DE0034E
  • Exception updating module '{module}'.
DE0035E
  • Deployment artifact '${artifact}' has no manifest.
InsertsDescription
  • artifact
  • artifact name
DE0036E
  • More than one bundle in scope '${scope}' version '${version}' has the same bundle symbolic name '${name}'.
InsertsDescription
  • scope
  • version
  • name
  • scope range
  • version number
  • bundle symbolic name
DE0037E
  • No module with bundle symbolic name '${name}' was found in application '${applcation}'.
InsertsDescription
  • name
  • application
  • bundle symbolic name
  • application name
DE0038E
  • Refresh not possible as no application is deployed at '${location}'.
InsertsDescription
  • location
  • deploy location
DE0039E
  • Undeployment not possible as no artifact is deployed at '${location}'.
InsertsDescription
  • location
  • deploy location
DE0040E
  • Deployment of module '${module}' took too long and timed out.
InsertsDescription
  • module
  • module name
DE0041E
  • OSGi R4 manifest with no bundle symbolic name detected:\n ${manifest}\nfor module '${module}'.
InsertsDescription
  • manifest
  • module
  • manifest name
  • module name
DE0042E
  • Refresh of module '${module}' took too long and timed out.
InsertsDescription
  • module
  • module name
DE0043E
  • Wait for refresh of module '${module}' was interrupted.
InsertsDescription
  • module
  • module name
DE0044E
  • Exception refreshing module '${module}'.
InsertsDescription
  • module
  • module name
DE0045E
  • Artifact at '${location}' not found.
InsertsDescription
  • location
  • location name
DE0046E
  • Artifact at '${location}' cannot be unpackaged.
InsertsDescription
  • location
  • location name
DE0047E
  • Artifact at '${location}' cannot be copied.
InsertsDescription
  • location
  • location name
DE1000E
  • Unknown error exception received, unable to track non-Antlr exceptions [${exception}]
InsertsDescription
  • exception
  • exception
DE1001E
  • There has been an unknown recognition error exception with the Parser, it will attempt to continue [${exception}]
InsertsDescription
  • exception
  • exception
DE1002E
  • The parser could not find an expected symbol at the given input position [${position}]
InsertsDescription
  • position
  • position
DE1003E
  • The parser could not find a node with the expected token type [${token}]
InsertsDescription
  • token
  • token
DE1004E
  • At this decision point the parser's look-ahead could not find a viable option [${option}]
InsertsDescription
  • option
  • option
DE1005E
  • The parser could not match a reqiured sub rule [${rule}]
InsertsDescription
  • rule
  • rule
DE1006E
  • The parser has evaluated a validating semantic to false [${semantic}]
InsertsDescription
  • semantic
  • semantic
DE1007E
  • The parser has failed to match a range of symbols [${symbols}]
InsertsDescription
  • symbols
  • range of symbols
DE1008E
  • The parser has failed to match a set of symbols [${symbols}]
InsertsDescription
  • symbols
  • set of symbols
DE1009E
  • The parser has failed to match the inverse of a set of symbols [${symbols}]
InsertsDescription
  • symbols
  • set of symbols
DE1025W
  • Unknown warning exception received, unable to track non-Antlr exceptions [${exceptions}]
InsertsDescription
  • exceptions
  • exceptions
DE1026W
  • There has been an unknown recognition warning exception with the Parser, it will attempt to continue [${exception}]
InsertsDescription
  • exception
  • exception
DE1027W
  • The parser could not find an expected symbol at the given input position [${position}]
InsertsDescription
  • position
  • position
DE1028W
  • The parser could not find a node with the expected token type [${type}]
InsertsDescription
  • type
  • token type
DE1029W
  • At this decision point the parser's look-ahead could not find a viable option [${option}]
InsertsDescription
  • option
  • option
DE1030W
  • The parser could not match a required sub rule [${sub_rule}]
InsertsDescription
  • sub_rule
  • sub rule
DE1031W
  • The parser has evaluated a validating semantic to false [${semantic}]
InsertsDescription
  • semantic
  • semantic
DE1032W
  • The parser has failed to match a range of symbols [${symbols}]
InsertsDescription
  • symbols
  • range of symbols
DE1033W
  • The parser has failed to match a set of symbols [${symbols}]
InsertsDescription
  • symbols
  • set of symbols
DE1034W
  • The parser has failed to match the inverse of a set of symbols [${symbols}]
InsertsDescription
  • symbols
  • set of symbols
DE1050I
  • Unknown info exception received, unable to track non-Antlr exceptions [${symbols}]
InsertsDescription
  • symbols
  • range of symbols
DE1051I
  • There has been an unknown recognition info exception with the Parser, it will attempt to continue [${exception}]
InsertsDescription
  • exception
  • exception
DE1052I
  • The parser could not find an expected symbol at the given input position [${position}]
InsertsDescription
  • position
  • position
DE1053I
  • The parser could not find a node with the expected token type [${type}]
InsertsDescription
  • type
  • type
DE1054I
  • At this decision point the parser's look-ahead could not find a viable option [${option}]
InsertsDescription
  • option
  • option
DE1055I
  • The parser could not match a required sub rule [${sub_rule}]
InsertsDescription
  • sub_rule
  • sub rule
DE1056I
  • The parser has evaluated a validating semantic to false [${semantic}]
InsertsDescription
  • semantic
  • semantic
DE1057I
  • The parser has failed to match a range of symbols [${symbols}]
InsertsDescription
  • symbols
  • range of symbols
DE1058I
  • The parser has failed to match a set of symbols [${symbols}]
InsertsDescription
  • symbols
  • set of symbols
DE1059I
  • The parser has failed to match the inverse of a set of symbols [${symbols}]
InsertsDescription
  • symbols
  • set of symbols
DE1085E
  • There has been an error that can't be identified by any part of the system [${error}]
InsertsDescription
  • error
  • unidentified error

9.2.5 FFDC Log Codes

Table 9.5. FFDC Log Codes

CodeMessage
FF0000E
  • Failed to locate dump directory "${directory}"
InsertsDescription
  • directory
  • dump file directory
FF0001I
  • Using dump directory "${directory}"
InsertsDescription
  • directory
  • dump file directory
FF0002I
  • Wrote dump file "${file}"
InsertsDescription
  • file
  • dump file name
FF0003E
  • Bundle '${bundle}' in Subsystem '${subsystem}' failed to start.
InsertsDescription
  • bundle
  • subsystem
  • bundle name
  • subsystem name

9.2.6 Bootstrap Log Codes

Table 9.6. Bootstrap Log Codes

CodeMessage
KB0001I
  • Server starting.
KB0002E
  • Start failed:

9.2.7 Kernel Log Codes

Table 9.7. Kernel Log Codes

CodeMessage
KE0000I
  • Boot subsystems installed.
KE0001I
  • Base subsystems installed.
KE0051E
  • Subsystem descriptor has a bundle element '${element}' with no bundle symbolic name.
InsertsDescription
  • element
  • bundle element

9.2.8 OSGi Log Codes

Table 9.8. OSGi Log Codes

CodeMessage
OP0001W
  • The library definition '${definition}' could not be provisioned. A library definition with the name '${definition}' and version '${version}' has already been added to the repository from '${location}'.
InsertsDescription
  • definition
  • version
  • location
  • library definition
  • library version
  • library location
OP0002W
  • The bundle '${bundle}' could not be provisioned. A bundle with the symbolic name '${name}' and version '${version}' has already been added to the repository from '${location}'.
InsertsDescription
  • bundle
  • name
  • version
  • location
  • bundle name
  • bundle symbolic name
  • bundle version
  • bundle location
OP0003W
  • The JAR bundle '${bundle}' could not be provisioned as it appears to be corrupted. The exception encountered whilst reading the file was:
InsertsDescription
  • bundle
  • bundle name
OP0004W
  • The bundle '${bundle}' could not be provisioned is its manifest is malformed. The error encountered whilst parsing the manifest was: ${error}
InsertsDescription
  • bundle
  • error
  • bundle name
  • error

9.2.9 Profile Log Codes

Table 9.9. Profile Log Codes

CodeMessage
PM0000I
  • Installing profile '${profile}'.
InsertsDescription
  • profile
  • profile name
PM0001I
  • Installed profile '${profile}'.
InsertsDescription
  • profile
  • profile name
PM0002I
  • Server open for business with profile '${profile}'.
InsertsDescription
  • profile
  • profile name
PM0003E
  • Timed out with profile '${profile}' waiting for the application context of bundle '${bundle}' to be created.
InsertsDescription
  • profile
  • bundle
  • profile name
  • bundle name
PM0004W
  • With profile '${profile}', bundle '${bundle}' has not started.
InsertsDescription
  • profile
  • bundle
  • profile name
  • bundle name

9.2.10 Servlet Log Codes

Table 9.10. Servlet Log Codes

CodeMessage
SC0000I
  • Starting the ServletContainer on port ${port}.
InsertsDescription
  • port
  • port
SC0001I
  • Starting the ServletContainer on port ${port} and SSL port ${ssl}.
InsertsDescription
  • port
  • ssl
  • port
  • ssl port
SC0002I
  • Shutting down the ServletContainer.
SC0003E
  • Failed to start the ServletContainer.
SC0004E
  • Failed to stop the ServletContainer.
SC1000I
  • Creating web application ${application}.
InsertsDescription
  • application
  • web application
SC1001I
  • Deploying web application ${application}.
InsertsDescription
  • application
  • web application
SC1002I
  • Removing web application ${application}.
InsertsDescription
  • application
  • web application
SC1003E
  • Failed to create web application ${application}.
InsertsDescription
  • application
  • web application
SC1004E
  • Failed to create web application ${application}: the associated web bundle \ '${bundle}' failed to publish its ApplicationContext within ${time} seconds.
InsertsDescription
  • application
  • bundle
  • time
  • web application
  • web bundle
  • time frame
SC2000E
  • Failed to deploy WAR ${war}.
InsertsDescription
  • war
  • war file

9.2.11 Web Log Codes

Table 9.11. Web Log Codes

CodeMessage
WE1000E
  • Failed to create web application context [${context}]: the associated web \ bundle [${bundle}] failed to publish its ApplicationContext.
InsertsDescription
  • context
  • bundle
  • web application context
  • web bundle
WE1001E
  • Failed to create web application context [${context}]; the associated web \ bundle [${bundle}] failed to publish its ApplicationContext within \ ${time} seconds.
InsertsDescription
  • context
  • bundle
  • time
  • web application context
  • web bundle
  • time frame

10.  Further Reading

SpringSource dm Server Programmer Guide

Spring Framework Reference Guide

Spring Dynamic Modules Reference Guide