Skip to content

VEuPathDB/ApiCommonWebService

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ApiCommonWebService

WSF Plugins that are common to all VEuPathDB genomics (ApiCommon) web sites. See WSFPlugin/src for the list of plugins.

Additionally, the CLI implementation of the HighSpeedSnpSearch system that is called by the High Speed Snp Search plugin

Plugin Development

Plugins defined in this repository are implemented as extensions of AbstractPlugin.java.

Validation

In order for a 400 InvalidRequest user error to be propagated to the WDK client, a plugin's implementation of the validate method must throw a PluginUserException

By default, any exception thrown during the Plugin's invoke method is propagated as a 5xx error. In certain cases, it may be desired to throw a 4xx user error that can only be determined after execution of the plugin has begun. In these cases, the implementation must throw a PostValidationUserException which will be propagated to the client properly as a user error.

Dependencies

  • ant
  • Perl 5
  • Java 11+
  • External dependencies: see pom.xml
  • environment variables for GUS_HOME and PROJECT_HOME
  • Internal Dependencies: see build.xml

Installation instructions.

  • bld ApiCommonWebService

Manifest

  • WSFPlugin/config :: configuration for individual plugins
  • WSFPlugin/lib :: conifer and perl libraries for the plugins
  • WSFPlugin/src :: java source code for the plugins
  • HighSpeedSnpSearch/bin :: executables for HSSS
  • HighSpeedSnpSearch/doc :: docs for HSSS
  • HighSpeedSnpSearch/lib/perl :: perl libraries for HSSS
  • HighSpeedSnpSearch/src/c :: C src for HSSS
  • HighSpeedSnpSearch/test :: tests for HSSS

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published