include/sandesha2_storage_mgr.h

/*
 * Copyright 2004,2005 The Apache Software Foundation.
 *
 * 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 SANDESHA2_STORAGE_MGR_H
#define SANDESHA2_STORAGE_MGR_H

/**
  * @file sandesha2_storage_mgr.h
  * @brief 
  */
#include <platforms/axutil_platform_auto_sense.h>
#include <axutil_utils_defines.h>
#include <axutil_env.h>
#include <axiom_soap_envelope.h>
#include <axis2_conf_ctx.h>
#include <axis2_module_desc.h>
#include <sandesha2_transaction.h>

#ifdef __cplusplus
extern "C"
{
#endif

/** 
 * @ingroup sandesha2_storage
 * @{
 */
 
typedef struct sandesha2_storage_mgr sandesha2_storage_mgr_t;
typedef struct sandesha2_storage_mgr_ops sandesha2_storage_mgr_ops_t;
struct sandesha2_rm_bean;
struct sandesha2_sender_mgr;
struct sandesha2_invoker_mgr;
struct sandesha2_seq_property_mgr;
struct sandesha2_next_msg_mgr;

 /**
 * @brief Storage Manager ops struct
 * Encapsulator struct for ops of sandesha2_storage_mgr
 */
AXIS2_DECLARE_DATA struct sandesha2_storage_mgr_ops
{ 
    axis2_status_t (AXIS2_CALL * 
            free)(
                sandesha2_storage_mgr_t *storage_mgr,
                const axutil_env_t *envv);

    axis2_status_t (AXIS2_CALL *
            free_void_arg)(
                void *storage_mgr,
                const axutil_env_t *env);

    axis2_status_t (AXIS2_CALL *
            init)(
                sandesha2_storage_mgr_t *storage_mgr,
                const axutil_env_t *env,
                axis2_conf_ctx_t *conf_ctx);
        
    axis2_msg_ctx_t *(AXIS2_CALL *
            retrieve_msg_ctx)(
                sandesha2_storage_mgr_t *storage_mgr,
                const axutil_env_t *env,
                axis2_char_t *key,
                axis2_conf_ctx_t *conf_ctx,
                const axis2_bool_t persistent);
            
    axis2_status_t (AXIS2_CALL *
            store_msg_ctx)(
                sandesha2_storage_mgr_t *storage_mgr,
                const axutil_env_t *env,
                axis2_char_t *key,
                axis2_msg_ctx_t *msg_ctx,
                axis2_bool_t store_in_memory);
                
    axis2_status_t (AXIS2_CALL *
            update_msg_ctx)(
                sandesha2_storage_mgr_t *storage_mgr,
                const axutil_env_t *env,
                axis2_char_t *key,
                axis2_msg_ctx_t *msg_ctx);

    axis2_status_t (AXIS2_CALL *
            remove_msg_ctx)(
                sandesha2_storage_mgr_t *storage_mgr,
                const axutil_env_t *env,
                axis2_char_t *key,
                axis2_conf_ctx_t *conf_ctx,
                int msg_type);

    axis2_status_t (AXIS2_CALL *
            init_storage)(
                sandesha2_storage_mgr_t *storage_mgr,
                const axutil_env_t *env,
                axis2_module_desc_t *module_desc);

    axiom_soap_envelope_t *(AXIS2_CALL *
            retrieve_soap_envelope)(
                sandesha2_storage_mgr_t *storage_mgr,
                const axutil_env_t *env,
                axis2_char_t *key);

    axis2_status_t (AXIS2_CALL *
            store_soap_envelope)(
                sandesha2_storage_mgr_t *storage_mgr,
                const axutil_env_t *env,
                axiom_soap_envelope_t *soap_env,
                axis2_char_t *key);
	
    axis2_status_t (AXIS2_CALL *
            store_response) (
                sandesha2_storage_mgr_t *storage_mgr,
                const axutil_env_t *env,
                axis2_char_t *seq_id,
                axiom_soap_envelope_t *response,
                int msg_no,
                int soap_version);

    axiom_soap_envelope_t * (AXIS2_CALL *
            retrieve_response) (
                sandesha2_storage_mgr_t *storage_mgr, 
                const axutil_env_t *env, 
                axis2_char_t *seq_id,
                int msg_no);

    axis2_status_t (AXIS2_CALL *
            remove_response) (
                sandesha2_storage_mgr_t *storage_mgr, 
                const axutil_env_t *env, 
                axis2_char_t *seq_id,
                int msg_no);
};

AXIS2_DECLARE_DATA struct sandesha2_storage_mgr
{
    const sandesha2_storage_mgr_ops_t *ops;
};

/**
 * Frees the storage_mgr given as a void pointer. This method would cast the 
 * void parameter to an storage_mgr pointer and then call free method.
 * @param storage_mgr pointer to storage_mgr as a void pointer
 * @param env pointer to environment struct
 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
 */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
sandesha2_storage_mgr_free_void_arg(
    void *storage_mgr,
    const axutil_env_t *env);

axis2_status_t AXIS2_CALL 
sandesha2_storage_mgr_free(
    sandesha2_storage_mgr_t *storage_mgr,
    const axutil_env_t *envv);

axis2_status_t AXIS2_CALL
sandesha2_storage_mgr_init(
    sandesha2_storage_mgr_t *storage_mgr,
    const axutil_env_t *env,
    axis2_conf_ctx_t *conf_ctx);

/**
 * Retrieve the stored message context.
 * @param storage_mgr
 * @param env environment object
 * @param key message storage key
 * @param conf_ctx configuration context
 * @return newly created axis2_msg_ctx object.
 */
axis2_msg_ctx_t *AXIS2_CALL
sandesha2_storage_mgr_retrieve_msg_ctx(
    sandesha2_storage_mgr_t *storage_mgr,
    const axutil_env_t *env,
    axis2_char_t *key,
    axis2_conf_ctx_t *conf_ctx,
    const axis2_bool_t persistent);

/**
 * Store the application message context. When Sandesha2 handlers
 * receive application messages it will be first stored in inmemory/persistent
 * storage until it is later qualified for sending to the destination
 * @param storage_mgr
 * @param env environment object
 * @param key message storage key.
 * @param msg_ctx message context
 * @return status of the operation
 */
axis2_status_t AXIS2_CALL
sandesha2_storage_mgr_store_msg_ctx(
    sandesha2_storage_mgr_t *storage_mgr,
    const axutil_env_t *env,
    axis2_char_t *key,
    axis2_msg_ctx_t *msg_ctx,
    axis2_bool_t store_in_memory);
			
axis2_status_t AXIS2_CALL
sandesha2_storage_mgr_update_msg_ctx(
    sandesha2_storage_mgr_t *storage_mgr,
    const axutil_env_t *env,
    axis2_char_t *key,
    axis2_msg_ctx_t *msg_ctx);

axis2_status_t AXIS2_CALL
sandesha2_storage_mgr_remove_msg_ctx(
    sandesha2_storage_mgr_t *storage_mgr,
    const axutil_env_t *env,
    axis2_char_t *key,
    axis2_conf_ctx_t *conf_ctx,
    int msg_type);

axis2_status_t AXIS2_CALL
sandesha2_storage_mgr_init_storage(
    sandesha2_storage_mgr_t *storage_mgr,
    const axutil_env_t *env,
    axis2_module_desc_t *module_desc);

axiom_soap_envelope_t *AXIS2_CALL
sandesha2_storage_mgr_retrieve_soap_envelope(
    sandesha2_storage_mgr_t *storage_mgr,
    const axutil_env_t *env,
    axis2_char_t *key);

axis2_status_t AXIS2_CALL
sandesha2_storage_mgr_store_soap_envelope(
    sandesha2_storage_mgr_t *storage_mgr,
    const axutil_env_t *env,
    axiom_soap_envelope_t *soap_env,
    axis2_char_t *key);

axis2_status_t AXIS2_CALL
sandesha2_storage_mgr_store_response(
    sandesha2_storage_mgr_t *storage_mgr,
    const axutil_env_t *env,
    axis2_char_t *seq_id,
    axiom_soap_envelope_t *response,
    int msg_no,
    int soap_version);

axiom_soap_envelope_t * AXIS2_CALL
sandesha2_storage_mgr_retrieve_response(
    sandesha2_storage_mgr_t *storage_mgr, 
    const axutil_env_t *env, 
    axis2_char_t *seq_id,
    int msg_no);

axis2_status_t AXIS2_CALL
sandesha2_storage_mgr_remove_response(
    sandesha2_storage_mgr_t *storage_mgr, 
    const axutil_env_t *env, 
    axis2_char_t *seq_id,
    int msg_no);
                       
/** @} */
#ifdef __cplusplus
}
#endif

#endif /*SANDESHA2_STORAGE_MGR_H*/