Error: java.util.zip.ZipException: Too many open files when running a custom plug-in

Problem

When you attempt to test a custom plug-in, you might see an error in the IBM® Rational® Software Development Platform (SDP) user interface. In one of the following products the error might occur. - IBM Rational Software Architect, - IBM Rational Software Modeler, - IBM Rational Application Developer for Websphere® Software, - IBM Rational Systems Developer, - IBM Rational Data Architect.

Cause

To see the problem, you create a custom plug-in.

Click File > New > Project > Plug-in project
Minimally, give the plug-in a name and accept all other defaults, but choose a template such as the Hello World template.

To test the plug-in,

click Run > Run...

Click on Eclipse Application and then click the New button to create a new configuration

Accept all the defaults and click Run .

You get an error message. The message states that the platform failed to start. If you accept to open the log, you see a number of errors on various different plug-ins. The message below is an example of an error message.
!MESSAGE FrameworkEvent.ERROR
!STACK 0
java.util.zip.ZipException: Too many open files C:\Program Files\IBM\SDP70Shared\plugins\org.eclipse.wst.rdb.dbdefinition.sybase_1.0.106.v200610261819.jar
at java.util.zip.ZipFile.open(Native Method)
at java.util.zip.ZipFile.<init>(ZipFile.java:238)
at java.util.zip.ZipFile.<init>(ZipFile.java:268)
at org.eclipse.osgi.framework.util.SecureAction.getZipFile(SecureAction.java:226)
at org.eclipse.osgi.baseadaptor.bundlefile.ZipBundleFile.basicOpen(ZipBundleFile.java:79)
at org.eclipse.osgi.baseadaptor.bundlefile.ZipBundleFile.getZipFile(ZipBundleFile.java:92)
at org.eclipse.osgi.baseadaptor.bundlefile.ZipBundleFile.checkedOpen(ZipBundleFile.java:65)
at org.eclipse.osgi.baseadaptor.bundlefile.ZipBundleFile.getEntry(ZipBundleFile.java:234)
at org.eclipse.osgi.baseadaptor.BaseData.getEntry(BaseData.java:93)
at org.eclipse.osgi.framework.internal.core.AbstractBundle.getEntry(AbstractBundle.java:1281)
at org.eclipse.core.internal.registry.osgi.RegistryStrategyOSGI.getContributionsTimestamp(RegistryStrategyOSGI.java:242)
at org.eclipse.core.internal.registry.ExtensionRegistry.computeTimeStamp(ExtensionRegistry.java:729)
at org.eclipse.core.internal.registry.ExtensionRegistry.stop(ExtensionRegistry.java:660)
at org.eclipse.core.internal.registry.osgi.Activator.stopRegistry(Activator.java:141)
at org.eclipse.core.internal.registry.osgi.Activator.stop(Activator.java:61)
at org.eclipse.osgi.framework.internal.core.BundleContextImpl$3.run(BundleContextImpl.java:1032)
at java.security.AccessController.doPrivileged(AccessController.java:242)
at org.eclipse.osgi.framework.internal.core.BundleContextImpl.stop(BundleContextImpl.java:1028)
at org.eclipse.osgi.framework.internal.core.BundleHost.stopWorker(BundleHost.java:396)
at org.eclipse.osgi.framework.internal.core.AbstractBundle.stop(AbstractBundle.java:400)
at org.eclipse.core.runtime.internal.adaptor.BundleStopper.basicStopBundles(BundleStopper.java:86)
at org.eclipse.core.runtime.internal.adaptor.BundleStopper.stopBundles(BundleStopper.java:73)
at org.eclipse.core.runtime.internal.adaptor.EclipseAdaptorHook.frameworkStopping(EclipseAdaptorHook.java:156)
at org.eclipse.osgi.baseadaptor.BaseAdaptor.frameworkStopping(BaseAdaptor.java:288)
at org.eclipse.osgi.framework.internal.core.Framework.shutdown(Framework.java:529)
at org.eclipse.osgi.framework.internal.core.Framework.close(Framework.java:440)
at org.eclipse.osgi.framework.internal.core.OSGi.close(OSGi.java:41)
at org.eclipse.core.runtime.adaptor.EclipseStarter.shutdown(EclipseStarter.java:423)
at org.eclipse.core.runtime.adaptor.EclipseStarter.run(EclipseStarter.java:193)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:64)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:615)
at org.eclipse.core.launcher.Main.invokeFramework(Main.java:336)
at org.eclipse.core.launcher.Main.basicRun(Main.java:280)
at org.eclipse.core.launcher.Main.run(Main.java:977)

The previous error would typically occur on an IBM Rational Application Developer (RAD) or IBM Rational Software Architect (RSA) installation on a non-English operating system. The error would occur if you chose to install the localized plug-ins, merely because such an installation would contain a much higher number of OSGi bundles. OSGi stands for Open Service Gateway initiative.

You can not reproduce the preceding error, for example, on a default installation of IBM Rational Software Modeler (RSM). But you might when you added a large number of custom plug-ins.

For more information you visit the URLs in the related information section of this technote.

Resolving The Problem

In the Configuration Tab of the dialog obtained by invoking Run > Run... the Configuration File settings must be changed so the Use an existing config.ini as a template option is selected and the config.ini file installed with the IBM Rational SDP solution product is used. The latter is accomplished by entering

${target_home}/configuration/config.ini.

The supplied config.ini changes many default parameters. The one specifically responsible for resolving this error is: osgi.bundlefile.limit=100

This is documented as follows in the Related URL Section::

osgi.bundlefile.limit

specifies a limit on the number of jar files that the framework keeps open. The minimum value allowed is 10. By default the value is unlimited.

When you select Run to start the new instance, you no longer have the error. The new Eclipse instance opens and contains every plug-ins in the host Eclipse development environment as well as all open plug-in projects in the workspace.

In Rational Software Modeler you can discover the resolution in the online help chapter.

Extending Rational Software Modeler functionality >

Rational Modeling Platform Developer's Guide >

Programmer's Guide >

Common extensibility activities >

Extending using plug-ins .

In Rational Systems Developer you can discover the resolution the online help chapter.

Extending Rational Systems Developer functionality >

Rational Modeling Platform Developer's Guide >

Programmer's Guide >

Common extensibility activities >

Extending using plug-ins .

In Rational Software Architect you can discover the resolution the online help chapter.

Extending Rational Software Architect functionality

Rational Modeling Platform Developer's Guide >

Programmer's Guide >

Common extensibility activities >

Extending using plug-ins .

The above mentioned chapter is not present in Rational Application Developer and Rational Data Architect. However both of these products include the Eclipse Plug-in Development Environment. The solution, that we describe here, applies to these products too.

[{"Product":{"code":"SSYK2S","label":"Rational Software Architect Designer"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Extensibility","Platform":[{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"7.0;7.0.0.1;7.0.0.2;7.0.0.3;7.0.0.4;7.0.0.5;7.0.0.6","Edition":"All Editions","Line of Business":{"code":"LOB45","label":"Automation"}},{"Product":{"code":"SSCLKU","label":"Rational Software Modeler"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Extensibility","Platform":[{"code":"PF033","label":"Windows"},{"code":"PF016","label":"Linux"}],"Version":"7.0;7.0.0.1;7.0.0.2;7.0.0.3;7.0.0.4;7.0.5;7.0.5.1","Edition":"","Line of Business":{"code":"LOB36","label":"IBM Automation"}},{"Product":{"code":"SSRTLW","label":"Rational Application Developer for WebSphere Software"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Eclipse","Platform":[{"code":"PF033","label":"Windows"},{"code":"PF016","label":"Linux"}],"Version":"7.0;7.0.0.1;7.0.0.2;7.0.0.3;7.0.0.4;7.0.0.5;7.0.0.6","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}},{"Product":{"code":"SSJP3D","label":"Rational Systems Developer"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Extensibility","Platform":[{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"7.0;7.0.0.1;7.0.0.2;7.0.0.3;7.0.0.4;7.0.5;7.0.5.1","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}},{"Product":{"code":"SSSRXA","label":"Rational Data Architect"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Extensibility","Platform":[{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"7.0;7.0.0.1;7.0.0.2;7.0.0.3;7.0.0.4;7.0.0.5","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]