UserViewController.java 5.1 KB
package net.ziemers.swxercise.ui;

import java.util.Collection;

import javax.enterprise.context.ApplicationScoped;
import javax.inject.Inject;
import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;

import net.ziemers.swxercise.lg.model.user.SessionContext;
import net.ziemers.swxercise.lg.model.user.User;
import net.ziemers.swxercise.lg.user.dto.UserDto;
import net.ziemers.swxercise.lg.user.service.UserService;
import net.ziemers.swxercise.ui.enums.ResponseState;

/**
 * REST-Methoden für die Benutzerverwaltung.
 */
@ApplicationScoped
@Path(UserViewController.webContextPath)
public class UserViewController {

    static final String webContextPath = "/users";

    @Inject
    private UserService userService;

    /**
     * Liefert alle User-Objekte zurück.
     *
     * Aufruf:
     * GET http://localhost:8080/swxercise/rest/users
     *
     * @return die User-Objekte.
     */
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    public Collection<User> getAllUsers() {
        return userService.findAllUsers();
    }

    /**
     * Liefert das User-Objekt mit der gewünschten Id zurück.
     *
     * Aufruf:
     * GET http://localhost:8080/swxercise/rest/users/42
     *
     * @param id die Id des gewünschten User-Objekts
     * @return das User-Objekt.
     */
    @GET
    @Path("{id}")
    @Produces(MediaType.APPLICATION_JSON)
    public User getById(@PathParam("id") Long id) {
        return userService.findUser(id);
    }

    /**
     * Erstellt ein neues User-Objekt mit den gewünschten Eigenschaften, welche mittels {@link UserDto} definiert werden.
     *
     * Aufruf:
     * POST http://localhost:8080/swxercise/rest/users
     *
     * @param dto das mittels der als JSON-Objekt übergebenenen Eigenschaften zu füllende {@link UserDto}
     * @return "Ok", wenn die Erstellung des User-Objekts erfolgreich war.
     * @throws Exception wirft eine Exception, wenn das Erstellen des UserDto fehlschlug
     */
    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public RestResponse createUser(UserDto dto) throws Exception {
        userService.createUser(dto);
        return new RestResponse();
    }

    /**
     * Aktualisiert das User-Objekt mit der gewünschten Id mit den Eigenschaften, welche mittels {@link UserDto} definiert werden.
     *
     * Aufruf:
     * PUT http://localhost:8080/swxercise/rest/users/42
     *
     * @param id die Id des gewünschten User-Objekts
     * @return "Ok", wenn die Erstellung des User-Objekts erfolgreich war.
     * @throws Exception wirft eine Exception, wenn das Erstellen des UserDto fehlschlug
     */
    @PUT
    @Path("{id}")
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public RestResponse updateUser(@PathParam("id") Long id) throws Exception {
        // TODO noch zu implementieren
        return new RestResponse(ResponseState.FAILED);
    }

    /**
     * Löscht das User-Objekt mit der gewünschten Id.
     *
     * Aufruf:
     * DELETE http://localhost:8080/swxercise/rest/users/42
     *
     * @param id die Id des gewünschten User-Objekts
     * @return "Ok", wenn die Erstellung des User-Objekts erfolgreich war.
     */
    @DELETE
    @Path("{id}")
    @Produces(MediaType.APPLICATION_JSON)
    public RestResponse deleteUser(@PathParam("id") Long id) {
        userService.deleteUser(id);
        return new RestResponse();
    }

    /**
     * Löscht das User-Objekt des zurzeit angemeldeten Benutzers.
     *
     * Aufruf:
     * DELETE http://localhost:8080/swxercise/rest/users
     *
     * @return "Ok", wenn das Löschen des User-Objekts erfolgreich war.
     */
    @DELETE
    @Produces(MediaType.APPLICATION_JSON)
    public RestResponse deleteUser() {
        if (userService.deleteUser()) {
            return new RestResponse();
        }
        return new RestResponse(ResponseState.FAILED);
    }

    /**
     * Meldet einen Benutzer durch übergebenen username und password mit einem neuen User-{@link SessionContext} an.
     *
     * Aufruf:
     * POST http://localhost:8080/swxercise/rest/users/login
     *
     * @param dto das mittels der als JSON-Objekt übergebenenen Eigenschaften zu füllende {@link UserDto}
     * @return "Ok", wenn die Erstellung des User-Objekts erfolgreich war.
     */
    @POST
    @Path("/login")
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public RestResponse loginUser(UserDto dto) {
        if (userService.loginUser(dto)) {
            return new RestResponse();
        }
        return new RestResponse(ResponseState.FAILED);
    }

    /**
     * Meldet den angemeldeten Benutzer von seinem User-{@link SessionContext} ab.
     *
     * Aufruf:
     * POST http://localhost:8080/swxercise/rest/users/logout
     *
     * @return "Ok", wenn die Erstellung des User-Objekts erfolgreich war.
     */
    @POST
    @Path("/logout")
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public RestResponse logoutUser() {
        if (userService.logoutUser()) {
            return new RestResponse();
        }
        return new RestResponse(ResponseState.FAILED);
    }

}