documentation / annotation

src/main/java/app/annotations/enums/AuthMethod.java

@@ -1,5 +1,8 @@
 package app.annotations.enums;
 
+/**
+разграничение доступа к ендпоинту
+ */
 public enum AuthMethod {
     STEAM64,
     SECRET_KEY,

src/main/java/app/annotations/enums/CollectStages.java

@@ -1,5 +1,8 @@
 package app.annotations.enums;
 
+/**
+когда осуществлять сборку информации о выполнении у ендпоинта
+ */
 public enum CollectStages {
     COMBINED, BEFORE, AFTER;
 

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 {
 }

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 {
 }

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 {
 }

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 {
 }

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 {
 }

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 {
 }

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 {

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 {

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 {

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 {

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 {

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 {

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 {

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 {

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 {

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 {

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 {

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 {