Package com.tt1.simserver.presentation

Interface RequestApi

All Known Implementing Classes:
RequestController
public interface RequestApi
Interfaz que define los endpoints de la API necesarios para crear nuevas peticiones de simulación y consultar el estado o el conjunto de solicitudes de un usuario.

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    solicitudComprobarSolicitudGet(String username, Integer token)
    Endpoint GET: Comprueba el estado actual de una solicitud de simulación existente.
    jakarta.ws.rs.core.Response
    solicitudGetSolicitudesUsuarioGet(String username)
    Endpoint POST: Recupera todas las solicitudes de simulación asociadas a un usuario en el sistema.
    jakarta.ws.rs.core.Response
    solicitudSolicitarPost(String username, Request request)
    Endpoint POST: Crea y registra una nueva solicitud de simulación para el usuario rellenando un nuevo tablero.

  • Method Details

    • solicitudComprobarSolicitudGet

      @GET @Path("/ComprobarSolicitud") @Produces({"text/plain","application/json","text/json"}) jakarta.ws.rs.core.Response solicitudComprobarSolicitudGet(@QueryParam("nombreUsuario") String username, @QueryParam("tok") Integer token)
      Endpoint GET: Comprueba el estado actual de una solicitud de simulación existente.

      Precondición: username no es nulo y token contiene un identificador válido.

      Postcondición: Lanza siempre una excepción de operación no soportada, ya que la funcionalidad no ha sido implementada todavía.

      Parameters:
      username - el nombre de la cuenta del usuario.
      token - el identificador numérico de la simulación.
      Returns:
      la respuesta HTTP con el estado de la simulación.
      Throws:
      UnsupportedOperationException - siempre, porque el método aún no está programado.

    • solicitudGetSolicitudesUsuarioGet

      @GET @Path("/GetSolicitudesUsuario") jakarta.ws.rs.core.Response solicitudGetSolicitudesUsuarioGet(@QueryParam("nombreUsuario") String username)
      Endpoint POST: Recupera todas las solicitudes de simulación asociadas a un usuario en el sistema.

      Precondición: username no es nulo.

      Postcondición: Lanza siempre una excepción de operación no soportada, ya que la funcionalidad no ha sido implementada todavía.

      Parameters:
      username - el nombre de cuenta del usuario a consultar.
      Returns:
      la respuesta HTTP con la lista de identificadores.
      Throws:
      UnsupportedOperationException - siempre, porque el método aún no está programado.

    • solicitudSolicitarPost

      @POST @Path("/Solicitar") @Consumes({"application/json","text/json","application/*+json"}) @Produces({"text/plain","application/json","text/json"}) jakarta.ws.rs.core.Response solicitudSolicitarPost(@QueryParam("nombreUsuario") String username, Request request)
      Endpoint POST: Crea y registra una nueva solicitud de simulación para el usuario rellenando un nuevo tablero.

      Precondición: username no es nulo y request contiene los datos iniciales válidos de las criaturas.

      Postcondición: Lanza siempre una excepción de operación no soportada, ya que la funcionalidad no ha sido implementada todavía.

      Parameters:
      username - el identificador del usuario que hace la solicitud.
      request - el objeto con la especificación y cantidades de criaturas a incluir en el tablero.
      Returns:
      la respuesta HTTP informando del token asignado a la simulación.
      Throws:
      UnsupportedOperationException - siempre, porque el método aún no está programado.