What frameworks are available and what are the pros and cons

[MikeNeilson]

REST API frameworks

framework	link	pros	cons
JAX-RS	https://github.com/jakartaee/rest	Jakarta (nee Java) EE standard multiple implementations container (Tomcat/Jetty/Jboss/etc) agnostic	Likely slow to implement new changes due to standards process
Javalin	https://javalin.io/	Simple Hooks for various Auth mechanism good Swagger (OpenAPI) doc generation Designed to run standalone or within an App server Used by an OpenDCS partner agency (https://github.com/USACE/cwms-radar-api)	There is some initial setup for validation.
Spring	spring.io	Has a library for everything	Has a library for everything

SQL Frameworks

framework	link	pros	cons	license	active developers
JDBC		It'll always be there.	Provides little help for type checking. Lots of manual work.	depends on provide	yes
JDBI	https://jdbi.org/	Completely OpenSource Lite weight wrapper around JDBC Provides type checking Uses java 8+ streams and groupby which is good for joins Abstracts SQL syntax issues for the caller (for example returning the generated ID without making another query)	Still some manual work for type checking to behave correctly, but less than JDBC.	Apache-2.0	yes
SqlQuery	http://querydsl.com/	Code generation from active db to enforce type checking Abstracts Database differences	Code generation -- we support 3 databases, one already uses JOOQ	Apache-2.0	Yes, however it did have some previous downtime
JOOQ	jooq.org	Code generation Abstracts Database differences	Code generation Only free for the open source databases (SQLITE,Postgres, MariaDB, etc)	OpenSource/Commerical	very
JPA (hibernate,spring,etc)		well supported	Basically no control over the SQL without a lot of work. This would likely be problematic in OpenDCS as we support 3 independant databases. At least within the current design. Would require altering every current class that holds database data with annotations or creating new classes to transfer data.	various	yes

[MikeNeilson]

@opendcs/opendcs-core-devs

[agilmore2]

The only criteria I'd add to the usual is a framework that Reclamation Enterprise IT folks are willing to host. Not sure we could get an answer to it, but that's what I'm concerned about.

…

On Thu, Sep 15, 2022, 09:12 Mike Neilson ***@***.***> wrote: @opendcs/opendcs-core-devs <https://github.com/orgs/opendcs/teams/opendcs-core-devs> — Reply to this email directly, view it on GitHub <#4 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABUI5SSJMZ46HL75LLPA4ADV6M4EHANCNFSM6AAAAAAQNP2HDY> . You are receiving this because you are on a team that was mentioned.Message ID: ***@***.***>

[MikeNeilson]

The target is to support running in one of the many Java EE Applications servers:

• Tomcat
• TomEE
• Jboss
• Glassfish
• Jetty (standalone but can proxy through apache or haproxy if they have concerns.)

I'd be surprised though if literally none of those were supported, if you're using Apex from ORDS you've got Tomcat going.

Granted an initial release might have some problems meeting that goal being a rather broad scope but the final target will be "the Web profile" and not a specific Application server. (at least as far as continued development by the OpenDCS group goes.)

[adamkorynta]

I can vouch for jOOQ having excellent documentation.

[MikeNeilson]

very, though the licensing makes it difficult, it would have to be an only for the reference postgresql database and the rest is onus on the agency implementation. Maybe that's a good thing, I'm not sure. I feel like JDBI would be a reasonable balance though with letting some default implementation exist for things like the Enums, etc that don't really change between databases.

[adamkorynta]

Yeah and JDBI's documentation looks good, though I can't vouch for it in practice.