Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/filip26/iridium-cbor-ld
A CBOR-based Processor for Linked Data
https://github.com/filip26/iridium-cbor-ld
cbor cbor-ld cborld compression java json-ld linked-data
Last synced: about 2 months ago
JSON representation
A CBOR-based Processor for Linked Data
- Host: GitHub
- URL: https://github.com/filip26/iridium-cbor-ld
- Owner: filip26
- License: apache-2.0
- Created: 2022-06-30T21:44:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T09:32:12.000Z (8 months ago)
- Last Synced: 2024-05-01T16:45:55.271Z (8 months ago)
- Topics: cbor, cbor-ld, cborld, compression, java, json-ld, linked-data
- Language: Java
- Homepage: https://apicatalog.com
- Size: 421 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ccamel - filip26/iridium-cbor-ld - A CBOR-based Processor for Linked Data (Java)
README
# Iridium CBOR-LD
An implementation of the [CBOR-LD 1.0](https://json-ld.github.io/cbor-ld-spec/) in Java.
### Features
* Semantic compression / decompression
* Configurable API
* Custom document dictionaries and builders
* [Verifiable Credential Barcodes](https://w3c-ccg.github.io/vc-barcodes/)
### Status
[](https://github.com/filip26/iridium-cbor-ld/actions/workflows/java17-push.yml)
[](https://app.codacy.com/gh/filip26/iridium-cbor-ld/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://app.codacy.com/gh/filip26/iridium-cbor-ld/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
[](https://search.maven.org/search?q=g:com.apicatalog%20AND%20a:iridium-cbor-ld)
[](https://opensource.org/licenses/Apache-2.0)
## CLI
[LD-CLI](https://github.com/filip26/ld-cli) is a command line utility for Ubuntu, Mac and Windows.
## Usage
### Encoding
```javascript
// create an encoder builder initialized with default values
var encoder = CborLd.createEncoder()
// use bundled static contexts (true by default)
.useBundledContexts(true)
// loader (optional)
.loader(...)
// custom terms dictionary (optional)
.dictionary(customDictionary)
// create a new encoder instance
.build();
// create barcodes encoder builder
var encoder = CborLd.createEncoder(BarcodesConfig.INSTANCE)
// ... customize
.build()
// encode a document
byte[] encoded = encoder.encode(document);
```
### Decoding
```javascript
// create a decoder builder initialized with default values
var decoder = CborLd.createDecoder()
// use bundled static contexts (true by default)
.useBundledContexts(true)
// loader (optional)
.loader(...)
// add custom terms dictionary (optional)
.dictionary(customDictionary);
// create a new decoder instance
.build();
// create barcodes decoder builder
var decoder = CborLd.createDecoder(BarcodesConfig.INSTANCE)
// ... customize
.build()
// decode
document = decoder.decode(encoded);
```
### Backward Compatibility
```javascript
// Iridium < v0.2.0
CborLd.create[Encoder|Decoder](V05Config.INSTANCE)
// ... customize
.build();
// Iridium < v0.2.0, @digitalbazaar/cborld compatibility
CborLd.create[Encoder|Decoder](V05Config.INSTANCE)
.compactArrays(false)
// ... customize
.build();
```
## Installation
Java 17+
```xml
com.apicatalog
iridium-cbor-ld
0.3.0
```
Iridium CBOR-LD for Android is distributed under a commercial license. [Contact](mailto:[email protected])
#### JSON-P Provider
Add JSON-P provider, if it is not on the classpath already.
```xml
org.glassfish
jakarta.json
2.0.1
```
## Documentation
[](https://javadoc.io/doc/com.apicatalog/iridium-cbor-ld)
## Contributing
All PR's welcome!
### Building
Fork and clone the project repository.
```bash
> cd iridium-cbor-ld
> mvn clean package
```
## Resources
* [CBOR-LD 1.0](https://json-ld.github.io/cbor-ld-spec/)
* [Concise Binary Object Representation (CBOR)](https://datatracker.ietf.org/doc/html/rfc8949)
* [Hello CBOR-LD Presentation](https://docs.google.com/presentation/d/1ksh-gUdjJJwDpdleasvs9aRXEmeRvqhkVWqeitx5ZAE/edit?usp=sharing)
* [cbor.io](https://cbor.io/)
* [JavaScript CBOR-LD Processor](https://github.com/digitalbazaar/cborld)
* [CBOR Playground](https://cbor.me/)
## Sponsors
## Commercial Support
Commercial support is available at [email protected]