axis2_svc_grp_ops Struct Reference
[service group]

#include <axis2_svc_grp.h>

List of all members.

Public Attributes

axis2_status_t(* free )(axis2_svc_grp_t *svc_grp, const axis2_env_t *env)
axis2_status_t(* set_name )(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_char_t *svc_grp_name)
const axis2_char_t *(* get_name )(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env)
axis2_status_t(* add_svc )(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, struct axis2_svc *svc)
axis2_svc *(* get_svc )(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_qname_t *svc_qname)
axis2_hash_t *(* get_all_svcs )(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env)
axis2_status_t(* remove_svc )(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_qname_t *svc_qname)
axis2_status_t(* add_param )(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, axis2_param_t *param)
axis2_param_t *(* get_param )(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_char_t *name)
axis2_array_list_t *(* get_all_params )(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env)
axis2_bool_t(* is_param_locked )(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_char_t *param_name)
axis2_status_t(* add_module_qname )(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_qname_t *module_qname)
axis2_conf *(* get_parent )(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env)
axis2_status_t(* set_parent )(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, struct axis2_conf *parent)
axis2_status_t(* engage_module )(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_qname_t *module_qname)
axis2_array_list_t *(* get_all_module_qnames )(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env)
axis2_status_t(* add_module_ref )(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_qname_t *moduleref)
axis2_array_list_t *(* get_all_module_refs )(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env)
axis2_svc_grp_ctx *(* get_svc_grp_ctx )(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env, struct axis2_conf_ctx *parent)


Detailed Description

service group ops struct. Encapsulator struct for ops of axis2_svc_grp.


Member Data Documentation

axis2_status_t( * axis2_svc_grp_ops::add_module_qname)(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_qname_t *module_qname)

Adds given module QName to list of module QNames.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
module_name pointer to module QName
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_svc_grp_ops::add_module_ref)(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_qname_t *moduleref)

Adds module reference.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
moduleref pointer to module QName
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_svc_grp_ops::add_param)(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, axis2_param_t *param)

Adds parameter.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
param pointer to parameter, service group assumes ownership of parameter
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_svc_grp_ops::add_svc)(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, struct axis2_svc *svc)

Adds given service to service group.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
service service to be added, service group assumes ownership of service
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_svc_grp_ops::engage_module)(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_qname_t *module_qname)

Engages named module to service group. Engaging a module to service group would ensure that the same module would be engaged to all services within the group.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
module_name pointer to module QName
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_svc_grp_ops::free)(axis2_svc_grp_t *svc_grp, const axis2_env_t *env)

Frees service group.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_array_list_t*( * axis2_svc_grp_ops::get_all_module_qnames)(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env)

Gets all module QNames associated with service group.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
Returns:
pointer to array list containing all QNames, returns a reference, not a cloned copy

axis2_array_list_t*( * axis2_svc_grp_ops::get_all_module_refs)(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env)

Gets all module references.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
Returns:
pointer to array list containing module reference, returns a reference, not a cloned copy

axis2_array_list_t*( * axis2_svc_grp_ops::get_all_params)(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env)

Gets all parameters set on service group.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
Returns:
pointer to array list containing parameter, returns a reference, not a cloned copy

axis2_hash_t*( * axis2_svc_grp_ops::get_all_svcs)(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env)

Gets all services associated with service group.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
Returns:
pointer to hash table containing all services, returns a reference, not a cloned copy

const axis2_char_t*( * axis2_svc_grp_ops::get_name)(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env)

Gets service group name.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
Returns:
service group name string

axis2_param_t*( * axis2_svc_grp_ops::get_param)(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_char_t *name)

Gets named parameter.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
name parameter name
Returns:
pointer to named parameter if exists, else NULL. Returns a reference, not a cloned copy

struct axis2_conf*( * axis2_svc_grp_ops::get_parent)(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env)

Gets parent which is of type configuration.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
Returns:
pointer to parent configuration, returns a reference, not a cloned copy

struct axis2_svc*( * axis2_svc_grp_ops::get_svc)(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_qname_t *svc_qname)

Gets named service from service group.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
svc_qname pointer to QName of the service
Returns:
pointer to service corresponding to given QName, returns a reference, not a cloned copy

struct axis2_svc_grp_ctx*( * axis2_svc_grp_ops::get_svc_grp_ctx)(const axis2_svc_grp_t *svc_grp, const axis2_env_t *env, struct axis2_conf_ctx *parent)

Gets service group context related to this service group.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
parent pointer to configuration context which is the parent of the context hierarchy
Returns:
pointer to service group context related to this service group, returns a reference, not a cloned copy

axis2_bool_t( * axis2_svc_grp_ops::is_param_locked)(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_char_t *param_name)

Checks if the named parameter is locked.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
param_name pointer to param name
Returns:
AXIS2_TRUE if the named parameter is locked, else AXIS2_FALSE

axis2_status_t( * axis2_svc_grp_ops::remove_svc)(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_qname_t *svc_qname)

Removes named service from service group.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
svc_name pointer to service QName
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_svc_grp_ops::set_name)(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, const axis2_char_t *svc_grp_name)

Sets service group name.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
svc_grp_name service group name string
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_svc_grp_ops::set_parent)(axis2_svc_grp_t *svc_grp, const axis2_env_t *env, struct axis2_conf *parent)

Sets parent which is of type configuration.

Parameters:
svc_grp pointer to service group struct
env pointer to environment struct
parent parent configuration, service group does not assume the ownership of configuration
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


The documentation for this struct was generated from the following file:
Generated on Tue Oct 3 22:36:10 2006 for Axis2/C by  doxygen 1.4.7