jvindicator
Trivial parameter validation functions intended for use in HTTP servlet applications.
Features
- Type-safe parameter validation.
- Written in pure Java 21.
- OSGi ready.
- JPMS ready.
- ISC license.
- High-coverage automated test suite.
Usage
Use the Vindicator class to build a validator, and then call check(). After
calling check(), parameters can be inspected in a type-safe manner:
final var v =
Vindication.start();
final var p0 =
v.addRequiredParameter("u0", Vindication.integerUnsigned());
final var p1 =
v.addRequiredParameter("u1", Vindication.integerUnsignedLong());
final var p2 =
v.addRequiredParameter("s0", Vindication.integerSigned());
final var p3 =
v.addRequiredParameter("s1", Vindication.integerSignedLong());
final var p4 =
v.addRequiredParameter("i0", Vindication.integerBig());
v.check(Map.ofEntries(
Map.entry("u0", new String[]{"23"}),
Map.entry("u1", new String[]{"24"}),
Map.entry("s0", new String[]{"-23"}),
Map.entry("s1", new String[]{"-24"}),
Map.entry("i0", new String[]{"-4703919738795935661825"})
));
assertEquals(23, p0.get());
assertEquals(24L, p1.get());
assertEquals(-23, p2.get());
assertEquals(-24L, p3.get());
assertEquals(new BigInteger("-4703919738795935661825"), p4.get());
Releases & Development Snapshots
Releases
You can subscribe to the atom feed to be notified of project releases.
The most recently released version of the package is 1.0.0.
1.0.0 Release (2024-05-11Z)
- Initial public release.
The compiled artifacts for the release (and all previous releases) are available on Maven Central.
Maven Modules
<dependency> <group>com.io7m.jvindicator</group> <artifactId>com.io7m.jvindicator.core</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.jvindicator</group> <artifactId>com.io7m.jvindicator.tests</artifactId> <version>1.0.0</version> </dependency>
Development Snapshots
At the time of writing, the current unstable development version of the package is 1.0.1-SNAPSHOT.
Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.
Manual
This project does not have any user manuals or other documentation beyond what might be present on the page above.
Sources
This project uses Git to manage source code.
Repository: https://www.github.com/io7m-com/jvindicator
$ git clone --recursive https://www.github.com/io7m-com/jvindicator
Issues
This project uses GitHub Issues to track issues.
License
Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.