source: trunk/src/clients/web/web-extensions.xml @ 7759

<?xml version="1.0" encoding="UTF-8" ?>
<!--
  $Id: web-extensions.xml 7759 2019-11-27 12:00:25Z nicklas $

  Copyright (C) Nicklas Nordborg

  This file is part of BASE - BioArray Software Environment.
  Available at http://base.thep.lu.se/

  BASE is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 3
  of the License, or (at your option) any later version.

  BASE is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with BASE. If not, see <http://www.gnu.org/licenses/>.
-->
<extensions
  xmlns="http://base.thep.lu.se/extensions.xsd"
  id-base="net.sf.basedb.clients.web."
  >
  <about>
    <version></version>
    <name>Web client extensions points and extensions</name>
    <description>
      This file defines extension points and extensions for
      the web client. The extensions are only loaded when BASE 
      starts up as a web server.
    </description>
    <copyright>BASE development team</copyright>
    <email>basedb-users@lists.sourceforge.net</email>
    <url>http://base.thep.lu.se/</url>
  </about>
  
  <plugin-definition 
    id="SimpleExport">
    <about>
      <name>Table exporter</name>
      <description>
        Export all table listings in the web interface as tab-separated 
        text files or as XML. This plugin only works from within the web 
        client, since it depends on context and table information.
      </description>
    </about>
    <plugin-class>net.sf.basedb.clients.web.plugins.SimpleExport</plugin-class>
    <settings>
      <property name="everyone-use">1</property>
      <property name="immediate-execution">1</property>
    </settings>
  </plugin-definition>
  
  <extension-point
    id="menu.extensions"
    >
    <action-class>net.sf.basedb.clients.web.extensions.menu.MenuItemAction</action-class>
    <name>Menu: extensions</name>
    <description>
      Extension point for adding extensions to the 'Extensions' menu.
      Extensions should provide MenuItemAction instances. The rendering
      is internal and extensions can't use their own rendering factories.
      The context will only include information about the currently logged
      in user, not information about the current page that is displayed.
      The reason for this is that the rendered menu is cached as a string
      in the user session. The menu is not updated on every page request.
      As of BASE 3.3, this extension point also support custom scripts and
      stylesheets.
    </description>
  </extension-point>
  
  <extension-point 
    id="bioassayset.list.tools"
    >
    <action-class>net.sf.basedb.clients.web.extensions.toolbar.ButtonAction</action-class>
    <renderer-factory override="true">
      <factory-class>net.sf.basedb.clients.web.extensions.toolbar.CompactButtonRendererFactory</factory-class>
    </renderer-factory>
    <name>Bioassay set: Tools</name>
    <description>
      Extension point for the Tools column in the bioassayset tree
      view of an experiment. Extensions should provide ActionButton
      instances. The default renderer factory is CompactButtonRendererFactory,
      but this can be overridden by the extensions. Note that the tree 
      contains items of more than one type: BioAssaySet, Transformation and
      ExtraValue. The JspContext.getItem() can return any one of those
      types.
    </description>
  </extension-point>

  <extension-point 
    id="bioassayset.overviewplots"
    >
    <action-class>net.sf.basedb.clients.web.extensions.plot.OverviewPlotAction</action-class>
    <name>Bioassay set: Overview plots</name>
    <description>
      Extension point for overview plots for a bioassay set. The overview
      plots are usually one pre-defined plot per bioassay. For example,
      MA plots for 2-channel data. Extensions should provide OverviewPlotAction
      instances. The rendering is internal and generates one &lt;img&gt; tag
      for each plot. An extension is supposed to generate the image URL that
      leads to a servlet that creates the actual image. We recommend that
      images are cached. See the core plot servlet for details.
    </description>
  </extension-point>
  
  <extension-point
    id="services"
    >
    <action-class>net.sf.basedb.clients.web.extensions.service.ServiceControllerAction</action-class>
    <name>Services</name>
    <description>
      Extension point for services. A service is a piece of code that
      is loaded when the BASE web server starts up. The service is then running
      as long as the BASE web server is running. It is also possible to
      manually stop and start services. This extension point is different from 
      most others in that it doesn't affects the visible interface. Since 
      services are loaded at startup time, this also means that the
      context passed to ActionFactory methods doesn't have any user 
      information. However, the InvokationContext.getClientContext().getSessionControl()
      returns a special SessionControl which gives the extension permission to impersonate 
      another user so that it can access the BASE database if needed.
      There is also no meaning for extensions to specify a RendererFactory.
    </description>
    <error-handler-factory>
      <factory-class>net.sf.basedb.util.extensions.LoggingErrorHandlerFactory</factory-class>
      <parameters>
        <rememberLast>true</rememberLast>
      </parameters>
    </error-handler-factory>
  </extension-point>
  
  <extension-point 
    id="services.list.actions"
    >
    <action-class>net.sf.basedb.clients.web.extensions.toolbar.ButtonAction</action-class>
    <renderer-factory override="true">
      <factory-class>net.sf.basedb.clients.web.extensions.toolbar.CompactButtonRendererFactory</factory-class>
    </renderer-factory>
    <name>Services: Actions</name>
    <description>
      Extension point for the Actions column in the Adminstrate-&gt;services list.
      Extensions should provide ActionButton instances. The default renderer factory is 
      CompactButtonRendererFactory, but this can be overridden by the extensions. 
      The JspContext.getItem() method return the current ServiceControllerAction.
    </description>
  </extension-point>
  
  <extension-point
    id="file-viewer"
    >
    <action-class>net.sf.basedb.clients.web.extensions.toolbar.ButtonAction</action-class>
    <renderer-factory override="true">
      <factory-class>net.sf.basedb.clients.web.extensions.toolbar.CompactButtonRendererFactory</factory-class>
      <parameters>
        <button-tag>span</button-tag>
      </parameters>
    </renderer-factory>
    <name>File viewer</name>
    <description>
      Extension point for adding actions after the "View" and "Download" actions
      whenever a file item is displayed. Extensions should provide ActionButton 
      instances. The default renderer factory is CompactButtonRendererFactory, but 
      this can be overridden by the extensions. The JspContext.getCurrentItem() method 
      return a FileViewerContext instance. This object can be used to retrieve information
      about the current file, but also about the surrounding context, for example,
      if the file is in a "Data files" list for another item.
    </description>
  </extension-point>

  <extension-point 
    id="overview.info-details">
    <action-class>net.sf.basedb.clients.web.extensions.section.SectionAction</action-class>
    <name>Item overview - node information</name>
    <description>
      Extension point for including more information about the currently selected node
      in the overview. The information is displayed as a section in the right pane.
      This extension point supports custom javascript and stylesheet, but rendering 
      is internal. The JspContext is populated with the current 'Node' object from the
      overview which can be used to retreive more information.
    </description>
  </extension-point>

  <extension-point 
    id="login-form">
    <action-class>net.sf.basedb.clients.web.extensions.login.LoginFormAction</action-class>
    <name>Login form customization</name>
    <description>
      Extension point for customizing the login form. Makes it possible to change login
      and/or password prompts, help texts, etc. Since there is only one login form, 
      only the first extension found for this extension point is used.
    </description>
  </extension-point>
  
  <extension-point 
    id="global-skin">
    <action-class>net.sf.basedb.clients.web.extensions.skin.SkinAction</action-class>
    <name>Skins</name>
    <description>
      Extension point for GUI customizations. Extensions should implement
      the SkinAction interface, which can be used to set the favicon and 
      add custom data to a hidden div tag on the page. Most work is expected
      to be done by stylesheets and/or scripts added to the JspContext 
      instance passed to factory via the prepareContext method.
    </description>
  </extension-point>

  <extension-point
    id="start-page">
    <action-class>net.sf.basedb.clients.web.extensions.startpage.StartPageAction</action-class>
    <name>Start page</name>
    <description>
      Extension point for selecting the start page that is displayed
      after a user has logged in to BASE. Extensions should implement
      the StartPageAction interface. Use the BASE › Preferences menu
      to select the start page. This extension point doesn't use any
      custom scripts or stylesheets.
    </description>
  </extension-point>
  
  <!-- 
    More extension points: 
    In addition to the extension points in this file, the web
    client also defines a lot of other extension points that are
    registered programmatically. For more information see 
    Extensions -> Installed extensions in the web client interface.
    
     * Toolbar extension points: Adds buttons to toolbars in
       list and single-item view pages.
     * Edit dialog: Adds extra tabs to edit dialogs
     * OnSave: Add callback functionality when saving from an edit dialog
  -->
  
  <extension
    id="password-login-form"
    extends="net.sf.basedb.clients.web.login-form"
    >
    <about>
      <name>Password login form</name>
      <description>
        The regular username+password login form. This is disabled by 
        default, but need to be enabled when installing an external 
        authentication manager that is optional.
      </description>
    </about>
    <index>99</index>
    <action-factory>
      <factory-class>net.sf.basedb.clients.web.extensions.login.PasswordLoginFormFactory</factory-class>
    </action-factory>
  </extension>
  
  <extension
    id="bioassayset.overviewplots.maplot"
    extends="net.sf.basedb.clients.web.bioassayset.overviewplots"
    >
    <index>1</index>
    <about>
      <name>MA/Correction factor plots</name>
      <description>
        Generates MA and correction factor plots for
        2-channel data.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.plot.MAPlotFactory
      </factory-class>
      <parameters>
        <width>400</width>
        <height>300</height>
        <plotServlet>/views/experiments/plotter/plot</plotServlet>
      </parameters>
    </action-factory>
  </extension>
  
  <extension
    id="view-and-download-file"
    extends="net.sf.basedb.clients.web.file-viewer"
    >
    <index>1</index>
    <about>
      <name>View and download files</name>
      <description>
        Add view and download icons to all files.
      </description>      
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.fileviewer.ViewAndDownloadActionFactory
      </factory-class>
    </action-factory>
  </extension>
  
</extensions>