src/core/core-extensions.xml

Code
Comments
Other
Rev Date Author Line
5598 30 Mar 11 nicklas 1 <?xml version="1.0" encoding="UTF-8" ?>
5598 30 Mar 11 nicklas 2 <!--
5598 30 Mar 11 nicklas 3   $Id$
5598 30 Mar 11 nicklas 4
5598 30 Mar 11 nicklas 5   Copyright (C) Nicklas Nordborg
5598 30 Mar 11 nicklas 6
5598 30 Mar 11 nicklas 7   This file is part of BASE - BioArray Software Environment.
5598 30 Mar 11 nicklas 8   Available at http://base.thep.lu.se/
5598 30 Mar 11 nicklas 9
5598 30 Mar 11 nicklas 10   BASE is free software; you can redistribute it and/or
5598 30 Mar 11 nicklas 11   modify it under the terms of the GNU General Public License
5598 30 Mar 11 nicklas 12   as published by the Free Software Foundation; either version 3
5598 30 Mar 11 nicklas 13   of the License, or (at your option) any later version.
5598 30 Mar 11 nicklas 14
5598 30 Mar 11 nicklas 15   BASE is distributed in the hope that it will be useful,
5598 30 Mar 11 nicklas 16   but WITHOUT ANY WARRANTY; without even the implied warranty of
5598 30 Mar 11 nicklas 17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
5598 30 Mar 11 nicklas 18   GNU General Public License for more details.
5598 30 Mar 11 nicklas 19
5598 30 Mar 11 nicklas 20   You should have received a copy of the GNU General Public License
5598 30 Mar 11 nicklas 21   along with BASE. If not, see <http://www.gnu.org/licenses/>.
5598 30 Mar 11 nicklas 22 -->
5598 30 Mar 11 nicklas 23 <extensions
5598 30 Mar 11 nicklas 24   xmlns="http://base.thep.lu.se/extensions.xsd"
5598 30 Mar 11 nicklas 25   >
5598 30 Mar 11 nicklas 26   <about>
5609 15 Apr 11 nicklas 27     <version></version>
5598 30 Mar 11 nicklas 28     <name>Core extensions points and extensions</name>
5598 30 Mar 11 nicklas 29     <description>
5598 30 Mar 11 nicklas 30       This file defines core extension points and extensions. 
5598 30 Mar 11 nicklas 31       Core extensions are always loaded when BASE starts up and
5598 30 Mar 11 nicklas 32       are available in all context, no matter if BASE is running
5598 30 Mar 11 nicklas 33       as a job agent, web server, etc.
5598 30 Mar 11 nicklas 34     </description>
5609 15 Apr 11 nicklas 35     <copyright>BASE development team</copyright>
5609 15 Apr 11 nicklas 36     <email>basedb-users@lists.sourceforge.net</email>
7982 14 Jun 21 nicklas 37     <url>https://base.thep.lu.se/</url>
5598 30 Mar 11 nicklas 38   </about>
5599 31 Mar 11 nicklas 39   
5599 31 Mar 11 nicklas 40   <extension-point
6423 25 Feb 14 nicklas 41     id="net.sf.basedb.core.authentication-manager"
6423 25 Feb 14 nicklas 42     >
6423 25 Feb 14 nicklas 43     <action-class>net.sf.basedb.core.authentication.AuthenticationManager</action-class>
6423 25 Feb 14 nicklas 44     <name>Authentication manager</name>
6423 25 Feb 14 nicklas 45     <description>
6423 25 Feb 14 nicklas 46       Extension point for authentication of users when logging in to BASE.
6423 25 Feb 14 nicklas 47       Installed authentication managers are invoked in the index order.
6423 25 Feb 14 nicklas 48       An authentication manager have three possible options:
6423 25 Feb 14 nicklas 49       1) Decide that the login/password is valid and return an 
6423 25 Feb 14 nicklas 50          AuthenticationInformation object. No further authentication managers
6423 25 Feb 14 nicklas 51          are invoked and the user is logged in to BASE.
6423 25 Feb 14 nicklas 52       2) Decide that the login/password is invalid and throw an
6423 25 Feb 14 nicklas 53          Exception. No further authentication managers
6423 25 Feb 14 nicklas 54          are invoked and the user is NOT logged in to BASE.
6423 25 Feb 14 nicklas 55       3) Decide that it doesn't know if the login/password is valid or not
6423 25 Feb 14 nicklas 56          and return null. The next authentication manager is invoked.
6423 25 Feb 14 nicklas 57          If this was the last authentication manager, internal authentication
6423 25 Feb 14 nicklas 58          is used.
6423 25 Feb 14 nicklas 59     </description>
6423 25 Feb 14 nicklas 60   </extension-point>
6423 25 Feb 14 nicklas 61   
6423 25 Feb 14 nicklas 62   <extension-point
5599 31 Mar 11 nicklas 63     id="net.sf.basedb.core.uri.connection-manager"
5599 31 Mar 11 nicklas 64     >
5599 31 Mar 11 nicklas 65     <action-class>net.sf.basedb.util.uri.ConnectionManagerFactory</action-class>
5599 31 Mar 11 nicklas 66     <name>Connection manager</name>
5599 31 Mar 11 nicklas 67     <description>
5599 31 Mar 11 nicklas 68       Extension point for external file support. A connection manager is
5599 31 Mar 11 nicklas 69       something that knows how to access an external file pointed to by an
5599 31 Mar 11 nicklas 70       URI. Actions are ConnectionManagerFactory instances and are typically
5599 31 Mar 11 nicklas 71       used in two ways. 
5599 31 Mar 11 nicklas 72       1) In a single-file context when getting metadata or the contents of
5599 31 Mar 11 nicklas 73       a single File item. The ClientContext object is populated with an active 
5599 31 Mar 11 nicklas 74       DbControl and the current item is the file.
5599 31 Mar 11 nicklas 75       2) A standalone context with the external reference as an URI. No 
5599 31 Mar 11 nicklas 76       DbControl is used and no current item.
5599 31 Mar 11 nicklas 77       Extensions to this extension point must not return more than one
5599 31 Mar 11 nicklas 78       factory since we need to associate each factory with the id
5599 31 Mar 11 nicklas 79       of the extension.
5599 31 Mar 11 nicklas 80     </description>
5599 31 Mar 11 nicklas 81   </extension-point>
5599 31 Mar 11 nicklas 82   
5623 06 May 11 nicklas 83   <extension-point 
5623 06 May 11 nicklas 84     id="net.sf.basedb.core.filehandler.validator"
5623 06 May 11 nicklas 85     >
5623 06 May 11 nicklas 86     <action-class>net.sf.basedb.util.fileset.ValidationAction</action-class>
5623 06 May 11 nicklas 87     <name>File set validators</name>
5623 06 May 11 nicklas 88     <description>
5623 06 May 11 nicklas 89       Extension point for validating and extracting metadata from files in a FileSet. 
5623 06 May 11 nicklas 90       Extensions can be invoked in three different contexts:
5623 06 May 11 nicklas 91       1) Validation of a file set: The current item in the context is the owner of
5623 06 May 11 nicklas 92         the file set (eg. the FileStoreEnabled item). 
5623 06 May 11 nicklas 93       2) Removing a file from a file set: The current item in the context
5623 06 May 11 nicklas 94         is the owner of the file set (eg. the FileStoreEnabled item). The 
5623 06 May 11 nicklas 95         extension is supposed to remove metadata that was extracted from the 
5623 06 May 11 nicklas 96         given file.
5623 06 May 11 nicklas 97       3) Checking if a given data file type can be validated or not: The current
5623 06 May 11 nicklas 98         item in the context is a DataFileType and the core will only check if
5623 06 May 11 nicklas 99         the action factory returns TRUE from the prepareContext method. The
5623 06 May 11 nicklas 100         extensions will not actually be invoked.
5623 06 May 11 nicklas 101     </description>
5623 06 May 11 nicklas 102   </extension-point>
5623 06 May 11 nicklas 103   
6046 17 Apr 12 nicklas 104   <extension-point 
6046 17 Apr 12 nicklas 105     id="net.sf.basedb.util.overview.loader">
6046 17 Apr 12 nicklas 106     <action-class>net.sf.basedb.util.overview.extensions.ChildNodeLoaderAction</action-class>
6052 23 Apr 12 nicklas 107     <name>Item overview - loader</name>
6046 17 Apr 12 nicklas 108     <description>
6046 17 Apr 12 nicklas 109       Extension point for extending the item overview by
6046 17 Apr 12 nicklas 110       loading child nodes to existing nodes. Each registered action factory
6046 17 Apr 12 nicklas 111       is asked to create child items for every node in the item overview.
6046 17 Apr 12 nicklas 112       The ClientContext is populated with an active DbControl and the current
6046 17 Apr 12 nicklas 113       item is the parent node for which child nodes should be loaded.
6046 17 Apr 12 nicklas 114     </description>
6046 17 Apr 12 nicklas 115   </extension-point>
6047 18 Apr 12 nicklas 116
6047 18 Apr 12 nicklas 117   <extension-point 
6047 18 Apr 12 nicklas 118     id="net.sf.basedb.util.overview.validator">
6047 18 Apr 12 nicklas 119     <action-class>net.sf.basedb.util.overview.extensions.NodeValidatorAction</action-class>
6052 23 Apr 12 nicklas 120     <name>Item overview - validator</name>
6047 18 Apr 12 nicklas 121     <description>
6047 18 Apr 12 nicklas 122       Extension point for adding validation checks to the item overview. Each registered
6047 18 Apr 12 nicklas 123       action factory is asked to create a validator for every node in the item overview.
6047 18 Apr 12 nicklas 124       The ClientContext is populated with an active DbControl and the key used by the
6047 18 Apr 12 nicklas 125       validator factory to create the validators. Typically, this is a value from
6047 18 Apr 12 nicklas 126       the Item enumeration (eg. Item.SAMPLE, etc).
6047 18 Apr 12 nicklas 127     </description>
6047 18 Apr 12 nicklas 128   </extension-point>
6046 17 Apr 12 nicklas 129   
6047 18 Apr 12 nicklas 130   <extension-point 
6047 18 Apr 12 nicklas 131     id="net.sf.basedb.util.overview.validationrule">
6047 18 Apr 12 nicklas 132     <action-class>net.sf.basedb.util.overview.extensions.ValidationRuleAction</action-class>
6052 23 Apr 12 nicklas 133     <name>Item overview - validation rule</name>
6047 18 Apr 12 nicklas 134     <description>
6047 18 Apr 12 nicklas 135       Extension point for adding validation rules to the item overview. This extension
6047 18 Apr 12 nicklas 136       point is used in the "Validation options" dialog and allows a user to set the
6047 18 Apr 12 nicklas 137       severity level for each registered rule. The ClientContext is populated with
6047 18 Apr 12 nicklas 138       an active DbControl and the current item is the GenericOverview that is currently
6047 18 Apr 12 nicklas 139       in use.
6047 18 Apr 12 nicklas 140     </description>
6047 18 Apr 12 nicklas 141   </extension-point>
6047 18 Apr 12 nicklas 142   
6079 06 Aug 12 nicklas 143   <extension-point 
6079 06 Aug 12 nicklas 144     id="net.sf.basedb.core.log-manager">
6079 06 Aug 12 nicklas 145     <action-class>net.sf.basedb.core.log.LogManagerFactory</action-class>
6079 06 Aug 12 nicklas 146     <name>Log managers</name>
6079 06 Aug 12 nicklas 147     <description>
6079 06 Aug 12 nicklas 148       Extension point for logging changes that are made to items. This
6079 06 Aug 12 nicklas 149       extension point is invoked for every access and the ClientContext
6079 06 Aug 12 nicklas 150       is populated with the current SessionControl.
6079 06 Aug 12 nicklas 151     </description>
6079 06 Aug 12 nicklas 152   </extension-point>
6079 06 Aug 12 nicklas 153   
6432 14 Mar 14 nicklas 154   <extension-point 
6432 14 Mar 14 nicklas 155     id="net.sf.basedb.core.signal.job">
6432 14 Mar 14 nicklas 156     <action-class>net.sf.basedb.core.signal.SignalHandler</action-class>
6432 14 Mar 14 nicklas 157     <name>Job signal handler</name>
6432 14 Mar 14 nicklas 158     <description>
6432 14 Mar 14 nicklas 159       Extension point for sending signals to jobs. Intended for jobs 
6432 14 Mar 14 nicklas 160       running on external servers outside of direct control for BASE.
6432 14 Mar 14 nicklas 161       The ClientContext is populated with the current SessionControl and
6432 14 Mar 14 nicklas 162       Job item, and the "signal-uri" attribute is set to the URI registered
6432 14 Mar 14 nicklas 163       with Job.setSignalTransporter. It is recommended that implementations
6432 14 Mar 14 nicklas 164       return quickly. If the action takes a long time the handler should spawn
6432 14 Mar 14 nicklas 165       a new thread.
6432 14 Mar 14 nicklas 166     </description>
6432 14 Mar 14 nicklas 167   </extension-point>
6432 14 Mar 14 nicklas 168   
7895 18 Jan 21 nicklas 169   <extension-point 
7895 18 Jan 21 nicklas 170     id="net.sf.basedb.query.entity-query-filter">
7895 18 Jan 21 nicklas 171     <action-class>net.sf.basedb.core.query.QueryFilterAction</action-class>
7895 18 Jan 21 nicklas 172     <name>Query filters</name>
7895 18 Jan 21 nicklas 173     <description>
7895 18 Jan 21 nicklas 174       Extension point for implementing extra filter functionality for
7895 18 Jan 21 nicklas 175       queries generated by the ItemContext.configureQuery() method. 
7895 18 Jan 21 nicklas 176       If the call is initiated from the web client the client context is
7895 18 Jan 21 nicklas 177       a JspContext, otherwise it is a ClientContext instance. In both cases
7895 18 Jan 21 nicklas 178       the current item is the ItemContext instance. The ItemContext.getQuery()
7895 18 Jan 21 nicklas 179       method returns the query that was passed to the configureQuery() method.
7895 18 Jan 21 nicklas 180       Factory implementations are recommended to check ItemContext.hasExtensionFilter()
7895 18 Jan 21 nicklas 181       before returning actions, and QueryFilterAction implementations should check
7895 18 Jan 21 nicklas 182       PropertyFilter.isExtensionFilter().
7895 18 Jan 21 nicklas 183     </description>
7895 18 Jan 21 nicklas 184   </extension-point>
7895 18 Jan 21 nicklas 185   
5599 31 Mar 11 nicklas 186   <extension 
5599 31 Mar 11 nicklas 187     id="net.sf.basedb.core.uri.http-connection-manager"
5599 31 Mar 11 nicklas 188     extends="net.sf.basedb.core.uri.connection-manager"
5599 31 Mar 11 nicklas 189     >
5599 31 Mar 11 nicklas 190     <about>
5599 31 Mar 11 nicklas 191       <name>HTTP(s) connection manager</name>
5599 31 Mar 11 nicklas 192       <description>
5599 31 Mar 11 nicklas 193         Provides support for regular HTTP and HTTPS including Basic 
5599 31 Mar 11 nicklas 194         and Digest authentication as well as server- and client-side
5599 31 Mar 11 nicklas 195         certificates. Auto-detection matches all URI:s with 'http' 
5599 31 Mar 11 nicklas 196         or 'https' scheme.
5599 31 Mar 11 nicklas 197       </description>
5599 31 Mar 11 nicklas 198     </about>
5600 01 Apr 11 nicklas 199     <index>1</index>
5599 31 Mar 11 nicklas 200     <action-factory>
5599 31 Mar 11 nicklas 201       <factory-class>net.sf.basedb.util.uri.http.HttpConnectionManagerActionFactory</factory-class>
5599 31 Mar 11 nicklas 202     </action-factory>
5623 06 May 11 nicklas 203   </extension>
5599 31 Mar 11 nicklas 204   
5623 06 May 11 nicklas 205   <extension 
5623 06 May 11 nicklas 206     id="net.sf.basedb.util.affymetrix.cel-validator"
5623 06 May 11 nicklas 207     extends="net.sf.basedb.core.filehandler.validator"
5623 06 May 11 nicklas 208     >
5623 06 May 11 nicklas 209     <about>
5623 06 May 11 nicklas 210       <name>CEL file validator</name>
5623 06 May 11 nicklas 211       <description>
5623 06 May 11 nicklas 212         Validator and metadata extractor implementation for Affymetrix CEL files.
5623 06 May 11 nicklas 213         The validation is done by trying to open the file with the Affymetrix 
5623 06 May 11 nicklas 214         Fusion SDK. If this was successful some metadata information is extracted
5623 06 May 11 nicklas 215         from the headers including chip type and algorithm parameters. The number
5623 06 May 11 nicklas 216         of spots for the raw bioassay is set to the number of cells in the file.
5623 06 May 11 nicklas 217       </description>
5623 06 May 11 nicklas 218     </about>
5623 06 May 11 nicklas 219     <index>1</index>
5623 06 May 11 nicklas 220     <action-factory>
5623 06 May 11 nicklas 221       <factory-class>net.sf.basedb.util.affymetrix.CelValidationFactory</factory-class>
5623 06 May 11 nicklas 222     </action-factory>
5599 31 Mar 11 nicklas 223   </extension>
5598 30 Mar 11 nicklas 224
5623 06 May 11 nicklas 225   <extension 
5623 06 May 11 nicklas 226     id="net.sf.basedb.util.affymetrix.cdf-validator"
5623 06 May 11 nicklas 227     extends="net.sf.basedb.core.filehandler.validator"
5623 06 May 11 nicklas 228     >
5623 06 May 11 nicklas 229     <about>
5623 06 May 11 nicklas 230       <name>CDF file validator</name>
5623 06 May 11 nicklas 231       <description>
5623 06 May 11 nicklas 232         Validator and metadata extractor implementation for Affymetrix CDF files.
5623 06 May 11 nicklas 233         The validation is done by trying to open the file with the Affymetrix 
5623 06 May 11 nicklas 234         Fusion SDK. If this was successful some metadata information is extracted
5623 06 May 11 nicklas 235         from the headers including 
5623 06 May 11 nicklas 236         
5623 06 May 11 nicklas 237         chip type and algoritm parameters. The number
5623 06 May 11 nicklas 238         of spots for the raw bioassay is set to the number of cells in the file.
5623 06 May 11 nicklas 239       </description>
5623 06 May 11 nicklas 240     </about>
5623 06 May 11 nicklas 241     <index>1</index>
5623 06 May 11 nicklas 242     <action-factory>
5623 06 May 11 nicklas 243       <factory-class>net.sf.basedb.util.affymetrix.CdfValidationFactory</factory-class>
5623 06 May 11 nicklas 244     </action-factory>
5623 06 May 11 nicklas 245   </extension>
5623 06 May 11 nicklas 246
5764 27 Sep 11 nicklas 247   <extension 
5764 27 Sep 11 nicklas 248     id="net.sf.basedb.util.gtf.gtf-validator"
5764 27 Sep 11 nicklas 249     extends="net.sf.basedb.core.filehandler.validator"
5764 27 Sep 11 nicklas 250     >
5764 27 Sep 11 nicklas 251     <about>
5764 27 Sep 11 nicklas 252       <name>GTF file validator</name>
5764 27 Sep 11 nicklas 253       <description>
5764 27 Sep 11 nicklas 254         Validator for GTF reference files. The validation checks that
5764 27 Sep 11 nicklas 255         the first few lines follow the GTF specification. 
5764 27 Sep 11 nicklas 256         See http://mblab.wustl.edu/GTF22.html
5764 27 Sep 11 nicklas 257       </description>
5764 27 Sep 11 nicklas 258     </about>
5764 27 Sep 11 nicklas 259     <index>1</index>
5764 27 Sep 11 nicklas 260     <action-factory>
5764 27 Sep 11 nicklas 261       <factory-class>net.sf.basedb.util.gtf.GtfValidationFactory</factory-class>
5764 27 Sep 11 nicklas 262     </action-factory>
5764 27 Sep 11 nicklas 263   </extension>
5764 27 Sep 11 nicklas 264
6079 06 Aug 12 nicklas 265   <extension 
6079 06 Aug 12 nicklas 266     id="net.sf.basedb.core.db-log-manager"
6079 06 Aug 12 nicklas 267     extends="net.sf.basedb.core.log-manager"
6079 06 Aug 12 nicklas 268     >
6079 06 Aug 12 nicklas 269     <about>
6079 06 Aug 12 nicklas 270       <name>Database log manager</name>
6079 06 Aug 12 nicklas 271       <description>
6079 06 Aug 12 nicklas 272         Information about changes to items are logged in the
6079 06 Aug 12 nicklas 273         database. Some configuration options can be set in base.config.
6079 06 Aug 12 nicklas 274       </description>
6079 06 Aug 12 nicklas 275     </about>
6079 06 Aug 12 nicklas 276     <index>1</index>
6079 06 Aug 12 nicklas 277     <action-factory>
6079 06 Aug 12 nicklas 278       <factory-class>net.sf.basedb.core.log.db.DbLogManagerFactory</factory-class>
6079 06 Aug 12 nicklas 279     </action-factory>
6079 06 Aug 12 nicklas 280   </extension>
6079 06 Aug 12 nicklas 281
5598 30 Mar 11 nicklas 282 </extensions>

Generated on Sat Oct  7 02:40:08 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)