From 498e46d94d868d38190bb972713a0ba1b42d13ff Mon Sep 17 00:00:00 2001 From: Stefan Kalscheuer Date: Sat, 27 Apr 2024 17:17:04 +0200 Subject: [PATCH] remove deprecated get...TimeString() methods from model classes (#77) --- CHANGELOG.md | 6 ++++ pom.xml | 2 +- .../response/embedded/SecretMetadata.java | 30 ----------------- .../model/response/embedded/TokenData.java | 32 ------------------- .../response/embedded/VersionMetadata.java | 30 ----------------- .../response/MetaSecretResponseTest.java | 4 --- .../model/response/MetadataResponseTest.java | 4 --- .../response/SecretVersionResponseTest.java | 2 -- .../model/response/TokenResponseTest.java | 2 -- 9 files changed, 7 insertions(+), 105 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d1565a..846e8b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## unreleased + +### Removal +* Remove deprecated `get...TimeString()` on model classes (#77) + + ## 1.3.1 (2024-10-03) ### Dependencies diff --git a/pom.xml b/pom.xml index 03873d4..9af5ae0 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ de.stklcode.jvault jvault-connector - 1.3.1 + 1.4.0-SNAPSHOT jar diff --git a/src/main/java/de/stklcode/jvault/connector/model/response/embedded/SecretMetadata.java b/src/main/java/de/stklcode/jvault/connector/model/response/embedded/SecretMetadata.java index 5451f0b..a592e64 100644 --- a/src/main/java/de/stklcode/jvault/connector/model/response/embedded/SecretMetadata.java +++ b/src/main/java/de/stklcode/jvault/connector/model/response/embedded/SecretMetadata.java @@ -21,7 +21,6 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.io.Serializable; import java.time.ZonedDateTime; -import java.time.format.DateTimeFormatter; import java.util.HashMap; import java.util.Map; import java.util.Objects; @@ -37,9 +36,6 @@ import java.util.Objects; public final class SecretMetadata implements Serializable { private static final long serialVersionUID = -905059942871916214L; - private static final DateTimeFormatter TIME_FORMAT = - DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSSSSSSSXXX"); - @JsonProperty("created_time") private ZonedDateTime createdTime; @@ -67,19 +63,6 @@ public final class SecretMetadata implements Serializable { @JsonProperty("delete_version_after") private String deleteVersionAfter; - /** - * @return Time of secret creation as raw string representation. - * @deprecated Method left for backwards compatibility only. Use {@link #getCreatedTime()} instead. - */ - @Deprecated(since = "1.2", forRemoval = true) - public String getCreatedTimeString() { - if (createdTime != null) { - return TIME_FORMAT.format(createdTime); - } - - return null; - } - /** * @return Time of secret creation. */ @@ -108,19 +91,6 @@ public final class SecretMetadata implements Serializable { return oldestVersion; } - /** - * @return Time of secret update as raw string representation. - * @deprecated Method left for backwards compatibility only. Use {@link #getUpdatedTime()} instead. - */ - @Deprecated(since = "1.2", forRemoval = true) - public String getUpdatedTimeString() { - if (updatedTime != null) { - return TIME_FORMAT.format(updatedTime); - } - - return null; - } - /** * @return Time of secret update. */ diff --git a/src/main/java/de/stklcode/jvault/connector/model/response/embedded/TokenData.java b/src/main/java/de/stklcode/jvault/connector/model/response/embedded/TokenData.java index b522f6b..e9d382a 100644 --- a/src/main/java/de/stklcode/jvault/connector/model/response/embedded/TokenData.java +++ b/src/main/java/de/stklcode/jvault/connector/model/response/embedded/TokenData.java @@ -21,7 +21,6 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.io.Serializable; import java.time.ZonedDateTime; -import java.time.format.DateTimeFormatter; import java.util.List; import java.util.Map; import java.util.Objects; @@ -37,9 +36,6 @@ import java.util.Objects; public final class TokenData implements Serializable { private static final long serialVersionUID = -5749716740973138916L; - private static final DateTimeFormatter TIME_FORMAT = - DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSSSSSSSXXX"); - @JsonProperty("accessor") private String accessor; @@ -127,20 +123,6 @@ public final class TokenData implements Serializable { return entityId; } - /** - * @return Expire time as raw string value - * @since 0.9 - * @deprecated Method left for backwards compatibility only. Use {@link #getExpireTime()} instead. - */ - @Deprecated(since = "1.2", forRemoval = true) - public String getExpireTimeString() { - if (expireTime != null) { - return TIME_FORMAT.format(expireTime); - } - - return null; - } - /** * @return Expire time (parsed) * @since 0.9 @@ -164,20 +146,6 @@ public final class TokenData implements Serializable { return id; } - /** - * @return Issue time as raw string value - * @since 0.9 - * @deprecated Method left for backwards compatibility only. Use {@link #getIssueTime()} instead. - */ - @Deprecated(since = "1.2", forRemoval = true) - public String getIssueTimeString() { - if (issueTime != null) { - return TIME_FORMAT.format(issueTime); - } - - return null; - } - /** * @return Expire time (parsed) * @since 0.9 diff --git a/src/main/java/de/stklcode/jvault/connector/model/response/embedded/VersionMetadata.java b/src/main/java/de/stklcode/jvault/connector/model/response/embedded/VersionMetadata.java index 012e736..d5e5f08 100644 --- a/src/main/java/de/stklcode/jvault/connector/model/response/embedded/VersionMetadata.java +++ b/src/main/java/de/stklcode/jvault/connector/model/response/embedded/VersionMetadata.java @@ -21,7 +21,6 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.io.Serializable; import java.time.ZonedDateTime; -import java.time.format.DateTimeFormatter; import java.util.HashMap; import java.util.Map; import java.util.Objects; @@ -37,9 +36,6 @@ import java.util.Objects; public final class VersionMetadata implements Serializable { private static final long serialVersionUID = 8495687554714216478L; - private static final DateTimeFormatter TIME_FORMAT = - DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSSSSSSSXXX"); - @JsonProperty("created_time") private ZonedDateTime createdTime; @@ -55,19 +51,6 @@ public final class VersionMetadata implements Serializable { @JsonProperty("custom_metadata") private HashMap customMetadata; - /** - * @return Time of secret creation as raw string representation. - * @deprecated Method left for backwards compatibility only. Use {@link #getCreatedTime()} instead. - */ - @Deprecated(since = "1.2", forRemoval = true) - public String getCreatedTimeString() { - if (createdTime != null) { - return TIME_FORMAT.format(createdTime); - } - - return null; - } - /** * @return Time of secret creation. */ @@ -75,19 +58,6 @@ public final class VersionMetadata implements Serializable { return createdTime; } - /** - * @return Time for secret deletion as raw string representation. - * @deprecated Method left for backwards compatibility only. Use {@link #getDeletionTime()} instead. - */ - @Deprecated(since = "1.2", forRemoval = true) - public String getDeletionTimeString() { - if (deletionTime != null) { - return TIME_FORMAT.format(deletionTime); - } - - return null; - } - /** * @return Time for secret deletion. */ diff --git a/src/test/java/de/stklcode/jvault/connector/model/response/MetaSecretResponseTest.java b/src/test/java/de/stklcode/jvault/connector/model/response/MetaSecretResponseTest.java index 6706d49..523d08a 100644 --- a/src/test/java/de/stklcode/jvault/connector/model/response/MetaSecretResponseTest.java +++ b/src/test/java/de/stklcode/jvault/connector/model/response/MetaSecretResponseTest.java @@ -115,9 +115,7 @@ class MetaSecretResponseTest extends AbstractModelTest { ); assertSecretData(res); assertNotNull(res.getMetadata(), "SecretResponse does not contain metadata"); - assertEquals(SECRET_META_CREATED, res.getMetadata().getCreatedTimeString(), "Incorrect creation date string"); assertNotNull(res.getMetadata().getCreatedTime(), "Creation date parsing failed"); - assertNull(res.getMetadata().getDeletionTimeString(), "Incorrect deletion date string"); assertNull(res.getMetadata().getDeletionTime(), "Incorrect deletion date"); assertFalse(res.getMetadata().isDestroyed(), "Secret destroyed when not expected"); assertEquals(1, res.getMetadata().getVersion(), "Incorrect secret version"); @@ -130,9 +128,7 @@ class MetaSecretResponseTest extends AbstractModelTest { ); assertSecretData(res); assertNotNull(res.getMetadata(), "SecretResponse does not contain metadata"); - assertEquals(SECRET_META_CREATED, res.getMetadata().getCreatedTimeString(), "Incorrect creation date string"); assertNotNull(res.getMetadata().getCreatedTime(), "Creation date parsing failed"); - assertEquals(SECRET_META_DELETED, res.getMetadata().getDeletionTimeString(), "Incorrect deletion date string"); assertNotNull(res.getMetadata().getDeletionTime(), "Incorrect deletion date"); assertTrue(res.getMetadata().isDestroyed(), "Secret destroyed when not expected"); assertEquals(2, res.getMetadata().getVersion(), "Incorrect secret version"); diff --git a/src/test/java/de/stklcode/jvault/connector/model/response/MetadataResponseTest.java b/src/test/java/de/stklcode/jvault/connector/model/response/MetadataResponseTest.java index 2215e18..dd565fa 100644 --- a/src/test/java/de/stklcode/jvault/connector/model/response/MetadataResponseTest.java +++ b/src/test/java/de/stklcode/jvault/connector/model/response/MetadataResponseTest.java @@ -100,20 +100,16 @@ class MetadataResponseTest extends AbstractModelTest { assertNotNull(res, "Parsed response is NULL"); assertNotNull(res.getMetadata(), "Parsed metadata is NULL"); assertEquals(CAS_REQUIRED, res.getMetadata().isCasRequired(), "Incorrect CAS required flag"); - assertEquals(V1_TIME, res.getMetadata().getCreatedTimeString(), "Incorrect created time"); assertNotNull(res.getMetadata().getCreatedTime(), "Parting created time failed"); assertEquals(CURRENT_VERSION, res.getMetadata().getCurrentVersion(), "Incorrect current version"); assertEquals(MAX_VERSIONS, res.getMetadata().getMaxVersions(), "Incorrect max versions"); assertEquals(OLDEST_VERSION, res.getMetadata().getOldestVersion(), "Incorrect oldest version"); assertEquals(Map.of(CUSTOM_META_KEY, CUSTOM_META_VAL), res.getMetadata().getCustomMetadata(), "Incorrect custom metadata"); assertEquals(DELETE_VERSION_AFTER, res.getMetadata().getDeleteVersionAfter(), "Incorrect delete version after"); - assertEquals(V3_TIME, res.getMetadata().getUpdatedTimeString(), "Incorrect updated time"); assertNotNull(res.getMetadata().getUpdatedTime(), "Parting updated time failed"); assertEquals(3, res.getMetadata().getVersions().size(), "Incorrect number of versions"); - assertEquals(V2_TIME, res.getMetadata().getVersions().get(1).getDeletionTimeString(), "Incorrect version 1 delete time"); assertNotNull(res.getMetadata().getVersions().get(1).getDeletionTime(), "Parsing version delete time failed"); assertTrue(res.getMetadata().getVersions().get(1).isDestroyed(), "Incorrect version 1 destroyed state"); - assertEquals(V2_TIME, res.getMetadata().getVersions().get(2).getCreatedTimeString(), "Incorrect version 2 created time"); assertNotNull(res.getMetadata().getVersions().get(2).getCreatedTime(), "Parsing version created failed"); assertFalse(res.getMetadata().getVersions().get(3).isDestroyed(), "Incorrect version 3 destroyed state"); } diff --git a/src/test/java/de/stklcode/jvault/connector/model/response/SecretVersionResponseTest.java b/src/test/java/de/stklcode/jvault/connector/model/response/SecretVersionResponseTest.java index 9835edf..84eb329 100644 --- a/src/test/java/de/stklcode/jvault/connector/model/response/SecretVersionResponseTest.java +++ b/src/test/java/de/stklcode/jvault/connector/model/response/SecretVersionResponseTest.java @@ -67,8 +67,6 @@ class SecretVersionResponseTest extends AbstractModelTest ); assertNotNull(res, "Parsed response is NULL"); assertNotNull(res.getMetadata(), "Parsed metadata is NULL"); - assertEquals(CREATION_TIME, res.getMetadata().getCreatedTimeString(), "Incorrect created time"); - assertEquals(DELETION_TIME, res.getMetadata().getDeletionTimeString(), "Incorrect deletion time"); assertFalse(res.getMetadata().isDestroyed(), "Incorrect destroyed state"); assertEquals(VERSION, res.getMetadata().getVersion(), "Incorrect version"); } diff --git a/src/test/java/de/stklcode/jvault/connector/model/response/TokenResponseTest.java b/src/test/java/de/stklcode/jvault/connector/model/response/TokenResponseTest.java index a04e9c8..6e37467 100644 --- a/src/test/java/de/stklcode/jvault/connector/model/response/TokenResponseTest.java +++ b/src/test/java/de/stklcode/jvault/connector/model/response/TokenResponseTest.java @@ -136,11 +136,9 @@ class TokenResponseTest extends AbstractModelTest { assertEquals(TOKEN_TTL, data.getCreationTtl(), "Incorrect token creation TTL"); assertEquals(TOKEN_DISPLAY_NAME, data.getName(), "Incorrect token display name"); assertEquals(TOKEN_ENTITY_ID, data.getEntityId(), "Incorrect token entity ID"); - assertEquals(TOKEN_EXPIRE_TIME, data.getExpireTimeString(), "Incorrect token expire time"); assertEquals(ZonedDateTime.parse(TOKEN_EXPIRE_TIME), data.getExpireTime(), "Incorrect parsed token expire time"); assertEquals(TOKEN_EXPLICIT_MAX_TTL, data.getExplicitMaxTtl(), "Incorrect token explicit max TTL"); assertEquals(TOKEN_ID, data.getId(), "Incorrect token ID"); - assertEquals(TOKEN_ISSUE_TIME, data.getIssueTimeString(), "Incorrect token issue time"); assertEquals(ZonedDateTime.parse(TOKEN_ISSUE_TIME), data.getIssueTime(), "Incorrect parsed token issue time"); assertEquals(Map.of(TOKEN_META_KEY, TOKEN_META_VALUE), data.getMeta(), "Incorrect token metadata"); assertEquals(TOKEN_NUM_USES, data.getNumUses(), "Incorrect token number of uses");