diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersHandler.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersHandler.java index 69a986e..2ad7fe2 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersHandler.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersHandler.java @@ -6,14 +6,32 @@ import ch.unibas.dmi.dbis.cs108.casono.server.network.command.execution.CommandH import ch.unibas.dmi.dbis.cs108.casono.server.network.protocol.response.dispatcher.ResponseDispatcher; import java.util.Collection; +/** + * Handles {@link ListUsersRequest}s by retrieving all users from the {@link UserRegistry} and + * dispatching a {@link ListUsersResponse} containing the list of users. + */ public class ListUsersHandler extends CommandHandler { private final UserRegistry userRegistry; + /** + * Creates a new handler for listing all users + * + * @param responseDispatcher the dispatcher used to send the response + * @param userRegistry the registry used to look up existing users + */ public ListUsersHandler(ResponseDispatcher responseDispatcher, UserRegistry userRegistry) { super(responseDispatcher); this.userRegistry = userRegistry; } + /** + * Executes the list users request + * + *

All users are retrieved from the {@link UserRegistry} and returned in a {@link + * ListUsersResponse}. + * + * @param request the request to execute + */ @Override public void execute(ListUsersRequest request) { Collection users = userRegistry.getAllUsers(); diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersParser.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersParser.java index 9cb9bb8..f55149e 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersParser.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersParser.java @@ -3,7 +3,14 @@ package ch.unibas.dmi.dbis.cs108.casono.server.app.commands.list_users; import ch.unibas.dmi.dbis.cs108.casono.server.network.command.parsing.CommandParser; import ch.unibas.dmi.dbis.cs108.casono.server.network.protocol.request.PrimitiveRequest; +/** Parses a primitive request into a {@link ListUsersRequest}. */ public class ListUsersParser implements CommandParser { + /** + * Parses a primitive request into a ListUsersRequest. + * + * @param primitiveRequest the request to parse + * @return the created {@link ListUsersRequest} + */ @Override public ListUsersRequest parse(PrimitiveRequest primitiveRequest) { return new ListUsersRequest(primitiveRequest.context()); diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersRequest.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersRequest.java index 9eedbb9..9ed8fdd 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersRequest.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersRequest.java @@ -3,7 +3,14 @@ package ch.unibas.dmi.dbis.cs108.casono.server.app.commands.list_users; import ch.unibas.dmi.dbis.cs108.casono.server.network.protocol.request.Request; import ch.unibas.dmi.dbis.cs108.casono.server.network.protocol.request.RequestContext; +/** Request implementation used to retrieve all existing users from the server. */ public class ListUsersRequest extends Request { + /** + * Constructs a new ListUsersRequest with the given context + * + * @param context the {@link RequestContext} containing information for responding to the + * request + */ public ListUsersRequest(RequestContext context) { super(context); } diff --git a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersResponse.java b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersResponse.java index bedeb5a..4e48aaf 100644 --- a/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersResponse.java +++ b/src/main/java/ch/unibas/dmi/dbis/cs108/casono/server/app/commands/list_users/ListUsersResponse.java @@ -6,7 +6,14 @@ import ch.unibas.dmi.dbis.cs108.casono.server.network.protocol.response.SuccessR import ch.unibas.dmi.dbis.cs108.casono.server.network.protocol.response.builder.ResponseBody; import java.util.Collection; +/** Response containing a list of all active users on the server */ public class ListUsersResponse extends SuccessResponse { + /** + * Creates a new ListUsersResponse containing the given list of users + * + * @param context the {@link RequestContext} associated with the request + * @param users the collection of users currently active on the server + */ public ListUsersResponse(RequestContext context, Collection users) { super( context,