diff --git a/src/main/java/com/release11/klaus/controller/MvcExceptionHandler.java b/src/main/java/com/release11/klaus/controller/MvcExceptionHandler.java index 7011ffd..d995ac7 100644 --- a/src/main/java/com/release11/klaus/controller/MvcExceptionHandler.java +++ b/src/main/java/com/release11/klaus/controller/MvcExceptionHandler.java @@ -10,6 +10,7 @@ import javax.validation.ConstraintViolationException; import java.util.ArrayList; import java.util.List; +//TODO: Find usage and document or remove it @ControllerAdvice public class MvcExceptionHandler { diff --git a/src/main/java/com/release11/klaus/mappers/MockedMessageMapper.java b/src/main/java/com/release11/klaus/mappers/MockedMessageMapper.java index 7fd42d3..de4613c 100644 --- a/src/main/java/com/release11/klaus/mappers/MockedMessageMapper.java +++ b/src/main/java/com/release11/klaus/mappers/MockedMessageMapper.java @@ -4,6 +4,10 @@ import com.release11.klaus.model.MockedMessage; import com.release11.klaus.model.MockedMessageDto; import org.mapstruct.*; +/** + * Creates key value for redis entry + * @author Rafał Źukowicz + */ @Mapper public interface MockedMessageMapper { @Mapping( target = "compositePrimaryKey", expression = "java(mockedMessageDto.getClientUUID() + \"_\"" + diff --git a/src/main/java/com/release11/klaus/model/Event.java b/src/main/java/com/release11/klaus/model/Event.java index 6c820f4..b4092d9 100644 --- a/src/main/java/com/release11/klaus/model/Event.java +++ b/src/main/java/com/release11/klaus/model/Event.java @@ -6,6 +6,10 @@ import org.springframework.lang.Nullable; import java.time.LocalDateTime; +/** + * Pojo class for Event entity + * @author Rafał Żukowicz + */ @Data @Builder @ToString diff --git a/src/main/java/com/release11/klaus/model/EventRequestDto.java b/src/main/java/com/release11/klaus/model/EventRequestDto.java index 6150007..df2403d 100644 --- a/src/main/java/com/release11/klaus/model/EventRequestDto.java +++ b/src/main/java/com/release11/klaus/model/EventRequestDto.java @@ -10,7 +10,8 @@ import java.time.LocalDateTime; import java.util.UUID; /** - * Pojo for client request + * Pojo for history query request. Contains information necessary to obtain {@link Event} list + * @author Rafał Żukowicz */ @Data @Builder diff --git a/src/main/java/com/release11/klaus/model/MockedMessage.java b/src/main/java/com/release11/klaus/model/MockedMessage.java index 3446bd4..76e451a 100644 --- a/src/main/java/com/release11/klaus/model/MockedMessage.java +++ b/src/main/java/com/release11/klaus/model/MockedMessage.java @@ -14,6 +14,10 @@ import java.io.Serializable; import java.util.Map; import java.util.UUID; +/** + * MockedMessage redis entity pojo + * @author Rafał Żukowicz + */ @Data @ToString @RedisHash("mockedMessage") diff --git a/src/main/java/com/release11/klaus/model/MockedMessageDto.java b/src/main/java/com/release11/klaus/model/MockedMessageDto.java index b37bcca..7c462ff 100644 --- a/src/main/java/com/release11/klaus/model/MockedMessageDto.java +++ b/src/main/java/com/release11/klaus/model/MockedMessageDto.java @@ -10,9 +10,9 @@ import java.util.Map; import java.util.UUID; /** - * it appears that instance of this class contains info about mocked response - * To which UUID it is bound, whats its id, the list of headers, type of content and message body, - * as well as status it has to return. + * Alternative version of {@link MockedMessage} used in http body + * @author Rafał Żukowicz + * @author Gabriel Modzelewski */ @Data @Builder @@ -30,6 +30,7 @@ public class MockedMessageDto implements Serializable, Comparable { private Set allowedValues; diff --git a/src/main/java/com/release11/klaus/repository/EventRepository.java b/src/main/java/com/release11/klaus/repository/EventRepository.java index c7c1d12..f2555d0 100644 --- a/src/main/java/com/release11/klaus/repository/EventRepository.java +++ b/src/main/java/com/release11/klaus/repository/EventRepository.java @@ -9,6 +9,10 @@ import java.time.LocalDateTime; import java.util.List; import java.util.Map; +/** + * Event entity dao interface + * @author Rafał Żukowicz + */ @Repository @Transactional public interface EventRepository { diff --git a/src/main/java/com/release11/klaus/repository/EventRepositoryImpl.java b/src/main/java/com/release11/klaus/repository/EventRepositoryImpl.java index 33bc252..906aa4e 100644 --- a/src/main/java/com/release11/klaus/repository/EventRepositoryImpl.java +++ b/src/main/java/com/release11/klaus/repository/EventRepositoryImpl.java @@ -20,6 +20,7 @@ import java.util.List; import java.util.Map; import java.util.stream.Collectors; +//TODO: Add javadoc @Repository @AllArgsConstructor public class EventRepositoryImpl implements EventRepository { diff --git a/src/main/java/com/release11/klaus/repository/MockedResponseRepository.java b/src/main/java/com/release11/klaus/repository/MockedResponseRepository.java index 2858f3a..570c120 100644 --- a/src/main/java/com/release11/klaus/repository/MockedResponseRepository.java +++ b/src/main/java/com/release11/klaus/repository/MockedResponseRepository.java @@ -8,9 +8,19 @@ import org.springframework.transaction.annotation.Transactional; import java.util.List; import java.util.UUID; +/** + * Spring repository that allows to retrieve message list by key-uuid from redis database + * @author Rafał Żukowicz + */ @Repository @Transactional public interface MockedResponseRepository extends CrudRepository { + /** + * Finds all messages by their uuid + * @param clientUUID the key-uuid of given set of messages + * @return list of {@link com.release11.klaus.model.MockedMessage} + */ List findAllByClientUUID(UUID clientUUID); +// TODO: Remove if no use MockedMessage getByCompositePrimaryKey(String compositePrimaryKey); }