Show TOC

Registering a Plug-inLocate this document in the navigation structure

Prerequisites

The new plug-in must:

  • Be loaded at SAP NetWeaver Developer Studio startup.

  • Be registered to the WAR plug-in.

  • Implement two interfaces, one for packing and one for unpacking.

Context

You can register a plug-in to be called during the generation of a WAR file, enabling you to modify the process of packing and unpacking a WAR file.

  • During packing, the plug-in is called before the final packing of the WAR file.

  • During unpacking, the plug-in is called after the initial unpacking of the WAR file.

Procedure


  1. Implement the org.eclipse.ui.Istartup interface with its method earlyStartup() in the base class of the plug-in (the first class that is called when the plug-in is started, and where org.eclipse.ui.plugin.AbstractUIPlugin is extended).

  2. In the plugin.xml add:

    <extension
      point="org.eclipse.ui.startup">
    </extension>
                         
  3. Call the static method of com.sap.portal.developmentTools.ideSpecific.eclipse.PortalPlugin class registerPlugin(String pluginId, IParIdePlugin aPlugin) . The plug-in ID must be unique.

  4. To register a plug-in, implement the com.sap.portal.developmentTools.general.api.IparIdePlugin and set the implementation class as a parameter when it registers.

    The plug-in has to specify the final state of the operation clearly using the method setFinalState(int status) from the class com.sap.portal.developmentTools.general.api.IfinishResult . If the final state is OK or Warning , then the WAR process continues; otherwise, it is stopped. Inside the IfinishResult , you can add messages with their level.