axis2_conf_ctx_ops Struct Reference
[configuration context]

#include <axis2_conf_ctx.h>

List of all members.

Public Attributes

axis2_status_t(* set_conf )(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, struct axis2_conf *conf)
axis2_ctx_t *(* get_base )(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)
axis2_conf_t *(* get_conf )(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)
axis2_hash_t *(* get_op_ctx_map )(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)
axis2_hash_t *(* get_svc_ctx_map )(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)
axis2_hash_t *(* get_svc_grp_ctx_map )(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)
axis2_status_t(* register_op_ctx )(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *message_id, axis2_op_ctx_t *op_ctx)
axis2_op_ctx_t *(* get_op_ctx )(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *message_id)
axis2_status_t(* register_svc_ctx )(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *svc_id, axis2_svc_ctx_t *svc_ctx)
axis2_svc_ctx *(* get_svc_ctx )(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *svc_id)
axis2_status_t(* register_svc_grp_ctx )(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *svc_grp_id, axis2_svc_grp_ctx_t *svc_grp_ctx)
axis2_svc_grp_ctx_t *(* get_svc_grp_ctx )(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *svc_grp_id)
const axis2_char_t *(* get_root_dir )(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)
axis2_status_t(* set_root_dir )(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *path)
axis2_status_t(* init )(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, axis2_conf_t *conf)
axis2_status_t(* free )(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)
axis2_svc_grp_ctx_t *(* fill_ctxs )(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)


Detailed Description

configuration context ops struct. Encapsulator struct for ops of axis2_conf_ctx.


Member Data Documentation

axis2_svc_grp_ctx_t*( * axis2_conf_ctx_ops::fill_ctxs)(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, axis2_msg_ctx_t *msg_ctx)

This method fills the context hierarchy (service group, service and operation contexts that is) for the service and operation found in the given message context. If the context hierarchy is not already built it will create the contexts and build the context hierarchy.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
msg_ctx pointer to message context with service and operation for which the context hierarchy is to be built set
Returns:
pointer to the service group context, which is the root of the context hierarchy for given service and operation

axis2_status_t( * axis2_conf_ctx_ops::free)(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)

Frees configuration context struct.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_ctx_t*( * axis2_conf_ctx_ops::get_base)(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)

Gets the base struct, which is of type context

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
Returns:
pointer to context struct, returns a reference not a cloned copy

axis2_conf_t*( * axis2_conf_ctx_ops::get_conf)(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)

Gets the configuration of the engine.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
Returns:
pointer to configuration struct, returns a reference not a cloned copy

axis2_op_ctx_t*( * axis2_conf_ctx_ops::get_op_ctx)(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *message_id)

Gets operation context corresponding to the given message ID.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
message_id message ID related to the operation to be retrieved
Returns:
pointer to operation context related to the given message ID

axis2_hash_t*( * axis2_conf_ctx_ops::get_op_ctx_map)(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)

Gets the hash map of operation context instances.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
Returns:
pointer to hash map containing all operation contexts

const axis2_char_t*( * axis2_conf_ctx_ops::get_root_dir)(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)

Gets the root working directory. It is in this directory that the axis2.xml configuration file is located. The services and modules sub folders too are located in this directory.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
Returns:
pointer to string containing the root folder name

struct axis2_svc_ctx*( * axis2_conf_ctx_ops::get_svc_ctx)(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *svc_id)

Gets service context with the given service ID

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
svc_id service ID
Returns:
pointer to service context with the given service ID

axis2_hash_t*( * axis2_conf_ctx_ops::get_svc_ctx_map)(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)

Gets the hash map of service context instances.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
Returns:
pointer to hash map containing all service contexts

axis2_svc_grp_ctx_t*( * axis2_conf_ctx_ops::get_svc_grp_ctx)(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *svc_grp_id)

Gets service group with the given service group ID.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
svc_grp_id service group id
Returns:
pointer to service group context with the given ID

axis2_hash_t*( * axis2_conf_ctx_ops::get_svc_grp_ctx_map)(const axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env)

Gets the hash map of service group context instances.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
Returns:
pointer to hash map containing all service group contexts

axis2_status_t( * axis2_conf_ctx_ops::init)(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, axis2_conf_t *conf)

Initializes the configuration context. Within this function, it would initialize all the service group context, service context and operation context instances stored within configuration context.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
conf pointer to configuration struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_conf_ctx_ops::register_op_ctx)(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *message_id, axis2_op_ctx_t *op_ctx)

Registers an operation context with the given message ID.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
message_id message id related to the operation context
op_ctx pointer to operation context, conf context assumes ownership of the operation context
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_conf_ctx_ops::register_svc_ctx)(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *svc_id, axis2_svc_ctx_t *svc_ctx)

Registers a service context with the given service ID.

Parameters:
conf_ctx pointer t configuration context
env pointer to environment struct
svc_id ID of the service to be added
svc_ctx pointer to service context
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_conf_ctx_ops::register_svc_grp_ctx)(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *svc_grp_id, axis2_svc_grp_ctx_t *svc_grp_ctx)

Registers a service group context with the given service group ID.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
svc_grp_id service group id
svc_grp_ctx pointer to service group context
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_conf_ctx_ops::set_conf)(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, struct axis2_conf *conf)

Sets the configuration associated with the engine instance.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
conf pointer to configuration
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_conf_ctx_ops::set_root_dir)(axis2_conf_ctx_t *conf_ctx, const axis2_env_t *env, const axis2_char_t *path)

Sets the root working directory. It is in this directory that the axis2.xml configuration file is located. The services and modules sub folders too are located in this directory.

Parameters:
conf_ctx pointer to configuration context
env pointer to environment struct
path string containing the path of root directory
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


The documentation for this struct was generated from the following file:
Generated on Thu Oct 26 21:11:46 2006 for Axis2/C by  doxygen 1.4.7