JarCastingJSON datatype contributor for Hibernate ORM 5.2+
If you need to use javax.json.JsonArray, javax.json.JsonObject or javax.json.JsonStructure objects in your JPA entities and already use Hibernate as your JPA provider, this is the plugin for you, so long as Hibernate, your JSR-353 provider and this plugin are loaded by the same ClassLoader, which is the typical use-case.
Changelog:
Version 1.1:
- Updated Hibernate version to 5.2, requiring Java 8.
- Removed test dependency log4j, using JBoss logger, available from Hibernate, instead.
- Add database types to case-sensitive registration keys. No effect, unless you manage to somehow load the contributor with the hibernate-mapping tool for class generation from a live database.
build.gradleno longer mixes tabs and spaces for indentation. Now it's tabs only.
Version 1.2:
- When used in conjunction with
hibernate-array-contributor, it will automatically register the array types, and you have ahibernate.arrays.jsonproperty set totruein yourpersistence.xml.
Version 1.3:
- Add MySQL support, with some attempt at detection. Default is still PostgreSQL.
- Add support for configuration overrides.
- Cleaned-up various warnings around the build.
Set-up for testing environment:
- PostgreSQL 9.2 server or newer, running on port 5432
- MySQL 8.0.3 server or newer, running on port 3306
- Username, password and database
hibernate_orm_testwith full privileges that database on both servers.
Compiling:
Assuming you have your JAVA_HOME environment variable pointing to JDK8
./gradlew clean build
If you want to build without running the tests, use assemble instead of build.
To make the final jar available for your Maven or compatible project type that uses the Maven repository, run:
./gradlew publishToMavenLocal
Now you just need to add the dependency to your project's pom.xml.
<dependency>
<groupId>com.mopano</groupId>
<artifactId>hibernate-json-contributor</artifactId>
<version>1.3</version>
</dependency>
Or if you're using Gradle:
dependencies {
compile group: 'com.mopano', name: 'hibernate-json-contributor', version: '1.3'
}
Configuring against the default:
To use a custom configuration, you must implement the com.mopano.hibernate.json.spi.JsonSettings class and override any settings for which you do not wish to use the default.
You must list the class you've created as a standard Java service, by creating the file META-INF/services/com.mopano.hibernate.json.spi.JsonSettings in your resources directory, and adding the fully qualified class name of your implementation in it.
Be sure to read the JavaDoc hints.
Potential pitfall:
If your application is loaded after Hibernate, instead of alongside it, it might not load the type contributor. This can happen if you use Hibernate on a Glassfish server. In this case you would need to add it to Glassfish's classpath the same way you added Hibernate, as it is not the default provider.
You cannot use JsonArray objects as parameters in native queries before Hibernate version 5.2.10.
