service group
[description]


Files

file  axis2_svc_grp.h

Classes

struct  axis2_svc_grp_ops
struct  axis2_svc_grp

Defines

#define AXIS2_SVC_GRP_FREE(svc_grp, env)   ((svc_grp)->ops->free (svc_grp , env))
#define AXIS2_SVC_GRP_SET_NAME(svc_grp, env, svc_grp_name)   ((svc_grp)->ops->set_name (svc_grp, env, svc_grp_name))
#define AXIS2_SVC_GRP_GET_NAME(svc_grp, env)   ((svc_grp)->ops->get_name(svc_grp, env))
#define AXIS2_SVC_GRP_ADD_SVC(svc_grp, env, svc)   ((svc_grp)->ops->add_svc (svc_grp, env, svc))
#define AXIS2_SVC_GRP_GET_SVC(svc_grp, env, svc_name)   ((svc_grp)->ops->get_svc(svc_grp, env, svc_names))
#define AXIS2_SVC_GRP_GET_ALL_SVCS(svc_grp, env)   ((svc_grp)->ops->get_all_svcs(svc_grp, env))
#define AXIS2_SVC_GRP_REMOVE_SVC(svc_grp, env, svc_name)   ((svc_grp)->ops->remove_svc(svc_grp, env, svc_name))
#define AXIS2_SVC_GRP_ADD_PARAM(svc_grp, env, param)   ((svc_grp)->ops->add_param(svc_grp, env, param))
#define AXIS2_SVC_GRP_GET_PARAM(svc_grp, env, name)   ((svc_grp)->ops->get_param(svc_grp, env, name))
#define AXIS2_SVC_GRP_GET_ALL_PARAMS(svc_grp, env)   ((svc_grp)->ops->get_all_params(svc_grp, env))
#define AXIS2_SVC_GRP_IS_PARAM_LOCKED(svc_grp, env, param_name)   ((svc_grp)->ops->is_param_locked(svc_grp, env, param_name))
#define AXIS2_SVC_GRP_ADD_MODULE_QNAME(svc_grp, env, module_qname)   ((svc_grp)->ops->add_module_qname(svc_grp, env, module_qname))
#define AXIS2_SVC_GRP_GET_PARENT(svc_grp, env)   ((svc_grp)->ops->get_parent(svc_grp, env))
#define AXIS2_SVC_GRP_SET_PARENT(svc_grp, env, parent)   ((svc_grp)->ops->set_parent(svc_grp, env, parent))
#define AXIS2_SVC_GRP_ENGAGE_MODULE(svc_grp, env, module_name)   ((svc_grp)engage_module_modulep, env, module_name))
#define AXIS2_SVC_GRP_GET_ALL_MODULE_QNAMES(svc_grp, env)   ((svc_grp)->ops->get_all_module_qnames(svc_grp, env))
#define AXIS2_SVC_GRP_ADD_MODULE_REF(svc_grp, env, moduleref)   ((svc_grp)->ops->add_module_ref(svc_grp, env, moduleref))
#define AXIS2_SVC_GRP_GET_ALL_MODULE_REFS(svc_grp, env)   ((svc_grp)->ops->get_all_module_refs(svc_grp, env))
#define AXIS2_SVC_GRP_GET_SVC_GRP_CTX(svc_grp, env, parent)   ((svc_grp)->ops->get_svc_grp_ctx(svc_grp, env, parent))

Typedefs

typedef axis2_svc_grp_ops axis2_svc_grp_ops_t
typedef axis2_svc_grp axis2_svc_grp_t

Functions

AXIS2_EXTERN axis2_svc_grp_taxis2_svc_grp_create (const axis2_env_t *env)
AXIS2_EXTERN axis2_svc_grp_taxis2_svc_grp_create_with_conf (const axis2_env_t *env, struct axis2_conf *conf)

Detailed Description

service group represents the static structure of a service group in the Axis2 configuration. In Axis2 description hierarchy, a service group lives inside the configuration. service groups are configured in services.xml files located in the respective service group folders of the services folder in the repository. In services.xml file, services groups are declared at top level. A service group can have one or more services associated with it. Sometimes services.xml would not have a service group defined, but only a service. In such cases a service group with the same name as that of the service mentioned in services.xml would be created by the deployment engine and the service would be associated with that newly created service group. The deployment engine would create service group instances to represent those configured service groups in services.xml files and would store them in the configuration. service group encapsulates data on engaged module information and the service associated with service group.

Define Documentation

#define AXIS2_SVC_GRP_ADD_MODULE_QNAME ( svc_grp,
env,
module_qname   )     ((svc_grp)->ops->add_module_qname(svc_grp, env, module_qname))

Adds module QName.

See also:
axis2_svc_grp_ops::add_module_qname

#define AXIS2_SVC_GRP_ADD_MODULE_REF ( svc_grp,
env,
moduleref   )     ((svc_grp)->ops->add_module_ref(svc_grp, env, moduleref))

Adds module reference.

See also:
axis2_svc_grp_ops::add_module_ref

#define AXIS2_SVC_GRP_ADD_PARAM ( svc_grp,
env,
param   )     ((svc_grp)->ops->add_param(svc_grp, env, param))

Adds parameter.

See also:
axis2_svc_grp_ops::add_param

#define AXIS2_SVC_GRP_ADD_SVC ( svc_grp,
env,
svc   )     ((svc_grp)->ops->add_svc (svc_grp, env, svc))

Adds service.

See also:
axis2_svc_grp_ops::add_svc

#define AXIS2_SVC_GRP_ENGAGE_MODULE ( svc_grp,
env,
module_name   )     ((svc_grp)engage_module_modulep, env, module_name))

Engages module to service group.

See also:
axis2_svc_grp_ops::engage_module

#define AXIS2_SVC_GRP_FREE ( svc_grp,
env   )     ((svc_grp)->ops->free (svc_grp , env))

Frees service group.

See also:
axis2_svc_grp_ops::free

#define AXIS2_SVC_GRP_GET_ALL_MODULE_QNAMES ( svc_grp,
env   )     ((svc_grp)->ops->get_all_module_qnames(svc_grp, env))

Gets all module QNames.

See also:
axis2_svc_grp_ops::get_all_module_qnames

#define AXIS2_SVC_GRP_GET_ALL_MODULE_REFS ( svc_grp,
env   )     ((svc_grp)->ops->get_all_module_refs(svc_grp, env))

Get all module references.

See also:
axis2_svc_grp_ops::get_all_module_refs

#define AXIS2_SVC_GRP_GET_ALL_PARAMS ( svc_grp,
env   )     ((svc_grp)->ops->get_all_params(svc_grp, env))

Gets all parameters.

See also:
axis2_svc_grp_ops::get_all_params

#define AXIS2_SVC_GRP_GET_ALL_SVCS ( svc_grp,
env   )     ((svc_grp)->ops->get_all_svcs(svc_grp, env))

Gets all services.

See also:
axis2_svc_grp_ops::get_all_svcs

#define AXIS2_SVC_GRP_GET_NAME ( svc_grp,
env   )     ((svc_grp)->ops->get_name(svc_grp, env))

Gets name.

See also:
axis2_svc_grp_ops::get_name

#define AXIS2_SVC_GRP_GET_PARAM ( svc_grp,
env,
name   )     ((svc_grp)->ops->get_param(svc_grp, env, name))

Gets named parameter.

See also:
axis2_svc_grp_ops::get_param

#define AXIS2_SVC_GRP_GET_PARENT ( svc_grp,
env   )     ((svc_grp)->ops->get_parent(svc_grp, env))

Gets parent configuration.

See also:
axis2_svc_grp_ops::get_parent

#define AXIS2_SVC_GRP_GET_SVC ( svc_grp,
env,
svc_name   )     ((svc_grp)->ops->get_svc(svc_grp, env, svc_names))

Gets named service.

See also:
axis2_svc_grp_ops::get_svc

#define AXIS2_SVC_GRP_GET_SVC_GRP_CTX ( svc_grp,
env,
parent   )     ((svc_grp)->ops->get_svc_grp_ctx(svc_grp, env, parent))

Gets service group context related to service.

See also:
axis2_svc_grp_ops::get_svc_grp_ctx

#define AXIS2_SVC_GRP_IS_PARAM_LOCKED ( svc_grp,
env,
param_name   )     ((svc_grp)->ops->is_param_locked(svc_grp, env, param_name))

Checks if the named parameter is locked.

See also:
axis2_svc_grp_ops::is_param_locked

#define AXIS2_SVC_GRP_REMOVE_SVC ( svc_grp,
env,
svc_name   )     ((svc_grp)->ops->remove_svc(svc_grp, env, svc_name))

Removes named service.

See also:
axis2_svc_grp_ops::remove_svc

#define AXIS2_SVC_GRP_SET_NAME ( svc_grp,
env,
svc_grp_name   )     ((svc_grp)->ops->set_name (svc_grp, env, svc_grp_name))

Sets name.

See also:
axis2_svc_grp_ops::set_name

#define AXIS2_SVC_GRP_SET_PARENT ( svc_grp,
env,
parent   )     ((svc_grp)->ops->set_parent(svc_grp, env, parent))

Sets parent configuration.

See also:
axis2_svc_grp_ops::set_parent


Typedef Documentation

typedef struct axis2_svc_grp_ops axis2_svc_grp_ops_t

Type name for struct axis2_svc_grp_ops

typedef struct axis2_svc_grp axis2_svc_grp_t

Type name for struct axis2_svc_grp


Function Documentation

AXIS2_EXTERN axis2_svc_grp_t* axis2_svc_grp_create ( const axis2_env_t env  ) 

Creates a service group struct instance.

Parameters:
env pointer to environment struct
Returns:
pointer to newly created service group

AXIS2_EXTERN axis2_svc_grp_t* axis2_svc_grp_create_with_conf ( const axis2_env_t env,
struct axis2_conf conf 
)

Creates service group with given configuration as the parent.

Parameters:
env pointer to environment struct
conf pointer to configuration, service group created does not assume ownership of configuration
Returns:
pointer to newly created service group


Generated on Wed Dec 20 20:14:13 2006 for Axis2/C by  doxygen 1.5.1