linked_service.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
/*
 * linked_service.h
 *
 *  Created on: 6 Sep 2016
 *      Author: tyrrells
 */
 
#ifndef SERVER_SRC_SERVICES_LIB_INCLUDE_LINKED_SERVICE_H_
#define SERVER_SRC_SERVICES_LIB_INCLUDE_LINKED_SERVICE_H_
 
#include "grassroots_service_library.h"
 
#include "jansson.h"
 
#include "linked_list.h"
#include "mapped_parameter.h"
#include "grassroots_server.h"
 
/* forward declarations */
struct ServiceJob;
 
 
typedef struct LinkedService
{
  char *ls_output_service_s;
 
  LinkedList *ls_mapped_params_p;
 
 
  const char *ls_generate_fn_s;
 
 
  char *ls_input_key_s;
 
  const json_t *ls_config_p;
 
  GrassrootsServer *ls_grassroots_p;
 
} LinkedService;
 
 
typedef struct LinkedServiceNode
{
  ListItem lsn_node;
 
  LinkedService *lsn_linked_service_p;
} LinkedServiceNode;
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_SERVICE_API LinkedService *AllocateLinkedService (const char *linked_service_s, const char *input_key_s, const json_t *mapped_params_json_p, const char * const function_s, const json_t *config_p, GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_SERVICE_API LinkedService *CreateLinkedServiceFromJSON (struct Service *service_p, const json_t *linked_service_json_p, GrassrootsServer *grassroots_p);
 
 
 
GRASSROOTS_SERVICE_API void FreeLinkedService (LinkedService *linked_service_p);
 
 
GRASSROOTS_SERVICE_API LinkedServiceNode *AllocateLinkedServiceNode (LinkedService *linked_service_p);
 
 
GRASSROOTS_SERVICE_API void FreeLinkedServiceNode (ListItem *node_p);
 
 
GRASSROOTS_SERVICE_API bool CreateAndAddMappedParameterToLinkedService (LinkedService *linked_service_p, const char *input_s, const char *output_s, bool required_flag, bool multi_flag);
 
 
GRASSROOTS_SERVICE_API bool AddMappedParameterToLinkedService (LinkedService *linked_service_p, struct MappedParameter *mapped_param_p);
 
 
 
GRASSROOTS_SERVICE_API struct MappedParameter *GetMappedParameterByInputParamName (const LinkedService *linked_service_p, const char * const name_s);
 
 
GRASSROOTS_SERVICE_API json_t *GetLinkedServiceAsJSON (LinkedService *linked_service_p);
 
 
GRASSROOTS_SERVICE_API bool ProcessLinkedService (LinkedService *linked_service_p, struct ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API bool AddLinkedServiceToRequestJSON (json_t *request_p, LinkedService *linked_service_p, ParameterSet *output_params_p);
 
 
 
 
GRASSROOTS_SERVICE_API bool RunCustomLinkedServiceGenerator (struct LinkedService *linked_service_p, json_t *data_p, struct ServiceJob *job_p);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* SERVER_SRC_SERVICES_LIB_INCLUDE_LINKED_SERVICE_H_ */