axis2_handler_desc_ops Struct Reference
[handler description]

#include <axis2_handler_desc.h>

List of all members.

Public Attributes

const axis2_qname_t *(* get_qname )(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env)
axis2_status_t(* set_qname )(axis2_handler_desc_t *handler_desc, const axis2_env_t *env, const axis2_qname_t *qname)
axis2_phase_rule_t *(* get_rules )(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env)
axis2_status_t(* set_rules )(axis2_handler_desc_t *handler_desc, const axis2_env_t *env, axis2_phase_rule_t *phase_rule)
axis2_param_t *(* get_param )(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env, const axis2_char_t *name)
axis2_status_t(* add_param )(axis2_handler_desc_t *handler_desc, const axis2_env_t *env, axis2_param_t *param)
axis2_array_list_t *(* get_all_params )(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env)
axis2_bool_t(* is_param_locked )(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env, const axis2_char_t *param_name)
axis2_handler_t *(* get_handler )(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env)
axis2_status_t(* set_handler )(axis2_handler_desc_t *handler_desc, const axis2_env_t *env, axis2_handler_t *handler)
const axis2_char_t *(* get_class_name )(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env)
axis2_status_t(* set_class_name )(axis2_handler_desc_t *handler_desc, const axis2_env_t *env, const axis2_char_t *class_name)
axis2_param_container_t *(* get_parent )(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env)
axis2_status_t(* set_parent )(axis2_handler_desc_t *handler_desc, const axis2_env_t *env, axis2_param_container_t *parent)
axis2_status_t(* free )(axis2_handler_desc_t *handler_desc, const axis2_env_t *env)


Detailed Description

handler description ops struct. Encapsulator struct for ops of axis2_handler_desc.


Member Data Documentation

axis2_status_t( * axis2_handler_desc_ops::add_param)(axis2_handler_desc_t *handler_desc, const axis2_env_t *env, axis2_param_t *param)

Adds given parameter to the parameter list.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
param pointer to param
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_handler_desc_ops::free)(axis2_handler_desc_t *handler_desc, const axis2_env_t *env)

Frees handler description.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_array_list_t*( * axis2_handler_desc_ops::get_all_params)(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env)

Gets all parameters stored within handler description.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
Returns:
pointer to array list containing parameters, returns a reference, not a cloned copy

const axis2_char_t*( * axis2_handler_desc_ops::get_class_name)(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env)

Gets the class name. Class name is the name of the shared library file that contains the implementation of the handler.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
Returns:
class name string

axis2_handler_t*( * axis2_handler_desc_ops::get_handler)(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env)

Gets the handler associated with the handler description.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
Returns:
pointer to handler, returns a reference, not a cloned copy

axis2_param_t*( * axis2_handler_desc_ops::get_param)(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env, const axis2_char_t *name)

Gets named parameter.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
name parameter name string
Returns:
pointer to parameter if found, else NULL. Return a reference not a cloned copy

axis2_param_container_t*( * axis2_handler_desc_ops::get_parent)(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env)

Gets the parent. Parent of handler description is of type parameter container.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
Returns:
pointer to parent parameter container, returns a reference, not a cloned copy

const axis2_qname_t*( * axis2_handler_desc_ops::get_qname)(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env)

Gets QName.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
Returns:
pointer to QName, returns a reference, not a cloned copy

axis2_phase_rule_t*( * axis2_handler_desc_ops::get_rules)(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env)

Gets phase rules.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
Returns:
pointer to phase rule struct containing phase rules

axis2_bool_t( * axis2_handler_desc_ops::is_param_locked)(const axis2_handler_desc_t *handler_desc, const axis2_env_t *env, const axis2_char_t *param_name)

Checks if the named parameter is locked at any level

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
param_name parameter name string
Returns:
AXIS2_TRUE if the parameter is locked, else AXIS2_FALSE

axis2_status_t( * axis2_handler_desc_ops::set_class_name)(axis2_handler_desc_t *handler_desc, const axis2_env_t *env, const axis2_char_t *class_name)

Sets the class name. Class name is the name of the shared library file that contains the implementation of the handler.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
class_name class name string
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_handler_desc_ops::set_handler)(axis2_handler_desc_t *handler_desc, const axis2_env_t *env, axis2_handler_t *handler)

Sets the handler associated with the handler description.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
handler pointer to handler, handler description assumes the ownership of the handler
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_handler_desc_ops::set_parent)(axis2_handler_desc_t *handler_desc, const axis2_env_t *env, axis2_param_container_t *parent)

Gets the parent. Parent of handler description is of type parameter container.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
parent pointer to parent parameter container struct, handler description assumes ownership of struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_handler_desc_ops::set_qname)(axis2_handler_desc_t *handler_desc, const axis2_env_t *env, const axis2_qname_t *qname)

Sets QName.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
qname pointer to QName, handler description creates a clone of QName
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_handler_desc_ops::set_rules)(axis2_handler_desc_t *handler_desc, const axis2_env_t *env, axis2_phase_rule_t *phase_rule)

Sets phase rules.

Parameters:
handler_desc pointer to handler description
env pointer to environment struct
phase_rule pointer to phase rule struct, handler description assumes ownership of the struct
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:00:31 2006 for Axis2/C by  doxygen 1.4.7