Package org.autumnframework.service.csv.server.controllers.elementary

Interface AuditedCsvDownloadController<DTO extends org.autumnframework.service.api.dtos.AuditedIdentifiable,T extends org.autumnframework.service.jpa.entities.ApiEntity>

Type Parameters:

DTO -

T -

All Superinterfaces:

CsvDownloadController<DTO,T>

All Known Subinterfaces:

AuditedCsvController<DTO,T>, FullCsvDownloadController<DTO,T>

All Known Implementing Classes:

CsvFullStreamingRestController

public interface AuditedCsvDownloadController<DTO extends org.autumnframework.service.api.dtos.AuditedIdentifiable,T extends org.autumnframework.service.jpa.entities.ApiEntity>
extends CsvDownloadController<DTO,T>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AuditedCsvDownloadController.StreamHelper<DTO>

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	log

Method Summary

Modifier and Type	Method	Description
default Stream<T>	getDtoCsvContentStream()
default Stream<T>	getDtoCsvContentStream(LocalDateTime date)
default Stream<T>	getDtoCsvContentStream(LocalDateTime start, LocalDateTime end)
jakarta.persistence.EntityManager	getEntityManager()
default DTO	mapAndDetach(T entity)
default void	streamCsv(Stream<T> records, jakarta.servlet.http.HttpServletResponse response, int offset, boolean camelCaseHeader)
default void	streamDtoCsv(int offset, boolean camelCaseHeader, jakarta.servlet.http.HttpServletResponse response)
default void	streamDtoCsv(LocalDateTime date, int offset, boolean camelCaseHeader, jakarta.servlet.http.HttpServletResponse response)
default void	streamDtoCsv(LocalDateTime start, LocalDateTime end, int offset, boolean camelCaseHeader, jakarta.servlet.http.HttpServletResponse response)

Methods inherited from interface org.autumnframework.service.csv.server.controllers.elementary.CsvDownloadController

downloadDtoCsv, downloadDtoCsv, downloadDtoCsv, getCsvMappingFunction, getDtoCsvContent, getDtoCsvContent, getDtoCsvContent, getDtoCsvName, getDtoCsvName, getDtoExcludeFieldNames, getMapper, getService, returnCsv

Field Details

log

static final org.slf4j.Logger log

Method Details

getEntityManager

jakarta.persistence.EntityManager getEntityManager()

Returns:

streamDtoCsv

@GetMapping(path="/stream",
            produces="text/event-stream")
default void streamDtoCsv(@RequestParam(name="offset",required=false,defaultValue="0")
 int offset,
 @RequestParam(name="camelCase",required=false,defaultValue="true")
 boolean camelCaseHeader,
 jakarta.servlet.http.HttpServletResponse response)
                   throws IOException

Parameters:

offset -

camelCaseHeader -

response -

Throws:

IOException

streamDtoCsv

@GetMapping(path="/stream/since/{date}",
            produces="text/event-stream")
default void streamDtoCsv(@PathVariable(name="date",required=true)
 LocalDateTime date,
 @RequestParam(name="offset",required=false,defaultValue="0")
 int offset,
 @RequestParam(name="camelCaseHeader",required=false,defaultValue="true")
 boolean camelCaseHeader,
 jakarta.servlet.http.HttpServletResponse response)
                   throws IOException

Parameters:

date -

offset -

camelCaseHeader -

response -

Throws:

IOException

streamDtoCsv

@GetMapping(path="/stream/between/{start}/{end}",
            produces="text/event-stream")
default void streamDtoCsv(@PathVariable(name="start",required=true)
 LocalDateTime start,
 @PathVariable(name="end",required=true)
 LocalDateTime end,
 @RequestParam(name="offset",required=false,defaultValue="0")
 int offset,
 @RequestParam(name="camelCaseHeader",required=false,defaultValue="true")
 boolean camelCaseHeader,
 jakarta.servlet.http.HttpServletResponse response)
                   throws IOException

Parameters:

start -

end -

offset -

camelCaseHeader -

response -

Throws:

IOException

getDtoCsvContentStream

default Stream<T> getDtoCsvContentStream()

Returns:

getDtoCsvContentStream

default Stream<T> getDtoCsvContentStream(@NonNull
 LocalDateTime date)

Parameters:

date -

Returns:

getDtoCsvContentStream

default Stream<T> getDtoCsvContentStream(@NonNull
 LocalDateTime start,
 @NonNull
 LocalDateTime end)

Parameters:

start -

end -

Returns:

streamCsv

default void streamCsv(Stream<T> records,
 jakarta.servlet.http.HttpServletResponse response,
 int offset,
 boolean camelCaseHeader)
                throws IOException

Parameters:

records -

response -

offset -

camelCaseHeader -

Throws:

IOException

mapAndDetach

default DTO mapAndDetach(T entity)

Parameters:

entity -

Returns: