friendship-service/social.friendship.application/FriendshipServiceVerticle

FriendshipServiceVerticle

class FriendshipServiceVerticle(userRepository: UserRepository, friendshipRepository: FriendshipRepository, friendshipRequestRepository: FriendshipRequestRepository, messageRepository: MessageRepository, kafkaProducer: KafkaProducerVerticle, credentials: DatabaseCredentials? = null, shouldConnectToDB: Boolean? = true) : AbstractVerticle, FriendshipService

FriendshipServiceVerticle is the main entry point for the Friendship Service. It is responsible for handling all the business logic related to friendships, friendship requests, messages and users. It also deploys the KafkaFriendshipProducerVerticle to publish events to the Kafka broker.

Parameters

userRepository

The repository to interact with the User entity.

friendshipRepository

The repository to interact with the Friendship entity.

friendshipRequestRepository

The repository to interact with the FriendshipRequest entity.

messageRepository

The repository to interact with the Message entity.

credentials

The database credentials to connect to the MySQL database.

shouldConnectToDB

A flag to determine if the service should connect to the database, used for testing purposes.

Constructors

FriendshipServiceVerticle

constructor(userRepository: UserRepository, friendshipRepository: FriendshipRepository, friendshipRequestRepository: FriendshipRequestRepository, messageRepository: MessageRepository, kafkaProducer: KafkaProducerVerticle, credentials: DatabaseCredentials? = null, shouldConnectToDB: Boolean? = true)

Functions

acceptFriendshipRequest

open override fun acceptFriendshipRequest(request: FriendshipRequest)

Accepts a friendship request. Also publishes a FriendshipRequestAccepted event to the Kafka broker and the Vert.x event bus.

open override fun addFriendship(friendship: Friendship)

Stops the FriendshipServiceVerticle and closes the database connections.

addFriendshipRequest

open override fun addFriendshipRequest(friendshipRequest: FriendshipRequest)

Adds a friendship request.

open override fun addMessage(message: Message)

Adds a message to the repository.

open override fun addUser(user: User)

Adds a user to the repository.

open fun config(): JsonObject

connectToDatabase

fun connectToDatabase()

Connects to the MySQL database using the provided credentials or the default credentials given by the environment variables.

deleteFriendship

open override fun deleteFriendship(friendshipID: Friendship.FriendshipID): Friendship?

Deletes a friendship by its ID. Also publishes a FriendshipRemoved event to the Kafka broker and the Vert.x event bus.

open override fun deleteMessage(messageID: Message.MessageID): Message?

Deletes a message by its ID.

open fun deploymentID(): String

getAllFriendsByUserId

open override fun getAllFriendsByUserId(userID: User.UserID): Iterable<User>

Retrieves all friendships of a user.

getAllFriendshipRequests

open override fun getAllFriendshipRequests(): Array<FriendshipRequest>

Retrieves all friendship requests in the repository.

getAllFriendshipRequestsByUserId

open override fun getAllFriendshipRequestsByUserId(userID: User.UserID): Iterable<FriendshipRequest>

Retrieves all friendship requests of a user.

getAllFriendships

open override fun getAllFriendships(): Array<Friendship>

Retrieves all friendships.

open override fun getAllMessages(): Array<Message>

Retrieves all messages in the repository.

getAllMessagesExchangedBetween

open override fun getAllMessagesExchangedBetween(user1Id: User.UserID, user2Id: User.UserID): Iterable<Message>

Retrieves all messages exchanged between 2 users.

getAllMessagesReceivedByUserId

open override fun getAllMessagesReceivedByUserId(userID: User.UserID): Iterable<Message>

Retrieves all messages sent by a user.

open override fun getFriendship(friendshipID: Friendship.FriendshipID): Friendship?

Retrieves a friendship by its ID.

getFriendshipRequest

open override fun getFriendshipRequest(friendshipRequestID: FriendshipRequest.FriendshipRequestID): FriendshipRequest?

Retrieves a friendship request by its ID.

open override fun getMessage(messageID: Message.MessageID): Message?

Retrieves a message by its ID.

open override fun getUser(userID: User.UserID): User?

Retrieves a user by their ID.

open override fun getVertx(): Vertx

open override fun init(p0: Vertx, p1: Context)

open fun processArgs(): MutableList<String>

receivedMessage

open override fun receivedMessage(message: Message)

Handles a received message. Also publishes a MessageReceived event to the Kafka broker and the Vert.x event bus.

rejectFriendshipRequest

open override fun rejectFriendshipRequest(friendshipRequest: FriendshipRequest): FriendshipRequest?

Rejects a friendship request. Also publishes a FriendshipRequestRejected event to the Kafka broker and the Vert.x event bus.

open override fun sentMessage(message: Message)

Handles a sent message. Also publishes a MessageSent event to the Kafka broker and the Vert.x event bus.

open override fun start(p0: Promise<Void>)

open override fun start()

Deploys the KafkaFriendshipProducerVerticle to publish events to the Kafka broker.

open fun stop()

open override fun stop(p0: Promise<Void>)