1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
<!--
SPDX-FileCopyrightText: © 2021 Matthias Andreas Benkard <code@mail.matthias.benkard.de>
SPDX-License-Identifier: GFDL-1.3-or-later
-->
# GVariant for Java
This library provides a [GVariant][] parser in pure Java.
## Overview
`jgvariant-core` provides `Decoder<T>`, which read a given type of
GVariant-encoded value from a [ByteBuffer][]. The class also contains
factory methods to acquire those instances.
The various subclasses of `Decoder` together implement the [GVariant
serialization][] specification.
`jgvariant-ostree` provides instances of `Decoder<T>` for various
[GVariant][] types used in [OSTree][] repositories.
## Example
To parse a [GVariant][] value of type `"a(si)"`, which is an array of
pairs of [String][] and `int`, you can use the following code:
record ExampleRecord(String s, int i) {}
var decoder =
Decoder.ofArray(
Decoder.ofStructure(
ExampleRecord.class,
Decoder.ofString(StandardCharsets.UTF_8),
Decoder.ofInt().withByteOrder(ByteOrder.LITTLE_ENDIAN)));
byte[] bytes = ...;
List<ExampleRecord> example = decoder.decode(ByteBuffer.wrap(bytes));
## Command line tool
The `jgvariant-tool` module contains a tool called `jgvariant` that can
be used to manipulate [GVariant][]-formatted files from the command line.
Its primary purpose is to enable the scripting of [OSTree][] repository
management tasks.
Usage example (dumping the contents of an [OSTree][] summary file):
$ jgvariant ostree summary read ./jgvariant-ostree/src/test/resources/ostree/summary
Output:
{
"entries": [
{
"ref": "mulkos/1.x/amd64",
"value": {
"checksum": "66ff167ff35ce87daac817447a9490a262ee75f095f017716a6eb1a9d9eb3350",
"metadata": {
"fields": {
"ostree.commit.timestamp": 1640537170
}
},
"size": 214
}
}
],
"metadata": {
"fields": {
"ostree.summary.last-modified": 1640537300,
"ostree.summary.tombstone-commits": false,
"ostree.static-deltas": {
"3d3b3329dca38871f29aeda1bf5854d76c707fa269759a899d0985c91815fe6f-66ff167ff35ce87daac817447a9490a262ee75f095f017716a6eb1a9d9eb3350": "03738040e28e7662e9c9d2599c530ea974e642c9f87e6c00cbaa39a0cdac8d44",
"31c8835d5c9d2c6687a50091c85142d1b2d853ff416a9fb81b4ee30754510d52": "f481144629474bd88c106e45ac405ebd75b324b0655af1aec14b31786ae1fd61",
"31c8835d5c9d2c6687a50091c85142d1b2d853ff416a9fb81b4ee30754510d52-3d3b3329dca38871f29aeda1bf5854d76c707fa269759a899d0985c91815fe6f": "2c6a07bc1cf4d7ce7d00f82d7d2d6d156fd0e31d476851b46dc2306b181b064a"
},
"ostree.summary.mode": "bare",
"ostree.summary.indexed-deltas": true
}
}
}
You can build the tool either as a shaded JAR or as a native executable.
To build and run a shaded JAR:
$ mvn package -pl jgvariant-tool -am -Pshade
$ java -jar jgvariant-tool/target/jgvariant-tool-*.jar ...
To build and run a native executable:
$ mvn package -pl jgvariant-tool -am -Pnative
$ ./jgvariant-tool/target/jgvariant ...
You can also run the tool directly with Maven using the `exec` profile:
$ mvn verify -pl jgvariant-tool -am -Pexec -Dexec.args="..."
## Library installation
### Usage with Maven
<project>
...
<dependencyManagement>
...
<dependencies>
<dependency>
<groupId>eu.mulk.jgvariant</groupId>
<artifactId>jgvariant-bom</artifactId>
<version>0.1.7</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
...
</dependencyManagement>
<dependencies>
...
<dependency>
<groupId>eu.mulk.jgvariant</groupId>
<artifactId>jgvariant-core</artifactId>
</dependency>
<dependency>
<groupId>eu.mulk.jgvariant</groupId>
<artifactId>jgvariant-ostree</artifactId>
</dependency>
...
</dependencies>
...
</project>
### Usage with Gradle
dependencies {
...
implementation(platform("eu.mulk.jgvariant:jgvariant-bom:0.1.7")
implementation("eu.mulk.jgvariant:jgvariant-core")
implementation("eu.mulk.jgvariant:jgvariant-ostree")
...
}
[ByteBuffer]: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html
[GVariant]: https://docs.gtk.org/glib/struct.Variant.html
[GVariant serialization]: https://people.gnome.org/~desrt/gvariant-serialisation.pdf
[OSTree]: https://ostreedev.github.io/ostree/
[String]: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html
|
