Skip to content
A pluggable BSON generator and parser for Jackson JSON processor.
Java Scala
Pull request Compare This branch is 3 commits ahead, 148 commits behind michel-kraemer:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.settings
project
src
.gitignore
.project
LICENSE.txt
README.rst

README.rst

BSON for Jackson

This library adds support for BSON to the Jackson JSON processor.

BSON is a binary representation of JSON. It has gained prominence by its usage as the main exchange and persistence format of the document-oriented database management system MongoDB.

Usage

The bson4jackson library integrates completely into Jackson. Please have a look at the Jackson wiki for a complete description. For more information you may also have a look at the bson4jackson tutorial.

The BSON specification defines some additional types not available in the original JSON specification. These types are mapped to simple wrapper objects.

Download

bson4jackson binaries are available from the GitHub Download page.

You may also use Maven to download bson4jackson:

<dependencies>
  <dependency>
    <groupId>de.undercouch</groupId>
    <artifactId>bson4jackson</artifactId>
    <version>1.1.2</version>
  </dependency>
</dependencies>

If you're using sbt, you may add the following line to your project:

val bson4jackson = "de.undercouch" % "bson4jackson" % "1.1.2"

License

bson4jackson is licensed under the Apache License, Version 2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Compiling

You need sbt in order to compile the bson4jackson library. Please follow the instructions on the sbt wiki.

Execute the following command to compile the library and to run the unit tests:

sbt update compile test

If everything runs successfully, you may create a .jar library:

sbt clean package

The library will be located under the target directory.

Eclipse

The source code includes a Eclipse project file. You may use the sbt-eclipse-plugin to include libraries managed by sbt into the project's classpath.

Something went wrong with that request. Please try again.