-
Notifications
You must be signed in to change notification settings - Fork 9
/
index.html
187 lines (152 loc) · 9.09 KB
/
index.html
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<!--
Copyright (C) 2005, 2006 Joe Walnes.
Copyright (C) 2006, 2007, 2008, 2021 XStream committers.
All rights reserved.
The software in this package is published under the terms of the BSD
style license a copy of which has been included with this distribution in
the LICENSE.txt file.
Created on 29. January 2005 by Joe Walnes
-->
<head>
<title>XStream - About XStream</title>
<link rel="stylesheet" type="text/css" href="style.css"/>
<meta name="short" content="About XStream"/>
<!-- Google analytics -->
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-110973-2";
urchinTracker();
</script>
</head>
<body>
<div id="banner">
<a href="index.html"><img id="logo" src="logo.gif" alt="XStream"/></a>
</div>
<div id="center" class="Content2Column"> <!-- Content3Column for index -->
<div id="content">
<h1 class="FirstChild">About XStream</h1>
<p>XStream is a simple library to serialize objects to XML and back again.</p>
<h1 id="features">Features</h1>
<ul>
<li><b>Ease of use.</b> A high level facade is supplied that simplifies common use cases.</li>
<li><b>No mappings required.</b> Most objects can be serialized without need for specifying mappings.</li>
<li><b>Performance.</b> Speed and low memory footprint are a crucial part of the design, making it suitable for
large object graphs or systems with high message throughput.</li>
<li><b>Clean XML.</b> No information is duplicated that can be obtained via reflection. This results
in XML that is easier to read for humans and more compact than native Java serialization.</li>
<li><b>Requires no modifications to objects.</b> Serializes internal fields, including private and
final. Supports non-public and inner classes. Classes are not required to have default constructor.</li>
<li><b>Full object graph support.</b> Duplicate references encountered in the object-model will
be maintained. Supports circular references.</li>
<li><b>Integrates with other XML APIs.</b> By implementing an interface, XStream can serialize
directly to/from any tree structure (not just XML).</li>
<li><b>Customizable conversion strategies.</b> Strategies can be registered allowing customization of how
particular types are represented as XML.</li>
<li><b>Security framework.</b> Fine-control about the unmarshalled types to prevent security issues with
manipulated input.</li>
<li><b>Error messages.</b> When an exception occurs due to malformed XML, detailed diagnostics are provided
to help isolate and fix the problem.</li>
<li><b>Alternative output format.</b> The modular design allows other output formats. XStream ships currently
with JSON support and morphing.</li>
</ul>
<h1 id="use-cases">Typical Uses</h1>
<ul>
<li><b>Transport</b></li>
<li><b>Persistence</b></li>
<li><b>Configuration</b></li>
<li><b>Unit Tests</b></li>
</ul>
<h1 id="limitations">Known Limitations</h1>
<p>If using the enhanced mode, XStream can re-instantiate classes that do not have a default constructor.
However, if using a different JVM like an old JRockit version, a JDK 1.4 or you have restrictions because of a
SecurityManager, a default constructor is required.</p>
<p>The enhanced mode is also necessary to restore final fields for any JDK < 1.5. This implies deserialization of
instances of an inner class.</p>
<p>Auto-detection of annotations may cause race conditions. Preprocessing annotations is safe though.</p>
<h1 id="getting-started">Getting Started</h1>
<ul>
<li><a href="download.html">Download it</a>.</li>
<li><a href="tutorial.html">Use it</a>.</li>
</ul>
<h1 id="news">Latest News</h1>
<h2 id="release"><b>November 7, 2024</b> XStream 1.4.21 released</h2>
<p class="highlight">This maintenance release addresses the security vulnerability
<a href="CVE-2024-47072.html">CVE-2024-47072</a>, when using the BinaryDriver to unmarshal a manipulated input
stream causing a Denial of Service due to a stack overflow.</p>
<p>A new converter fir the WeakHashMap avoids the access to the ReentrantLock introduced with Java 19.</p>
<p>The release contains an optimization for the memory consumption.</p>
<p>View the complete <a href="changes.html">change log</a> and <a href="download.html">download</a>.</p>
<p>Note, the next major release 1.5 will require Java 11.</p>
<br/>
</div>
</div>
<div class="SidePanel" id="left">
<div class="MenuGroup">
<h1>Software</h1>
<ul>
<li class="currentLink">About XStream</li>
<li><a href="news.html">News</a></li>
<li><a href="changes.html">Change History</a></li>
<li><a href="security.html">Security Aspects</a></li>
<li><a href="versioning.html">About Versioning</a></li>
</ul>
</div>
<div class="MenuGroup">
<h1>Evaluating XStream</h1>
<ul>
<li><a href="tutorial.html">Two Minute Tutorial</a></li>
<li><a href="license.html">License</a></li>
<li><a href="download.html">Download</a></li>
<li><a href="references.html">References</a></li>
<li><a href="benchmarks.html">Benchmarks</a></li>
<li><a href="https://www.openhub.net/p/xstream">Code Statistics</a></li>
</ul>
</div>
<div class="MenuGroup">
<h1>Using XStream</h1>
<ul>
<li><a href="architecture.html">Architecture Overview</a></li>
<li><a href="graphs.html">Object references</a></li>
<li><a href="manual-tweaking-output.html">Tweaking the Output</a></li>
<li><a href="converters.html">Converters</a></li>
<li><a href="faq.html">Frequently Asked Questions</a></li>
<li><a href="mailing-lists.html">Mailing Lists</a></li>
<li><a href="issues.html">Reporting Issues</a></li>
</ul>
</div>
<div class="MenuGroup">
<h1>Javadoc</h1>
<ul>
<li><a href="javadoc/index.html">XStream Core</a></li>
<li><a href="hibernate-javadoc/index.html">Hibernate Extensions</a></li>
<li><a href="jmh-javadoc/index.html">JMH Module</a></li>
</ul>
</div>
<div class="MenuGroup">
<h1>Tutorials</h1>
<ul>
<li><a href="tutorial.html">Two Minute Tutorial</a></li>
<li><a href="alias-tutorial.html">Alias Tutorial</a></li>
<li><a href="annotations-tutorial.html">Annotations Tutorial</a></li>
<li><a href="converter-tutorial.html">Converter Tutorial</a></li>
<li><a href="objectstream.html">Object Streams Tutorial</a></li>
<li><a href="persistence-tutorial.html">Persistence API Tutorial</a></li>
<li><a href="json-tutorial.html">JSON Tutorial</a></li>
<li><a href="http://www.studytrails.com/java/xml/xstream/xstream-introduction.jsp">StudyTrails</a></li>
</ul>
</div>
<div class="MenuGroup">
<h1>Developing XStream</h1>
<ul>
<li><a href="how-to-contribute.html">How to Contribute</a></li>
<li><a href="team.html">Development Team</a></li>
<li><a href="repository.html">Source Repository</a></li>
<li><a href="https://travis-ci.org/x-stream/xstream/branches">Continuous Integration</a></li>
</ul>
</div>
</div>
</body>
</html>