grassroots_server.h

Go to the documentation of this file.

/*
** Copyright 2014-2018 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.
*/
/*
 * grassroots_server.h
 *
 *  Created on: 26 Jul 2019
 *      Author: billy
 */
 
#ifndef CORE_SERVER_SERVER_INCLUDE_GRASSROOTS_SERVER_H_
#define CORE_SERVER_SERVER_INCLUDE_GRASSROOTS_SERVER_H_
 
#include "grassroots_service_manager_library.h"
 
#include "jansson.h"
 
 
#include "servers_manager.h"
#include "schema_version.h"
#include "user_details.h"
#include "handler.h"
 
/*
 * forward declarations
 */
struct JobsManager;
struct ServersManager;
struct MongoClientManager;
struct Service;
 
 
typedef struct GrassrootsServer
{
  char *gs_path_s;
 
  char *gs_config_filename_s;
 
  char *gs_config_path_s;
 
 
  char *gs_references_path_s;
 
  char *gs_services_path_s;
 
 
  char *gs_jobs_managers_path_s;
 
 
  char *gs_servers_managers_path_s;
 
 
 
  struct JobsManager *gs_jobs_manager_p;
 
  MEM_FLAG gs_jobs_manager_mem;
 
  struct ServersManager *gs_servers_manager_p;
 
  MEM_FLAG gs_servers_manager_mem;
 
  json_t *gs_config_p;
 
  SchemaVersion *gs_schema_version_p;
 
  struct MongoClientManager *gs_mongo_manager_p;
 
//  struct PersistentServiceData *gs_persistent_service_data_p;
} GrassrootsServer;
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_SERVICE_MANAGER_API GrassrootsServer *AllocateGrassrootsServer (const char *grassroots_path_s, const char *config_filename_s, const char *service_config_path_s, const char *services_path_s, const char *references_path_s,
  const char *jobs_managers_path_s, const char *servers_managers_path_s, struct JobsManager *external_jobs_manager_p, MEM_FLAG jobs_manager_flag, struct ServersManager *external_servers_manager_p, MEM_FLAG servers_manager_flag);
 
 
GRASSROOTS_SERVICE_MANAGER_API void FreeGrassrootsServer (GrassrootsServer *server_p);
 
 
 
GRASSROOTS_SERVICE_MANAGER_API struct JobsManager *GetJobsManager (GrassrootsServer *grassroots_p);
 
 
 
GRASSROOTS_SERVICE_MANAGER_API bool SetGrassrootsServerConfig (GrassrootsServer *server_p, const char *config_filename_s);
 
 
 
GRASSROOTS_SERVICE_MANAGER_API bool InitGrassrootsServer (GrassrootsServer *server_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API void ConnectToExternalServers (GrassrootsServer *server_p);
 
 
GRASSROOTS_SERVICE_MANAGER_LOCAL void DisconnectFromExternalServers (GrassrootsServer *server_p);
 
 
 
GRASSROOTS_SERVICE_MANAGER_API void LoadMatchingServicesByName (GrassrootsServer *grassroots_p, LinkedList *services_p, const char *service_name_s, const char *service_alias_s, User *user_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API void LoadMatchingServices (GrassrootsServer *grassroots_p, LinkedList *services_p, DataResource *resource_p, Handler *handler_p, User *user_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API void LoadKeywordServices (GrassrootsServer *grassroots_p, LinkedList *services_p, User *user_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API json_t *ProcessServerJSONMessage (GrassrootsServer *grassroots_p, json_t *json_req_p, User *user_p, const char **error_ss);
 
 
GRASSROOTS_SERVICE_MANAGER_API json_t *GetInitialisedResponseOnServer (GrassrootsServer *server_p, User *user_p, const json_t *req_p, const char *key_s, json_t *value_p);
 
 
 
GRASSROOTS_SERVICE_MANAGER_API json_t *GetGlobalConfigValue (const GrassrootsServer *grassroots_p, const char *key_s);
 
 
GRASSROOTS_SERVICE_MANAGER_API const char *GetServerProviderName (const GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API const char *GetServerProviderDescription (const GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API const char *GetServerProviderURI (const GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API const json_t *GetProviderAsJSON (const GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API bool IsServiceEnabled (const GrassrootsServer *grassroots_p, const char *service_name_s);
 
 
 
GRASSROOTS_SERVICE_MANAGER_API void AddReferenceServices (GrassrootsServer *grassroots_p, LinkedList *services_p,
                     const char *operation_name_s, User *user_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API const char *GetJobLoggingURI (const GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API const SchemaVersion *GetSchemaVersion (GrassrootsServer *server_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API struct ServersManager *GetServersManager (GrassrootsServer *server_p);
 
 
 
 
 
 
GRASSROOTS_SERVICE_MANAGER_API const char *GetServerRootDirectory (const GrassrootsServer * const grassroots_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API json_t *GetGlobalServiceConfig (GrassrootsServer *grassroots_p, const char * const service_name_s, bool *alloc_flag_p);
 
 
 
GRASSROOTS_SERVICE_MANAGER_API User *GetUserByEmailAddress (const GrassrootsServer *grassroots_p, const char *email_s);
 
 
 
 
GRASSROOTS_SERVICE_MANAGER_API User *GetUserByIdString (const GrassrootsServer *grassroots_p, const char *id_s);
 
 
 
GRASSROOTS_SERVICE_MANAGER_API User *GetUserById (const GrassrootsServer *grassroots_p, const bson_oid_t *id_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API LinkedList *GetAllUsers (const GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API struct Service *GetServiceByName (GrassrootsServer *grassroots_p, const char *const service_name_s, const char *const service_alias_s);
 
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* CORE_SERVER_SERVER_INCLUDE_GRASSROOTS_SERVER_H_ */