Class EntityService


  • @Path("/")
    @Singleton
    @Consumes("application/octet-stream")
    @Produces("application/octet-stream")
    public final class EntityService
    extends jakarta.ws.rs.core.Application
    A service for dealing with entities
    • Constructor Summary

      Constructors 
      Constructor Description
      EntityService()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected RemoteEntityConnection authenticate​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)  
      jakarta.ws.rs.core.Response beginTransaction​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Begins a transaction
      jakarta.ws.rs.core.Response close​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Disconnects the underlying connection
      jakarta.ws.rs.core.Response commitTransaction​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Commits a transaction
      jakarta.ws.rs.core.Response count​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Returns the record count for the given condition
      jakarta.ws.rs.core.Response delete​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Deletes the entities for the given condition
      jakarta.ws.rs.core.Response deleteByKey​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Deletes the entities for the given keys
      jakarta.ws.rs.core.Response dependencies​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Returns the entities referencing the given entities via foreign keys, mapped to their respective entityTypes
      jakarta.ws.rs.core.Response function​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Executes a function with the given parameters
      jakarta.ws.rs.core.Response getEntities​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Returns the underlying domain entities
      jakarta.ws.rs.core.Response insert​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Inserts the given entities, returning their keys
      jakarta.ws.rs.core.Response isQueryCacheEnabled​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Checks if the query cache is enabled
      jakarta.ws.rs.core.Response isTransactionOpen​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Checks if a transaction is open
      jakarta.ws.rs.core.Response procedure​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Executes a procedure with the given parameters
      jakarta.ws.rs.core.Response readBlob​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Reads a BLOB value
      jakarta.ws.rs.core.Response report​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Fills the given report
      jakarta.ws.rs.core.Response rollbackTransaction​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Rolls back an open transaction
      jakarta.ws.rs.core.Response select​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Returns the entities for the given query condition
      jakarta.ws.rs.core.Response selectByKey​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Returns the entities for the given keys
      jakarta.ws.rs.core.Response setQueryCacheEnabled​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)  
      jakarta.ws.rs.core.Response update​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Updates the given entities
      jakarta.ws.rs.core.Response updateByCondition​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Performs an update according to the given condition
      jakarta.ws.rs.core.Response values​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Selects the values for the given attribute using the given query condition
      jakarta.ws.rs.core.Response writeBlob​(jakarta.servlet.http.HttpServletRequest request, jakarta.ws.rs.core.HttpHeaders headers)
      Writes a BLOB value
      • Methods inherited from class jakarta.ws.rs.core.Application

        getClasses, getProperties, getSingletons
    • Constructor Detail

      • EntityService

        public EntityService()
    • Method Detail

      • getEntities

        @POST
        @Path("getEntities")
        public jakarta.ws.rs.core.Response getEntities​(@Context
                                                       jakarta.servlet.http.HttpServletRequest request,
                                                       @Context
                                                       jakarta.ws.rs.core.HttpHeaders headers)
        Returns the underlying domain entities
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • close

        @POST
        @Path("close")
        public jakarta.ws.rs.core.Response close​(@Context
                                                 jakarta.servlet.http.HttpServletRequest request,
                                                 @Context
                                                 jakarta.ws.rs.core.HttpHeaders headers)
        Disconnects the underlying connection
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • isTransactionOpen

        @POST
        @Path("isTransactionOpen")
        public jakarta.ws.rs.core.Response isTransactionOpen​(@Context
                                                             jakarta.servlet.http.HttpServletRequest request,
                                                             @Context
                                                             jakarta.ws.rs.core.HttpHeaders headers)
        Checks if a transaction is open
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • beginTransaction

        @POST
        @Path("beginTransaction")
        public jakarta.ws.rs.core.Response beginTransaction​(@Context
                                                            jakarta.servlet.http.HttpServletRequest request,
                                                            @Context
                                                            jakarta.ws.rs.core.HttpHeaders headers)
        Begins a transaction
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • commitTransaction

        @POST
        @Path("commitTransaction")
        public jakarta.ws.rs.core.Response commitTransaction​(@Context
                                                             jakarta.servlet.http.HttpServletRequest request,
                                                             @Context
                                                             jakarta.ws.rs.core.HttpHeaders headers)
        Commits a transaction
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • rollbackTransaction

        @POST
        @Path("rollbackTransaction")
        public jakarta.ws.rs.core.Response rollbackTransaction​(@Context
                                                               jakarta.servlet.http.HttpServletRequest request,
                                                               @Context
                                                               jakarta.ws.rs.core.HttpHeaders headers)
        Rolls back an open transaction
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • setQueryCacheEnabled

        @POST
        @Path("setQueryCacheEnabled")
        public jakarta.ws.rs.core.Response setQueryCacheEnabled​(@Context
                                                                jakarta.servlet.http.HttpServletRequest request,
                                                                @Context
                                                                jakarta.ws.rs.core.HttpHeaders headers)
      • isQueryCacheEnabled

        @POST
        @Path("isQueryCacheEnabled")
        public jakarta.ws.rs.core.Response isQueryCacheEnabled​(@Context
                                                               jakarta.servlet.http.HttpServletRequest request,
                                                               @Context
                                                               jakarta.ws.rs.core.HttpHeaders headers)
        Checks if the query cache is enabled
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • procedure

        @POST
        @Path("procedure")
        public jakarta.ws.rs.core.Response procedure​(@Context
                                                     jakarta.servlet.http.HttpServletRequest request,
                                                     @Context
                                                     jakarta.ws.rs.core.HttpHeaders headers)
        Executes a procedure with the given parameters
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • function

        @POST
        @Path("function")
        public jakarta.ws.rs.core.Response function​(@Context
                                                    jakarta.servlet.http.HttpServletRequest request,
                                                    @Context
                                                    jakarta.ws.rs.core.HttpHeaders headers)
        Executes a function with the given parameters
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • report

        @POST
        @Path("report")
        public jakarta.ws.rs.core.Response report​(@Context
                                                  jakarta.servlet.http.HttpServletRequest request,
                                                  @Context
                                                  jakarta.ws.rs.core.HttpHeaders headers)
        Fills the given report
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • dependencies

        @POST
        @Path("dependencies")
        public jakarta.ws.rs.core.Response dependencies​(@Context
                                                        jakarta.servlet.http.HttpServletRequest request,
                                                        @Context
                                                        jakarta.ws.rs.core.HttpHeaders headers)
        Returns the entities referencing the given entities via foreign keys, mapped to their respective entityTypes
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • count

        @POST
        @Path("count")
        public jakarta.ws.rs.core.Response count​(@Context
                                                 jakarta.servlet.http.HttpServletRequest request,
                                                 @Context
                                                 jakarta.ws.rs.core.HttpHeaders headers)
        Returns the record count for the given condition
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • values

        @POST
        @Path("values")
        public jakarta.ws.rs.core.Response values​(@Context
                                                  jakarta.servlet.http.HttpServletRequest request,
                                                  @Context
                                                  jakarta.ws.rs.core.HttpHeaders headers)
        Selects the values for the given attribute using the given query condition
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • selectByKey

        @POST
        @Path("selectByKey")
        public jakarta.ws.rs.core.Response selectByKey​(@Context
                                                       jakarta.servlet.http.HttpServletRequest request,
                                                       @Context
                                                       jakarta.ws.rs.core.HttpHeaders headers)
        Returns the entities for the given keys
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • select

        @POST
        @Path("select")
        public jakarta.ws.rs.core.Response select​(@Context
                                                  jakarta.servlet.http.HttpServletRequest request,
                                                  @Context
                                                  jakarta.ws.rs.core.HttpHeaders headers)
        Returns the entities for the given query condition
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • insert

        @POST
        @Path("insert")
        public jakarta.ws.rs.core.Response insert​(@Context
                                                  jakarta.servlet.http.HttpServletRequest request,
                                                  @Context
                                                  jakarta.ws.rs.core.HttpHeaders headers)
        Inserts the given entities, returning their keys
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • update

        @POST
        @Path("update")
        public jakarta.ws.rs.core.Response update​(@Context
                                                  jakarta.servlet.http.HttpServletRequest request,
                                                  @Context
                                                  jakarta.ws.rs.core.HttpHeaders headers)
        Updates the given entities
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • updateByCondition

        @POST
        @Path("updateByCondition")
        public jakarta.ws.rs.core.Response updateByCondition​(@Context
                                                             jakarta.servlet.http.HttpServletRequest request,
                                                             @Context
                                                             jakarta.ws.rs.core.HttpHeaders headers)
        Performs an update according to the given condition
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • delete

        @POST
        @Path("delete")
        public jakarta.ws.rs.core.Response delete​(@Context
                                                  jakarta.servlet.http.HttpServletRequest request,
                                                  @Context
                                                  jakarta.ws.rs.core.HttpHeaders headers)
        Deletes the entities for the given condition
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • deleteByKey

        @POST
        @Path("deleteByKey")
        public jakarta.ws.rs.core.Response deleteByKey​(@Context
                                                       jakarta.servlet.http.HttpServletRequest request,
                                                       @Context
                                                       jakarta.ws.rs.core.HttpHeaders headers)
        Deletes the entities for the given keys
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • writeBlob

        @POST
        @Path("writeBlob")
        public jakarta.ws.rs.core.Response writeBlob​(@Context
                                                     jakarta.servlet.http.HttpServletRequest request,
                                                     @Context
                                                     jakarta.ws.rs.core.HttpHeaders headers)
        Writes a BLOB value
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response
      • readBlob

        @POST
        @Path("readBlob")
        public jakarta.ws.rs.core.Response readBlob​(@Context
                                                    jakarta.servlet.http.HttpServletRequest request,
                                                    @Context
                                                    jakarta.ws.rs.core.HttpHeaders headers)
        Reads a BLOB value
        Parameters:
        request - the servlet request
        headers - the headers
        Returns:
        a response