json_tools.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.
*/
 
#ifndef JSON_TOOLS_H
#define JSON_TOOLS_H
 
#include "network_library.h"
#include "jansson.h"
 
#include "typedefs.h"
#include "operation.h"
#include "request_tools.h"
//#include "uuid/uuid.h"
#include "user_details.h"
#include "schema_version.h"
#include "grassroots_server.h"
 
 
 
/* forward declaration */
struct ProvidersStateTable;
 
#ifdef __cplusplus
extern "C" 
{
#endif
 
 
GRASSROOTS_NETWORK_API json_t *GetAvailableServicesRequest (const User *user_p, const SchemaVersion * const sv_p);
 
 
GRASSROOTS_NETWORK_API bool GetUsernameAndPassword (const User * const user_p, const char *provider_s, const char **username_ss, const char **password_ss);
 
 
GRASSROOTS_NETWORK_API json_t *GetInterestedServicesRequest (const User *user_p, const char * const protocol_s, const char * const filename_s, const SchemaVersion * const sv_p);
 
 
GRASSROOTS_NETWORK_API json_t *GetNamedServicesRequest (const User *user_p, const char * const service_name_s, const SchemaVersion * const sv_p);
 
 
GRASSROOTS_NETWORK_API json_t *GetNamedServicesIndexingDataRequest (const User *user_p, const char * const service_names_s, const SchemaVersion * const sv_p);
 
 
GRASSROOTS_NETWORK_API bool AddClientConfigToJSON (json_t *root_p, const User *user_p);
 
 
GRASSROOTS_NETWORK_API json_t *GetOperationAsJSON (Operation op, const SchemaVersion * const sv_p);
 
 
GRASSROOTS_NETWORK_API json_t *GetServicesRequest (const User *user_p, const Operation op, const char * const op_key_s, json_t * const op_data_p, const SchemaVersion * const sv_p);
 
 
GRASSROOTS_NETWORK_API json_t *MakeRemoteJsonCall (json_t *req_p, Connection *connection_p);
 
 
GRASSROOTS_NETWORK_API const char *GetUserUUIDStringFromJSON (const json_t *credentials_p);
 
 
GRASSROOTS_NETWORK_API json_t *GetServicesResultsRequest (const uuid_t **ids_pp, const uint32 num_ids, Connection *connection_p, const SchemaVersion * const sv_p);
 
 
GRASSROOTS_NETWORK_API bool GetStatusFromJSON (const json_t *service_json_p, OperationStatus *status_p);
 
 
 
 
GRASSROOTS_NETWORK_API json_t *CallServices (json_t *client_results_p, const User *user_p, Connection *connection_p);
 
 
GRASSROOTS_NETWORK_API json_t *GetInitialisedMessage (const SchemaVersion * const sv_p);
 
 
 
GRASSROOTS_NETWORK_API const char *GetServiceDescriptionFromJSON (const json_t * const root_p);
 
 
GRASSROOTS_NETWORK_API const char *GetServiceAliasFromJSON (const json_t * const root_p);
 
 
GRASSROOTS_NETWORK_API const char *GetServiceNameFromJSON (const json_t * const root_p);
 
 
GRASSROOTS_NETWORK_API const char *GetOperationDescriptionFromJSON (const json_t * const root_p);
 
 
GRASSROOTS_NETWORK_API const char *GetOperationNameFromJSON (const json_t * const root_p);
 
 
GRASSROOTS_NETWORK_API const char *GetOperationInformationURIFromJSON (const json_t * const root_p);
 
 
GRASSROOTS_NETWORK_API const char *GetOperationIconURIFromJSON (const json_t * const root_p);
 
 
 
GRASSROOTS_NETWORK_API const json_t *GetProviderFromServiceJSON (const json_t *service_json_p);
 
 
 
GRASSROOTS_NETWORK_API Operation GetOperationFromTopLevelJSON (const json_t * const json_p);
 
 
 
 
GRASSROOTS_NETWORK_API json_t *GetIndexingDataPayload (GrassrootsServer *grassroots_p, const char *service_s, json_t *params_array_json_p);
 
 
#ifdef __cplusplus
}
#endif
 
#endif    /* #ifndef JSON_TOOLS_H */