afw_adaptor_impl.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Helpers for afw_adaptor implementation development
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_ADAPTOR_IMPL_H__
#define __AFW_ADAPTOR_IMPL_H__
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
#define AFW_ADAPTOR_IMPL_LOCK_READ_BEGIN(adaptor) \
AFW_LOCK_READ_BEGIN((adaptor)->impl->adaptor_lock_rw)
 
 
#define AFW_ADAPTOR_IMPL_LOCK_READ_END \
AFW_LOCK_READ_END
 
 
#define AFW_ADAPTOR_IMPL_LOCK_WRITE_BEGIN(adaptor) \
AFW_LOCK_WRITE_BEGIN((adaptor)->impl->adaptor_lock_rw)
 
 
#define AFW_ADAPTOR_IMPL_LOCK_WRITE_END \
AFW_LOCK_WRITE_END
 
 
typedef struct afw_adaptor_impl_core_object_type_s {
    const afw_utf8_t *object_type_id;
    const afw_object_t *object;
    afw_boolean_t allow_entity;
    afw_boolean_t allow_write;
} afw_adaptor_impl_core_object_type_t;
 
 
struct afw_adaptor_impl_s {
 
    const afw_adaptor_inf_t *wrapped_inf;
 
    const afw_adaptor_t *adaptor;
 
    const afw_utf8_t *adaptor_id;
 
    const afw_utf8_t *source_location;
 
    const afw_object_t *metrics_object;
 
    const afw_lock_rw_t *adaptor_lock_rw;
 
    const afw_utf8_t *authorization_handler_id;
 
    const afw_utf8_t *journal_adaptor_id;
 
    const afw_model_location_t *model_location;
 
    const afw_authorization_policy_location_t *policy_location;
 
    apr_hash_t *supported_core_object_types;
 
    const afw_value_t *authorization;
 
    const afw_object_t *custom_variables;
 
    AFW_ATOMIC afw_integer_t retrieve_objects_count;
 
    AFW_ATOMIC afw_integer_t get_object_count;
 
    AFW_ATOMIC afw_integer_t add_object_count;
 
    AFW_ATOMIC afw_integer_t modify_object_count;
 
    AFW_ATOMIC afw_integer_t replace_object_count;
 
    AFW_ATOMIC afw_integer_t update_object_count;
 
    AFW_ATOMIC afw_integer_t delete_object_count;
 
    apr_hash_t *object_types_ht;
 
    afw_boolean_t all_object_types_immutable;
 
    afw_boolean_t object_types_fully_loaded;
};
 
 
struct afw_adaptor_impl_session_s {
 
    afw_adaptor_session_t pub;
 
    const afw_adaptor_session_t *wrapped_session;
 
    afw_adaptor_journal_t journal_pub;
 
    const afw_adaptor_journal_t *wrapped_journal;
};
 
 
struct afw_adaptor_impl_request_s {
 
    const afw_pool_t *p;
 
    const afw_object_t *journal_entry;
 
    const afw_object_t *request;
 
    const afw_object_options_t *options;
 
    const afw_utf8_t *resource_id;
};
 
 
AFW_DECLARE(afw_adaptor_t *)
afw_adaptor_impl_create_cede_p(
    const afw_adaptor_inf_t *inf,
    afw_size_t instance_size,
    const afw_object_t *properties,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_adaptor_impl_object_type_cache_initialize(
    afw_adaptor_object_type_cache_t *object_type_cache,
    const afw_adaptor_object_type_cache_inf_t *inf,
    const afw_adaptor_session_t *session,
    afw_boolean_t all_object_types_immutable,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE_CONST_DATA(afw_adaptor_object_type_cache_inf_t)
afw_adaptor_impl_object_type_cache_inf;
 
 
 
AFW_DECLARE(void)
afw_adaptor_impl_set_object_types_fully_loaded(
    const afw_adaptor_t *adaptor,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_object_t *)
afw_adaptor_impl_generic_object_type_object_get(
    const afw_adaptor_t *adaptor,
    const afw_utf8_t *object_type_id,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_adaptor_impl_push_qualifiers(
    const afw_adaptor_t *adaptor,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_adaptor_impl_throw_property_invalid(
    const afw_adaptor_t *adaptor,
    const afw_utf8_t *property_name,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_adaptor_impl_throw_property_required(
    const afw_adaptor_t *adaptor,
    const afw_utf8_t *property_name,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_adaptor_impl_call_object_cb_from_list(
    const afw_list_t *list,
    void * context,
    afw_object_cb_t callback,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(afw_boolean_t)
afw_adaptor_impl_is_journal_entry_applicable(
    const afw_adaptor_journal_t *instance,
    const afw_object_t * entry,
    const afw_object_t * consumer,
    const afw_value_t * const * filter,
    afw_xctx_t *xctx);
 
#define AFW_ADAPTOR_IMPL_ERROR_ADAPTOR_IMMUTABLE \
AFW_THROW_ERROR_Z(read_only, "Adaptor is read-only.", xctx)
 
 
AFW_DECLARE(void)
afw_adaptor_impl_set_supported_core_object_type(
    const afw_adaptor_t *adaptor,
    const afw_utf8_t *object_type_id,
    afw_boolean_t allow_entity,
    afw_boolean_t allow_write,
    afw_xctx_t *xctx);
 
 
AFW_END_DECLARES
 
#endif /* __AFW_ADAPTOR_IMPL_H__ */