Data lake configuration module implementation file. More...

#include "mcl_data_lake/mcl_data_lake_configuration.h"
#include "data_lake_configuration.h"
#include "mcl_core/mcl_memory.h"
#include "mcl_core/mcl_string_util.h"

Include dependency graph for data_lake_configuration.c:

Go to the source code of this file.

Functions
static mcl_error_t	_set_data_lake_configuration_core_parameter (mcl_data_lake_configuration_t configuration, mcl_core_t core)

mcl_error_t	mcl_data_lake_configuration_initialize (mcl_data_lake_configuration_t **configuration)

mcl_error_t	mcl_data_lake_configuration_set_parameter (mcl_data_lake_configuration_t configuration, E_MCL_DATA_LAKE_CONFIGURATION_PARAMETER parameter, const void value)

mcl_error_t	data_lake_configuration_validate (data_lake_configuration_t *configuration)

void	mcl_data_lake_configuration_destroy (mcl_data_lake_configuration_t **configuration)

Variables
static const char	_upload_url_generation_endpoint [] = "/api/datalake/v3/generateUploadObjectUrls"

Detailed Description

Data lake configuration module implementation file.

Copyright: Copyright (C) 2019 Siemens Aktiengesellschaft.
All rights reserved.

Definition in file data_lake_configuration.c.

Function Documentation

static mcl_error_t _set_data_lake_configuration_core_parameter	(	mcl_data_lake_configuration_t *	configuration,
		mcl_core_t *	core
	)

static

Definition at line 121 of file data_lake_configuration.c.

References _upload_url_generation_endpoint, mcl_core_get_host_name(), MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_INVALID_PARAMETER, MCL_MALLOC, MCL_NULL, MCL_OK, MCL_OUT_OF_MEMORY, mcl_string_util_memcpy(), and mcl_string_util_strlen().

Referenced by mcl_data_lake_configuration_set_parameter().

Here is the call graph for this function:

Here is the caller graph for this function:

mcl_error_t data_lake_configuration_validate ( data_lake_configuration_t * configuration )

This function checks whether all mandatory parameters of a data lake configuration are set or not.

Parameters

[in] configuration Data lake configuration to validate.

Returns

MCL_OK in case of success.
MCL_INVALID_PARAMETER in case data lake configuration has one or more missing mandatory parameters.

Definition at line 91 of file data_lake_configuration.c.

References data_lake_configuration_t::core, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_INVALID_PARAMETER, MCL_NULL, and MCL_OK.

Referenced by mcl_data_lake_initialize().

Here is the caller graph for this function:

void mcl_data_lake_configuration_destroy ( mcl_data_lake_configuration_t ** configuration )

This function destroys mcl_data_lake_configuration_t data structure.

Parameters

[in] configuration Data lake configuration handle which is going to be destroyed.

Definition at line 107 of file data_lake_configuration.c.

References MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, and MCL_NULL.

mcl_error_t mcl_data_lake_configuration_initialize ( mcl_data_lake_configuration_t ** configuration )

This function creates and initializes a data struct of mcl_data_lake_configuration_t.

Parameters

[out] configuration Data structure holding the data lake configuration parameters.

Returns

MCL_OK in case of success.
MCL_TRIGGERED_WITH_NULL if provided configuration is NULL.
MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.

Definition at line 20 of file data_lake_configuration.c.

References MCL_ASSERT_NOT_NULL, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FALSE, MCL_FUNCTION_LEAVE_LABEL, MCL_NEW, MCL_NULL, MCL_OK, and MCL_OUT_OF_MEMORY.

mcl_error_t mcl_data_lake_configuration_set_parameter	(	mcl_data_lake_configuration_t *	configuration,
		E_MCL_DATA_LAKE_CONFIGURATION_PARAMETER	parameter,
		const void *	value
	)

This function is used to set a parameter of a data lake configuration.

Parameters

[in]	configuration	Data lake configuration to set its parameter.
[in]	parameter	One of the parameters listed in E_MCL_DATA_LAKE_CONFIGURATION_PARAMETER.
[in]	value	New value of the `parameter`.

Returns

MCL_OK in case of success.
MCL_TRIGGERED_WITH_NULL if provided configuration or value is NULL.
MCL_INVALID_PARAMETER if provided parameter is invalid.
MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.

Definition at line 50 of file data_lake_configuration.c.

References _set_data_lake_configuration_core_parameter(), MCL_ASSERT_NOT_NULL, MCL_DATA_LAKE_CONFIGURATION_PARAMETER_CERTIFICATE, MCL_DATA_LAKE_CONFIGURATION_PARAMETER_CERTIFICATE_FILE, MCL_DATA_LAKE_CONFIGURATION_PARAMETER_CORE, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FALSE, MCL_FUNCTION_LEAVE_LABEL, MCL_INVALID_PARAMETER, MCL_NO_FILE_SUPPORT, MCL_OK, mcl_string_util_reset(), and MCL_TRUE.

Here is the call graph for this function:

Variable Documentation

const char _upload_url_generation_endpoint[] = "/api/datalake/v3/generateUploadObjectUrls"

static

Definition at line 15 of file data_lake_configuration.c.

Referenced by _set_data_lake_configuration_core_parameter().

Functions

Variables

Detailed Description

Function Documentation

Variable Documentation