modules/core/deployment/axis2_svc_builder.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 AXIS2_SVC_BUILDER_H
#define AXIS2_SVC_BUILDER_H

/**
 * @file axis2_svc_builder.h
 * @brief Axis2 Service Builder interface
 */

#include <axis2.h>
#include <axis2_error.h>
#include <axis2_defines.h>
#include <axis2_env.h>
#include <axis2_allocator.h>
#include <axis2_qname.h>
#include <axis2_desc_builder.h>
#include <axis2_addr.h>
#include <axis2_dep_engine.h>

#ifdef __cplusplus
extern "C"
{
#endif
 
struct axis2_dep_engine;    
typedef struct axis2_svc_builder axis2_svc_builder_t;
typedef struct axis2_svc_builder_ops axis2_svc_builder_ops_t;

/** @defgroup axis2_svc_builder Service Builder
 * @ingroup axis2_deployment
 * @{
 */

/** 
 * @brief Service Builder ops struct
 * Encapsulator struct for ops of axis2_svc_builder
 */
AXIS2_DECLARE_DATA struct axis2_svc_builder_ops
{
	/** De-allocate memory
  	 * @return status code
  	 */
	axis2_status_t (AXIS2_CALL *
    free)(axis2_svc_builder_t *svc_builder,
	        axis2_env_t **env);
                                   
    /**
     * top most method that is used to populate service from corresponding OM
     */
    axis2_status_t (AXIS2_CALL *
    populate_svc) (axis2_svc_builder_t *svc_builder,
                                    axis2_env_t **env,
                                    axis2_om_node_t *svc_node);
    
    
    axis2_status_t (AXIS2_CALL *
    process_svc_module_conf) (axis2_svc_builder_t *svc_builder,
                                    axis2_env_t **env,
                                    axis2_om_children_qname_iterator_t *module_confs,
                                    axis2_param_container_t *parent, 
                                    axis2_svc_t *svc);
    
    
    /**
     * To get the list og modules that is requird to be engage globally
     * @param moduleRefs  <code>java.util.Iterator</code>
     */
    axis2_status_t (AXIS2_CALL *
    process_module_refs) (axis2_svc_builder_t *svc_builder,
                            axis2_env_t **env,
                            axis2_om_children_qname_iterator_t *module_refs);
 

};

/** 
 * @brief Service Builder struct 
 */  
AXIS2_DECLARE_DATA struct axis2_svc_builder
{
	axis2_svc_builder_ops_t *ops;
    struct axis2_desc_builder *desc_builder;
};

/**
 * Creates svc builder struct
 * @return pointer to newly created service builder
 */
AXIS2_DECLARE(axis2_svc_builder_t *)
axis2_svc_builder_create (axis2_env_t **env);

/**
 * Creates svc builder struct
 * @param file_name,
 * @param dep_engine,
 * @param svc
 * @return pointer to newly created service builder
 */
AXIS2_DECLARE(axis2_svc_builder_t *)
axis2_svc_builder_create_with_file_and_dep_engine_and_svc (axis2_env_t **env,
                                                axis2_char_t *file_name,
                                                struct axis2_dep_engine *dep_engine,
                                                axis2_svc_t *svc);

/**
 * Creates svc builder struct
 * @param dep_engine
 * @param svc
 * @return pointer to newly created service builder
 */
AXIS2_DECLARE(axis2_svc_builder_t *) 
axis2_svc_builder_create_with_dep_engine_and_svc (axis2_env_t **env,
                                                struct axis2_dep_engine *dep_engine,
                                                axis2_svc_t *svc);

/*************************** Function macros **********************************/

#define AXIS2_SVC_BUILDER_FREE(svc_builder, env) \
		((svc_builder)->ops->free (svc_builder, env))

#define AXIS2_SVC_BUILDER_POPULATE_SVC(svc_builder, env, svc_node) \
		((svc_builder)->ops->populate_svc (svc_builder, env, svc_node))

#define AXIS2_SVC_BUILDER_PROCESS_MODULE_REFS(svc_builder, env, module_refs) \
		((svc_builder)->ops->process_module_refs (svc_builder, env, module_refs))


/*************************** End of function macros ***************************/

/** @} */

#ifdef __cplusplus
}
#endif
#endif  /* AXIS2_SVC_BUILDER_H */