chore: deprecate kraken api (#535)

* chore: Kraken decommission preparation * chore: remove distributionManagement for relocation * chore: update deprecation text * fix: typo in text Co-authored-by: Philipp Heuer <git@philippheuer.me>
twitch4j · May 5, 2022 · fd31b90 · fd31b90
1 parent 8e0c28f
commit fd31b90
Show file tree

Hide file tree

Showing 43 changed files with 204 additions and 0 deletions.
diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/TwitchKraken.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/TwitchKraken.java
@@ -19,7 +19,11 @@
  * Twitch - Kraken API
  * <p>
  * Kraken is already deprecated, so we only offer methods which haven't been added to the new helix api yet. Please use the helix api if available.
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ *
  */
+@Deprecated
 public interface TwitchKraken {
 
     /**

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/TwitchKrakenBuilder.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/TwitchKrakenBuilder.java
@@ -24,10 +24,15 @@
 
 import java.util.concurrent.TimeUnit;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Slf4j
 @NoArgsConstructor(access = AccessLevel.PRIVATE)
 @AllArgsConstructor(access = AccessLevel.PRIVATE)
 @Getter
+@Deprecated
 public class TwitchKrakenBuilder {
 
     /**
@@ -95,7 +100,10 @@ public static TwitchKrakenBuilder builder() {
      *
      * @return TwitchKraken
      */
+    @Deprecated
     public TwitchKraken build() {
+        log.warn("Kraken is deprecated and has been shut down on Febuary 28, 2022.");
+        log.warn("More details about the decommission are available here: https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline");
         log.debug("Kraken: Initializing Module ...");
 
         // Hystrix

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/TwitchKrakenErrorDecoder.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/TwitchKrakenErrorDecoder.java
@@ -18,7 +18,12 @@
 import java.io.InputStream;
 import java.nio.charset.StandardCharsets;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Slf4j
+@Deprecated
 public class TwitchKrakenErrorDecoder implements ErrorDecoder {
 
     // Decoder

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/AbstractResultList.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/AbstractResultList.java
@@ -5,8 +5,11 @@
 
 /**
  * Abstract base for result lists.
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
  */
 @Data
+@Deprecated
 public abstract class AbstractResultList {
 
 	/**

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/ChatBadge.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/ChatBadge.java
@@ -4,7 +4,12 @@
 import lombok.Data;
 import lombok.Setter;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class ChatBadge {
     private String alpha;

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/ChatBadges.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/ChatBadges.java
@@ -4,7 +4,12 @@
 import lombok.Data;
 import lombok.Setter;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class ChatBadges {
     private ChatBadge admin;

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/Emoticon.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/Emoticon.java
@@ -4,7 +4,12 @@
 import lombok.Data;
 import lombok.Setter;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class Emoticon {
     private Integer id;

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/EmoticonImages.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/EmoticonImages.java
@@ -4,7 +4,12 @@
 import lombok.Data;
 import lombok.Setter;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class EmoticonImages {
     private Integer emoticonSet;

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/EmoticonList.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/EmoticonList.java
@@ -6,7 +6,12 @@
 
 import java.util.List;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class EmoticonList {
     private List<Emoticon> emoticons;

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/EmoticonSetEntry.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/EmoticonSetEntry.java
@@ -4,7 +4,12 @@
 import lombok.Data;
 import lombok.Setter;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class EmoticonSetEntry {
     private String code;

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/EmoticonSetList.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/EmoticonSetList.java
@@ -8,7 +8,12 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class EmoticonSetList {
 

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenBlock.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenBlock.java
@@ -4,7 +4,12 @@
 import lombok.Data;
 import lombok.Setter;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class KrakenBlock {
     private KrakenUser user;

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenBlockList.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenBlockList.java
@@ -8,7 +8,12 @@
 
 import java.util.List;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @ToString(callSuper = true)
 @Setter(AccessLevel.PRIVATE)
 @EqualsAndHashCode(callSuper = true)

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenBlockTransaction.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenBlockTransaction.java
@@ -7,7 +7,12 @@
 
 import java.time.Instant;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class KrakenBlockTransaction {
     @JsonProperty("_id")

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenChannel.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenChannel.java
@@ -7,7 +7,12 @@
 
 import java.time.Instant;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class KrakenChannel {
     @JsonProperty("_id")

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenClip.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenClip.java
@@ -6,7 +6,12 @@
 
 import java.time.Instant;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class KrakenClip {
     private String slug;

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenCollection.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenCollection.java
@@ -7,7 +7,12 @@
 
 import java.util.List;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class KrakenCollection {
 

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenCollectionItem.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenCollectionItem.java
@@ -7,7 +7,12 @@
 
 import java.time.Instant;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class KrakenCollectionItem {
 

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenCollectionList.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenCollectionList.java
@@ -4,7 +4,12 @@
 
 import java.util.List;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @ToString(callSuper = true)
 @Setter(AccessLevel.PRIVATE)
 @EqualsAndHashCode(callSuper = true)

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenCollectionMetadata.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenCollectionMetadata.java
@@ -7,7 +7,12 @@
 
 import java.time.Instant;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class KrakenCollectionMetadata {
     @JsonProperty("_id")

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenCollectionThumbnails.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenCollectionThumbnails.java
@@ -4,7 +4,12 @@
 import lombok.Data;
 import lombok.Setter;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class KrakenCollectionThumbnails {
     public String large;

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenCreatedVideo.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenCreatedVideo.java
@@ -4,7 +4,12 @@
 import lombok.Data;
 import lombok.Setter;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class KrakenCreatedVideo {
 

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenEmoticon.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenEmoticon.java
@@ -4,7 +4,12 @@
 import lombok.Data;
 import lombok.Setter;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class KrakenEmoticon {
     private Integer id;

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenEmoticonSetList.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenEmoticonSetList.java
@@ -7,7 +7,12 @@
 import java.util.Map;
 import java.util.Set;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class KrakenEmoticonSetList {
     private Map<String, Set<KrakenEmoticon>> emoticonSets;

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenFollow.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenFollow.java
@@ -7,7 +7,12 @@
 
 import java.time.Instant;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 public class KrakenFollow {
 

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenFollowList.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenFollowList.java
@@ -8,7 +8,12 @@
 
 import java.util.List;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @ToString(callSuper = true)
 @Setter(AccessLevel.PRIVATE)
 @EqualsAndHashCode(callSuper = true)

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenHost.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenHost.java
@@ -5,7 +5,12 @@
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 @NoArgsConstructor
 public class KrakenHost {

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenHostList.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenHostList.java
@@ -7,7 +7,12 @@
 
 import java.util.List;
 
+/**
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
+ */
 @Data
+@Deprecated
 @Setter(AccessLevel.PRIVATE)
 @NoArgsConstructor
 public class KrakenHostList {

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenIngest.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenIngest.java
@@ -9,8 +9,11 @@
  * The Twitch ingesting system is the first stop for a broadcast stream.
  * An ingest server receives your stream, and the ingesting system
  * authorizes and registers streams, then prepares them for viewers.
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
  */
 @Data
+@Deprecated
 public class KrakenIngest {
 
 	@JsonProperty("_id")

diff --git a/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenIngestList.java b/rest-kraken/src/main/java/com/github/twitch4j/kraken/domain/KrakenIngestList.java
@@ -6,8 +6,11 @@
 
 /**
  * Model representing a list of ingest servers.
+ * @deprecated Kraken is deprecated and has been shut down on <b>Febuary 28, 2022</b>.
+ *             More details about the deprecation are available <a href="https://blog.twitch.tv/en/2021/07/15/legacy-twitch-api-v5-shutdown-details-and-timeline">here</a>.
  */
 @Data
+@Deprecated
 public class KrakenIngestList {
     /**
      * Data