aida_pva_server_helper.h File Reference

The Header File for the Native Channel Provider Server Helper functions. More...

#include "aida_pva.h"

Go to the source code of this file.

Functions
Argument	getArgument (Arguments arguments, char *name)
	Get a named argument. More...
json_value *	getJsonRoot (json_value *jsonValue)
json_value *	getJsonValue (Value *value, char *passedInPath)
	Get the json value from the given value identified by the path. More...
Value	getNamedArrayValue (JNIEnv *env, Arguments arguments, char *name)
	Get array value from a named argument in the provided arguments structure. More...
Value	getNamedValue (JNIEnv *env, Arguments arguments, char *name)
	Get value from a named argument in the provided arguments structure. More...

Detailed Description

The Header File for the Native Channel Provider Server Helper functions.

CMS=C_INC

Definition in file aida_pva_server_helper.h.

Function Documentation

getArgument()

Argument getArgument	(	Arguments	arguments,
		char *	name
	)

Get a named argument.

Parameters

arguments	arguments
name	name

Returns

Argument

Definition at line 184 of file aida_pva_server_helper.c.

{
    Argument noArgument;
    memset(&noArgument, 0, sizeof(Argument));
 
    for (int i = 0; i < arguments.argumentCount; i++) {
        Argument argument = arguments.arguments[i];
        if (!strcasecmp(argument.name, name)) {
            if (strlen(argument.value) > 0) {
                return argument;
            }
        }
    }
    return noArgument;
}

References Arguments::argumentCount, Arguments::arguments, Argument::name, and Argument::value.

getJsonRoot()

json_value * getJsonRoot

(

json_value *

jsonValue

)

Skip root element if it is _array otherwise return unchanged

This is because our json parser can't process arrays at the top level and so we insert
an object at the top level with an "_array" element if we find an array at the top level

Parameters

jsonValue

the json value traverse

Returns

json value

Definition at line 404 of file aida_pva_server_helper.c.

{
    if (jsonValue->type == json_object && jsonValue->u.object.length == 1
            && strcmp(jsonValue->u.object.values[0].name, "_array") == 0) {
        jsonValue = jsonValue->u.object.values[0].value;
    }
    return jsonValue;
}

Referenced by getJsonValue().

getJsonValue()

json_value * getJsonValue	(	Value *	value,
		char *	passedInPath
	)

Get the json value from the given value identified by the path.

Parameters

value	the given value
passedInPath	is an absolute reference to the element within the json of the given value. e.g. root.collection[0].name

Returns

the json_value

Parameters

value	the given value
passedInPath	is an absolute reference to the element within the json of the given value. e.g. root.collection.[0].name

Returns

pointer to the json_value

Definition at line 347 of file aida_pva_server_helper.c.

{
    if (value->type != AIDA_JSON_TYPE || !value->value.jsonValue) {
        return NULL;
    }
 
    json_value* jsonValue = getJsonRoot(value->value.jsonValue);
 
    // If there is no path then we already have the json value
    if (!passedInPath || strlen(passedInPath) == 0) {
        return jsonValue;
    }
 
    // can't use const for strtok
    char path[strlen(passedInPath) + 1];
    strcpy(path, passedInPath);
 
    int len;
    char name[256];
    char* arrayRef;
 
    // Extract the first token
    char* token = strtok(path, ".");
 
    while (token) {
        if (*token == '[') {
            // if array is at top level
            jsonValue = processArrayReference(jsonValue, token);
        } else if ((arrayRef = strstr(token, "["))) {
            // element followed by array ref
            len = (int)(arrayRef - token);
            strncpy(name, token, len);
            name[len] = 0x0;
            jsonValue = navigateToObjectElement(jsonValue, name);
 
            jsonValue = processArrayReference(jsonValue, arrayRef);
        } else {
            // element only
            jsonValue = navigateToObjectElement(jsonValue, token);
        }
 
        // Next token
        token = strtok(NULL, ".");
    }
 
    return jsonValue;
}

References AIDA_JSON_TYPE, getJsonRoot(), ValueContents::jsonValue, Value::type, and Value::value.

getNamedArrayValue()

Value getNamedArrayValue	(	JNIEnv *	env,
		Arguments	arguments,
		char *	name
	)

Get array value from a named argument in the provided arguments structure.

Parameters

env	env
arguments	provided arguments structure
name	provided name

Returns

the extracted Value

Get array value from a named argument in the provided arguments structure.

Parameters

env	the JNI environment. Used in all functions involving JNI
arguments	provided arguments structure
name	provided name

Returns

the extracted Value

Definition at line 335 of file aida_pva_server_helper.c.

{
    return getNamedValueImpl(env, arguments, name, true);
}

Referenced by getArrayValue().

getNamedValue()

Value getNamedValue	(	JNIEnv *	env,
		Arguments	arguments,
		char *	name
	)

Get value from a named argument in the provided arguments structure.

Parameters

env	env
arguments	provided arguments structure
name	provided name

Returns

the extracted Value

Parameters

env	the JNI environment. Used in all functions involving JNI
arguments	provided arguments structure
name	provided name

Returns

the extracted Value

Definition at line 322 of file aida_pva_server_helper.c.

{
    return getNamedValueImpl(env, arguments, name, false);
}

Referenced by getValue().