diff --git a/src/main/java/app/annotations/enums/AuthMethod.java b/src/main/java/app/annotations/enums/AuthMethod.java index e579d90..8567603 100644 --- a/src/main/java/app/annotations/enums/AuthMethod.java +++ b/src/main/java/app/annotations/enums/AuthMethod.java @@ -1,5 +1,8 @@ package app.annotations.enums; +/** +разграничение доступа к ендпоинту + */ public enum AuthMethod { STEAM64, SECRET_KEY, diff --git a/src/main/java/app/annotations/enums/CollectStages.java b/src/main/java/app/annotations/enums/CollectStages.java index e2575bb..967404b 100644 --- a/src/main/java/app/annotations/enums/CollectStages.java +++ b/src/main/java/app/annotations/enums/CollectStages.java @@ -1,5 +1,8 @@ package app.annotations.enums; +/** +когда осуществлять сборку информации о выполнении у ендпоинта + */ public enum CollectStages { COMBINED, BEFORE, AFTER; diff --git a/src/main/java/app/annotations/exceptions/FailedAuthCheck.java b/src/main/java/app/annotations/exceptions/FailedAuthCheck.java index c884846..48df8ee 100644 --- a/src/main/java/app/annotations/exceptions/FailedAuthCheck.java +++ b/src/main/java/app/annotations/exceptions/FailedAuthCheck.java @@ -2,5 +2,8 @@ package app.annotations.exceptions; import app.exceptions.BaseWebException; +/** + * исключение если челик не прошел авторизацию + */ public class FailedAuthCheck extends BaseWebException { } diff --git a/src/main/java/app/annotations/exceptions/InvalidCookie.java b/src/main/java/app/annotations/exceptions/InvalidCookie.java index 2f03b91..2fbcb27 100644 --- a/src/main/java/app/annotations/exceptions/InvalidCookie.java +++ b/src/main/java/app/annotations/exceptions/InvalidCookie.java @@ -2,5 +2,8 @@ package app.annotations.exceptions; import app.exceptions.BaseWebException; +/** + * исключение если куки у пользователя невалидны или он их криво подменил (лох) + */ public class InvalidCookie extends BaseWebException { } diff --git a/src/main/java/app/annotations/exceptions/InvalidSecretKey.java b/src/main/java/app/annotations/exceptions/InvalidSecretKey.java index 255f3e8..3ee25ae 100644 --- a/src/main/java/app/annotations/exceptions/InvalidSecretKey.java +++ b/src/main/java/app/annotations/exceptions/InvalidSecretKey.java @@ -2,5 +2,8 @@ package app.annotations.exceptions; import app.exceptions.BaseWebException; +/** + * исключение если ключ сервиса невалидный или кто-то пытается его подменить (виталик лох) + */ public class InvalidSecretKey extends BaseWebException { } diff --git a/src/main/java/app/annotations/exceptions/LowPermition.java b/src/main/java/app/annotations/exceptions/LowPermition.java index 5a76ef6..82c736a 100644 --- a/src/main/java/app/annotations/exceptions/LowPermition.java +++ b/src/main/java/app/annotations/exceptions/LowPermition.java @@ -2,5 +2,8 @@ package app.annotations.exceptions; import app.exceptions.BaseWebException; +/** + * исключение если у пользователя недостаточно прав ддля выполнение команды + */ public class LowPermition extends BaseWebException { } diff --git a/src/main/java/app/annotations/exceptions/NeedCookie.java b/src/main/java/app/annotations/exceptions/NeedCookie.java index 991a54e..f8387ff 100644 --- a/src/main/java/app/annotations/exceptions/NeedCookie.java +++ b/src/main/java/app/annotations/exceptions/NeedCookie.java @@ -2,5 +2,8 @@ package app.annotations.exceptions; import app.exceptions.BaseWebException; +/** + * исключение не найдены куки + */ public class NeedCookie extends BaseWebException { } diff --git a/src/main/java/app/annotations/exceptions/WaitRateLimit.java b/src/main/java/app/annotations/exceptions/WaitRateLimit.java index 434ff3b..a6a861c 100644 --- a/src/main/java/app/annotations/exceptions/WaitRateLimit.java +++ b/src/main/java/app/annotations/exceptions/WaitRateLimit.java @@ -2,5 +2,8 @@ package app.annotations.exceptions; import app.exceptions.BaseWebException; +/** + * исключение если ебанько пытается выполнить запрос который уже ранее отправлял + */ public class WaitRateLimit extends BaseWebException { } diff --git a/src/main/java/app/annotations/impl/CollectStatisticAspect.java b/src/main/java/app/annotations/impl/CollectStatisticAspect.java index 345299c..7baaeb2 100644 --- a/src/main/java/app/annotations/impl/CollectStatisticAspect.java +++ b/src/main/java/app/annotations/impl/CollectStatisticAspect.java @@ -19,7 +19,9 @@ import org.springframework.context.annotation.Configuration; import java.sql.Timestamp; import java.time.Instant; - +/** + * АОП для обработки статистики использование бекенда через api + */ @Aspect @Configuration public class CollectStatisticAspect { diff --git a/src/main/java/app/annotations/impl/PermitionFlagAspect.java b/src/main/java/app/annotations/impl/PermitionFlagAspect.java index 0bbc976..73aef05 100644 --- a/src/main/java/app/annotations/impl/PermitionFlagAspect.java +++ b/src/main/java/app/annotations/impl/PermitionFlagAspect.java @@ -19,6 +19,9 @@ import org.springframework.context.annotation.Configuration; import java.util.Arrays; import java.util.List; +/** + * АОП для обработки прав у пользователя + */ @Aspect @Configuration public class PermitionFlagAspect { diff --git a/src/main/java/app/annotations/impl/ShowClientIPAspect.java b/src/main/java/app/annotations/impl/ShowClientIPAspect.java index 72ac4b9..84bcea9 100644 --- a/src/main/java/app/annotations/impl/ShowClientIPAspect.java +++ b/src/main/java/app/annotations/impl/ShowClientIPAspect.java @@ -7,6 +7,9 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.context.annotation.Configuration; +/** + * бывают такие моменты когда охото посомтреть ИП адресс + */ @Aspect @Configuration public class ShowClientIPAspect { diff --git a/src/main/java/app/annotations/impl/UpdatePlayersAspect.java b/src/main/java/app/annotations/impl/UpdatePlayersAspect.java index f6dc6fa..2454c39 100644 --- a/src/main/java/app/annotations/impl/UpdatePlayersAspect.java +++ b/src/main/java/app/annotations/impl/UpdatePlayersAspect.java @@ -8,6 +8,9 @@ import org.springframework.context.annotation.Configuration; import java.time.Instant; +/** + * легаси говно, АОП для обновление данных о серверах перед выполнением метода + */ @Aspect @Configuration public class UpdatePlayersAspect { diff --git a/src/main/java/app/annotations/impl/WaitAfterNextAspect.java b/src/main/java/app/annotations/impl/WaitAfterNextAspect.java index ca58cda..4ba5644 100644 --- a/src/main/java/app/annotations/impl/WaitAfterNextAspect.java +++ b/src/main/java/app/annotations/impl/WaitAfterNextAspect.java @@ -13,6 +13,9 @@ import org.springframework.context.annotation.Configuration; import java.util.HashSet; +/** + * АОП для обработки рейт лимитов + */ @Aspect @Configuration public class WaitAfterNextAspect { diff --git a/src/main/java/app/annotations/impl/WebAccessAspect.java b/src/main/java/app/annotations/impl/WebAccessAspect.java index 0d252b6..37d61ec 100644 --- a/src/main/java/app/annotations/impl/WebAccessAspect.java +++ b/src/main/java/app/annotations/impl/WebAccessAspect.java @@ -23,6 +23,9 @@ import org.springframework.web.socket.WebSocketSession; import java.io.IOException; import java.util.List; +/** + * АОП для обработки уровня доступа к ендпоинтам + */ @Aspect @Configuration public class WebAccessAspect { diff --git a/src/main/java/app/annotations/interfaces/BurstUpdatePlayers.java b/src/main/java/app/annotations/interfaces/BurstUpdatePlayers.java index ddd8cc3..9ad3db1 100644 --- a/src/main/java/app/annotations/interfaces/BurstUpdatePlayers.java +++ b/src/main/java/app/annotations/interfaces/BurstUpdatePlayers.java @@ -5,6 +5,9 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + * легаси говно / аннотация для обновление информации о серверах + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface BurstUpdatePlayers { diff --git a/src/main/java/app/annotations/interfaces/CheckPermitionFlag.java b/src/main/java/app/annotations/interfaces/CheckPermitionFlag.java index 5d3a38a..29993b1 100644 --- a/src/main/java/app/annotations/interfaces/CheckPermitionFlag.java +++ b/src/main/java/app/annotations/interfaces/CheckPermitionFlag.java @@ -6,6 +6,10 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; + +/** + * аннотация для обработки прав у пользователя на основе SourceMod + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface CheckPermitionFlag { diff --git a/src/main/java/app/annotations/interfaces/CheckWebAccess.java b/src/main/java/app/annotations/interfaces/CheckWebAccess.java index f6729eb..301a188 100644 --- a/src/main/java/app/annotations/interfaces/CheckWebAccess.java +++ b/src/main/java/app/annotations/interfaces/CheckWebAccess.java @@ -7,6 +7,9 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + * аннотация для проверки доступа у ендпоинта + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface CheckWebAccess { diff --git a/src/main/java/app/annotations/interfaces/CollectStatistic.java b/src/main/java/app/annotations/interfaces/CollectStatistic.java index 69ac7dd..e8bc1c5 100644 --- a/src/main/java/app/annotations/interfaces/CollectStatistic.java +++ b/src/main/java/app/annotations/interfaces/CollectStatistic.java @@ -7,6 +7,10 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; + +/** + * аннотация для сбора статистики у ендпоинта + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface CollectStatistic { diff --git a/src/main/java/app/annotations/interfaces/ShowClientIP.java b/src/main/java/app/annotations/interfaces/ShowClientIP.java index 41e6afe..8e8f642 100644 --- a/src/main/java/app/annotations/interfaces/ShowClientIP.java +++ b/src/main/java/app/annotations/interfaces/ShowClientIP.java @@ -5,6 +5,9 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + * аннотация чтоб посмотреть ип пользователя который лезет в ендпоинт + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface ShowClientIP { diff --git a/src/main/java/app/annotations/interfaces/WaitAfterNext.java b/src/main/java/app/annotations/interfaces/WaitAfterNext.java index f6c1e49..bcf29ff 100644 --- a/src/main/java/app/annotations/interfaces/WaitAfterNext.java +++ b/src/main/java/app/annotations/interfaces/WaitAfterNext.java @@ -5,6 +5,9 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + * аннотация для рейтлимитов + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface WaitAfterNext {