How lucaseduardo76/sip works
SIP is a Spring API for managing found items, their return/recovery requests, user accounts and notifications. The central workflow is that a user submits an item, another user requests its recovery, and an administrator reviews the request; the service validates availability and records the result. Supporting capabilities include agenda-based pickup availability, image storage, authentication, email and real-time notifications. The README documents how to start the application, not its product behavior; relationships below are limited to sampled calls and SOURCE INDEX references.
Main entry points: ItemApplicationService.java Item workflow · NotificationToItemService.java Item notifications · AuthenticationApplicationService.java Authentication · KafkaApplicationEmailProducer.java Email producer
Components 21
Identity and access
- Users
src/main/java/com/ifba/sipapi/user/domain/User.java - Authentication
src/main/java/com/ifba/sipapi/user/api/authentication/service/AuthenticationApplicationService.java - JWT tokens
src/main/java/com/ifba/sipapi/config/security/TokenService.java
Items and recovery
- Item workflow
src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java - Items
src/main/java/com/ifba/sipapi/item/domain/item/Item.java - Recovery requests
src/main/java/com/ifba/sipapi/item/domain/recoveryRequest/Recovery.java
Pickup availability
- Agenda service
src/main/java/com/ifba/sipapi/agenda/api/service/AgendaApplicationService.java - Available times
src/main/java/com/ifba/sipapi/agenda/domain/AvailableDay.java
Notifications and email
- Item notifications
src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java - Notifications
src/main/java/com/ifba/sipapi/notification/domain/Notification.java - Notification service
src/main/java/com/ifba/sipapi/notification/api/service/NotificationApplicationService.java - Notification consumer
src/main/java/com/ifba/sipapi/notification/application/NotificationConsumer.java - Email producer
src/main/java/com/ifba/sipapi/mail/infra/KafkaApplicationEmailProducer.java
Persistence and media
- User store
src/main/java/com/ifba/sipapi/user/infra/UserRepository.java - Item store
src/main/java/com/ifba/sipapi/item/infra/item/ItemRepository.java - Recovery store
src/main/java/com/ifba/sipapi/item/infra/recovery/RecoveryRepository.java - Agenda store
src/main/java/com/ifba/sipapi/agenda/repository/AvailableDayRepository.java - Image storage
src/main/java/com/ifba/sipapi/minio/infra/MinioStorageClient.java - Notification store
src/main/java/com/ifba/sipapi/notification/infra/NotificationRepository.java
Other components
- User
- Kafka
Connections 16
- User → Authentication: authenticates
- Authentication → User store: saves users
src/main/java/com/ifba/sipapi/user/api/authentication/service/AuthenticationApplicationService.java - Authentication → JWT tokens: generates tokens
src/main/java/com/ifba/sipapi/user/api/authentication/service/AuthenticationApplicationService.java - Authentication → Email producer: publishes email
src/main/java/com/ifba/sipapi/user/api/authentication/service/AuthenticationApplicationService.java - Item workflow → Item store: persists items
src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java - Item workflow → Recovery store: queries requests
src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java - Item workflow → Image storage: uploads images
src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java - Item workflow → Agenda store: checks availability
src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java - Item workflow → Item notifications: emits events
src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java - Agenda service → Agenda store: loads availability
src/main/java/com/ifba/sipapi/agenda/api/service/AgendaApplicationService.java - Item notifications → Notification store: saves notifications
src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java - Item notifications → Notification consumer: dispatches messages
src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java - Item notifications → Item store: loads item
src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java - Item notifications → User store: finds admins
src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java - Notification service → Notification store: reads notifications
src/main/java/com/ifba/sipapi/notification/api/service/NotificationApplicationService.java - Email producer → Kafka: publishes