From 2e356172d4a41169f0b2fa4992845dbb86f4dbdd Mon Sep 17 00:00:00 2001
From: zzz <zzz@mail.i2p>
Date: Fri, 26 Apr 2013 17:12:37 +0000
Subject: [PATCH] document ignored RouterAddress expiration (ticket #832)
---
core/java/src/net/i2p/data/RouterAddress.java | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/core/java/src/net/i2p/data/RouterAddress.java b/core/java/src/net/i2p/data/RouterAddress.java
index 768673f9f1..696afe2de8 100644
--- a/core/java/src/net/i2p/data/RouterAddress.java
+++ b/core/java/src/net/i2p/data/RouterAddress.java
@@ -30,6 +30,11 @@ import net.i2p.util.OrderedProperties;
* To ensure integrity of the RouterInfo, methods that change an element of the
* RouterInfo will throw an IllegalStateException after the RouterInfo is signed.
*
+ * As of 0.9.3, expiration MUST be all zeros as it is ignored on
+ * readin and the signature will fail.
+ * If we implement expiration, or other use for the field, we must allow
+ * several releases for the change to propagate as it is backwards-incompatible.
+ *
* @author jrandom
*/
public class RouterAddress extends DataStructureImpl {
@@ -73,6 +78,8 @@ public class RouterAddress extends DataStructureImpl {
/**
* Retrieve the date after which the address should not be used. If this
* is null, then the address never expires.
+ * As of 0.9.3, expiration MUST be all zeros as it is ignored on
+ * readin and the signature will fail.
*
* @deprecated unused for now
* @return null always
@@ -84,6 +91,8 @@ public class RouterAddress extends DataStructureImpl {
/**
* Configure the expiration date of the address (null for no expiration)
+ * As of 0.9.3, expiration MUST be all zeros as it is ignored on
+ * readin and the signature will fail.
*
* Unused for now, always null
* @deprecated unused for now
@@ -196,6 +205,8 @@ public class RouterAddress extends DataStructureImpl {
}
/**
+ * As of 0.9.3, expiration MUST be all zeros as it is ignored on
+ * readin and the signature will fail.
* @throws IllegalStateException if was already read in
*/
public void readBytes(InputStream in) throws DataFormatException, IOException {
@@ -213,6 +224,10 @@ public class RouterAddress extends DataStructureImpl {
DataHelper.readProperties(in, _options);
}
+ /**
+ * As of 0.9.3, expiration MUST be all zeros as it is ignored on
+ * readin and the signature will fail.
+ */
public void writeBytes(OutputStream out) throws DataFormatException, IOException {
if ((_cost < 0) || (_transportStyle == null))
throw new DataFormatException("Not enough data to write a router address");
--
GitLab