net.datenwerke.rs.core.service.datasinkmanager

Interface DatasinkService

All Known Implementing Classes:

DatasinkServiceImpl

public interface DatasinkService

Method Summary

Modifier and Type	Method and Description
void	exportFileIntoDatasink(AbstractFileServerNodeDto fileDto, DatasinkDefinitionDto datasinkDto, java.lang.String filename, java.lang.String folder, boolean compressed)
void	exportIntoDatasink(CompiledReport cReport, java.lang.String name, boolean compress, DatasinkDefinition datasink, DatasinkConfiguration config)
void	exportIntoDatasink(java.lang.Object report, DatasinkDefinition datasink, DatasinkConfiguration config) Sends a data to the specified datasink, defined in a given DatasinkDefinition datasink.
void	exportIntoDatasink(java.lang.Object report, DatasinkDefinition datasink, java.lang.String fileEnding) Sends a data to the specified datasink, defined in a given DatasinkDefinition datasink.
void	exportIntoDatasink(java.lang.Object report, User user, DatasinkDefinition datasink, DatasinkConfiguration config) Sends a data to the specified datasink, defined in a given DatasinkDefinition datasink.
void	exportIntoDatasink(ReportExecuteJob rJob, boolean compress, DatasinkDefinition datasink, DatasinkConfiguration config)
java.util.Optional<? extends DatasinkDefinition>	getDefaultDatasink(BasicDatasinkService basicDatasinkService)
java.lang.String	getDefaultFolder(FolderedDatasink datasink)
java.util.Map<StorageType,java.lang.Boolean>	getEnabledConfigs(BasicDatasinkService datasinkService) Summarizes #isEnabled(DatasinkDefinition)) and #isSchedulingEnabled(DatasinkDefinition)) in a map.
java.lang.String	getFilenameForDatasink(ReportExecuteJob rJob, boolean compress, java.lang.String filename)
java.lang.String	getFilenameForDatasink(java.lang.String name, CompiledReport cReport, boolean compress)
boolean	isEnabled(BasicDatasinkService datasinkService) Returns the current configuration value of datasink enabling.
boolean	isSchedulingEnabled(BasicDatasinkService datasinkService) Returns the current configuration value of scheduling enabling.
void	testDatasink(DatasinkDefinition datasinkDefinition, DatasinkConfiguration config) Issues a datasink test request by creating a simple text file and sending it to the specified directory in the specified datasink.

Method Detail

getDefaultFolder

java.lang.String getDefaultFolder(FolderedDatasink datasink)

isEnabled

boolean isEnabled(BasicDatasinkService datasinkService)

Returns the current configuration value of datasink enabling. Has to be true in order for reports to be sent to the specified datasink type.

Parameters:

datasinkService - the datasink service

Returns:

true if the datasink type is enabled

isSchedulingEnabled

boolean isSchedulingEnabled(BasicDatasinkService datasinkService)

Returns the current configuration value of scheduling enabling. Reports can only be sent to the specified datasink type inside a scheduling job if this is true.

Parameters:

datasinkService - the datasink service

Returns:

true if datasink's scheduling is enabled

getEnabledConfigs

java.util.Map<StorageType,java.lang.Boolean> getEnabledConfigs(BasicDatasinkService datasinkService)

Summarizes #isEnabled(DatasinkDefinition)) and #isSchedulingEnabled(DatasinkDefinition)) in a map.

Parameters:

datasinkService - the datasink service

Returns:

a map containing the enabling configuration for #isEnabled(DatasinkDefinition)) and #isSchedulingEnabled(DatasinkDefinition))

testDatasink

void testDatasink(DatasinkDefinition datasinkDefinition,
                  DatasinkConfiguration config)
           throws DatasinkExportException

Issues a datasink test request by creating a simple text file and sending it to the specified directory in the specified datasink.

Parameters:

datasinkDefinition - the DatasinkDefinition to test

config - the datasink export configuration

Throws:

DatasinkExportException - if an error occurs during datasink export

exportIntoDatasink

void exportIntoDatasink(java.lang.Object report,
                        User user,
                        DatasinkDefinition datasink,
                        DatasinkConfiguration config)
                 throws DatasinkExportException

Sends a data to the specified datasink, defined in a given DatasinkDefinition datasink.

Parameters:

report - the data to send. May be a String, a byte array or a TableDBDataSource

user - the User

datasink - the DatasinkDefinition to send

config - configuration of the export

Throws:

DatasinkExportException - if an error occurs during datasink export

exportIntoDatasink

void exportIntoDatasink(ReportExecuteJob rJob,
                        boolean compress,
                        DatasinkDefinition datasink,
                        DatasinkConfiguration config)
                 throws ActionExecutionException

Throws:

ActionExecutionException

getFilenameForDatasink

java.lang.String getFilenameForDatasink(ReportExecuteJob rJob,
                                        boolean compress,
                                        java.lang.String filename)

getFilenameForDatasink

java.lang.String getFilenameForDatasink(java.lang.String name,
                                        CompiledReport cReport,
                                        boolean compress)

exportIntoDatasink

void exportIntoDatasink(CompiledReport cReport,
                        java.lang.String name,
                        boolean compress,
                        DatasinkDefinition datasink,
                        DatasinkConfiguration config)
                 throws DatasinkExportException

Throws:

DatasinkExportException

exportIntoDatasink

void exportIntoDatasink(java.lang.Object report,
                        DatasinkDefinition datasink,
                        DatasinkConfiguration config)
                 throws DatasinkExportException

Sends a data to the specified datasink, defined in a given DatasinkDefinition datasink.

Parameters:

report - the data to send. May be a String, a byte array or a TableDBDataSource

datasink - the DatasinkDefinition to send

config - configuration of the export

Throws:

DatasinkExportException - if an error occurs during datasink export

exportIntoDatasink

void exportIntoDatasink(java.lang.Object report,
                        DatasinkDefinition datasink,
                        java.lang.String fileEnding)
                 throws DatasinkExportException

Sends a data to the specified datasink, defined in a given DatasinkDefinition datasink. Uses datasink default configuration.

Parameters:

report - the data to send. May be a String, a byte array or a TableDBDataSource

datasink - the DatasinkDefinition to send

fileEnding - the ending of the file to export, e.g. ".txt" for text files

Throws:

DatasinkExportException - if an error occurs during datasink export

getDefaultDatasink

java.util.Optional<? extends DatasinkDefinition> getDefaultDatasink(BasicDatasinkService basicDatasinkService)

exportFileIntoDatasink

void exportFileIntoDatasink(AbstractFileServerNodeDto fileDto,
                            DatasinkDefinitionDto datasinkDto,
                            java.lang.String filename,
                            java.lang.String folder,
                            boolean compressed)
                     throws ServerCallFailedException

Throws:

ServerCallFailedException