operation
[description]


Files

file  axis2_op.h

Classes

struct  axis2_op_ops
struct  axis2_op

Defines

#define AXIS2_SOAP_ACTION   "soapAction"
#define AXIS2_OP_FREE(op, env)   ((op)->ops->free (op, env))
#define AXIS2_OP_ADD_PARAM(op, env, param)   ((op)->ops->add_param (op, env, param))
#define AXIS2_OP_GET_PARAM(op, env, key)   ((op)->ops->get_param (op, env, key))
#define AXIS2_OP_GET_ALL_PARAMS(op, env)   ((op)->ops->get_all_params (op, env))
#define AXIS2_OP_IS_PARAM_LOCKED(op, env, param_name)   ((op)->ops->is_param_locked(op, env, param_name))
#define AXIS2_OP_SET_PARENT(op, env, service_desc)   ((op)->ops->set_parent (op, env, service_desc))
#define AXIS2_OP_GET_PARENT(op, env)   ((op)->ops->get_parent (op, env))
#define AXIS2_OP_SET_MSG_RECV(op, env, msg_recv)   ((op)->ops->set_msg_recv (op, env, msg_recv))
#define AXIS2_OP_GET_MSG_RECV(op, env)   ((op)->ops->get_msg_recv (op, env))
#define AXIS2_OP_SET_QNAME(op, env, qname)   ((op)->ops->set_qname (op, env, qname))
#define AXIS2_OP_GET_QNAME(op, env)   (((axis2_op_t *) op)->ops->get_qname (op, env))
#define AXIS2_OP_SET_MSG_EXCHANGE_PATTERN(op, env, msg_exchange_pattern)
#define AXIS2_OP_GET_MSG_EXCHANGE_PATTERN(op, env)   ((op)->ops->get_msg_exchange_pattern (op, env))
#define AXIS2_OP_GET_STYLE(op, env)   ((op)->ops->get_style (op, env))
#define AXIS2_OP_SET_STYLE(op, env, style)   ((op)->ops->set_style (op, env, style))
#define AXIS2_OP_ENGAGE_MODULE(op, env, moduleref, conf)   ((op)->ops->engage_module (op, env, moduleref, conf))
#define AXIS2_OP_ADD_TO_ENGAGED_MODULE_LIST(op, env, module_name)   ((op)->ops->add_to_engaged_module_list (op, env, module_name))
#define AXIS2_OP_GET_ALL_MODULES(op, env)   ((op)->ops->get_all_modules (op, env))
#define AXIS2_OP_GET_AXIS_SPECIFIC_MEP_CONST(op, env)   ((op)->ops->get_axis_specific_mep_const (op, env))
#define AXIS2_OP_GET_FAULT_IN_FLOW(op, env)   ((op)->ops->get_fault_in_flow (op, env))
#define AXIS2_OP_GET_FAULT_OUT_FLOW(op, env)   ((op)->ops->get_fault_out_flow (op, env))
#define AXIS2_OP_GET_OUT_FLOW(op, env)   ((op)->ops->get_out_flow (op, env))
#define AXIS2_OP_GET_IN_FLOW(op, env)   ((op)->ops->get_in_flow (op, env))
#define AXIS2_OP_SET_FAULT_IN_FLOW(op, env, list)   ((op)->ops->set_fault_in_flow (op, env, list))
#define AXIS2_OP_SET_FAULT_OUT_FLOW(op, env, list)   ((op)->ops->set_fault_out_flow (op, env, list))
#define AXIS2_OP_SET_OUT_FLOW(op, env, list)   ((op)->ops->set_out_flow (op, env, list))
#define AXIS2_OP_SET_IN_FLOW(op, env, list)   ((op)->ops->set_in_flow (op, env, list))
#define AXIS2_OP_ADD_MODULE_QNAME(op, env, module_name)   ((op)->ops->add_module_qname (op, env, module_name))
#define AXIS2_OP_GET_ALL_MODULE_QNAMES(op, env)   ((op)->ops->get_all_module_qnames (op, env))
#define AXIS2_OP_GET_ALL_IN_FAULTS(op, env)   ((op)->ops->get_all_in_faults (op, env))
#define AXIS2_OP_SET_IN_FAULTS(op, env)   ((op)->ops->set_in_faults (op, env, in_faults))
#define AXIS2_OP_GET_INPUT_MSG(op, env)   ((op)->ops->get_input_msg (op, env))
#define AXIS2_OP_SET_INPUT_MSG(op, env)   ((op)->ops->set_input_msg (op, env, input_msg))
#define AXIS2_OP_GET_ALL_OUT_FAULTS(op, env)   ((op)->ops->get_all_out_faults (op, env))
#define AXIS2_OP_SET_OUT_FAULTS(op, env)   ((op)->ops->set_out_faults (op, env, out_faults))
#define AXIS2_OP_GET_OUTPUT_MSG(op, env)   ((op)->ops->get_output_msg (op, env))
#define AXIS2_OP_SET_OUTPUT_MSG(op, env)   ((op)->ops->set_output_msg (op, env, output_msg))
#define AXIS2_OP_GET_TARGET_NAMESPACE(op, env)   ((op)->ops->get_target_namespace (op, env))
#define AXIS2_OP_ADD_IN_FAULT(op, env, in_fault)   ((op)->ops->add_in_fault (op, env, in_fault))
#define AXIS2_OP_ADD_OUT_FAULT(op, env, out_fault)   ((op)->ops->add_out_fault (op, env, out_fault))
#define AXIS2_OP_ADD_FEATURE(op, env, feature)   ((op)->ops->add_feature (op, env, feature))
#define AXIS2_OP_GET_ALL_FEATURES(op, env)   ((op)->ops->get_all_features(op, env))
#define AXIS2_OP_ADD_PROPERTY(op, env, wsdl_property)   ((op)->ops->add_property (op, env, wsdl_property))
#define AXIS2_OP_GET_ALL_PROPERTIES(op, env)   ((op)->ops->get_all_properties (op, env))
#define AXIS2_OP_SET_WSDL_OP(op, env, wsdl_op)   ((op)->ops->set_wsdl_op (op, env, wsdl_op))
#define AXIS2_OP_FIND_OP_CTX(op, env, msg_ctx, svc_ctx)   ((op)->ops->find_op_ctx (op, env, msg_ctx, svc_ctx))
#define AXIS2_OP_FIND_FOR_EXISTING_OP_CTX(op, env, wsdl_op)   ((op)->ops->find_existing_op_ctx (op, env, wsdl_op))
#define AXIS2_OP_REGISTER_OP_CTX(op, env, msg_ctx, wsdl_op)   ((op)->ops->register_op_ctx (op, env, msg_ctx, wsdl_op))
#define AXIS2_OP_GET_MSG(op, env, label)   ((op)->ops->get_msg(op, env, label))
#define AXIS2_OP_ADD_MSG(op, env, label, msg)   ((op)->ops->add_msg(op, env, label, msg))

Typedefs

typedef axis2_op_ops axis2_op_ops_t
typedef axis2_op axis2_op_t

Functions

AXIS2_EXTERN axis2_op_taxis2_op_create (const axis2_env_t *env)
AXIS2_EXTERN axis2_op_taxis2_op_create_with_qname (const axis2_env_t *env, const axis2_qname_t *name)
AXIS2_EXTERN axis2_op_taxis2_op_create_with_wsdl_op (const axis2_env_t *env, struct axis2_wsdl_op *wsdl_op)
AXIS2_EXTERN axis2_status_t axis2_op_free_void_arg (void *op, const axis2_env_t *env)

Detailed Description

operation represents the static structure of an operation in a service. In Axis2 description hierarchy, an operation lives inside the service to which it belongs. operations are configured in services.xml files located in the respective service group folders of the services folder in the repository. In services.xml file, operations are declared in association with a given service. The deployment engine would create operation instances to represent those configured operations and would associate them with the respective service in the configuration. operation encapsulates data on message exchange pattern (MEP), the execution flows, engaged module information, and the message receiver associated with the operation.

Define Documentation

#define AXIS2_OP_ADD_FEATURE op,
env,
feature   )     ((op)->ops->add_feature (op, env, feature))
 

Adds feature.

See also:
axis2_op_ops::add_feature

#define AXIS2_OP_ADD_IN_FAULT op,
env,
in_fault   )     ((op)->ops->add_in_fault (op, env, in_fault))
 

Adds in fault.

See also:
axis2_op_ops::add_in_fault

#define AXIS2_OP_ADD_MODULE_QNAME op,
env,
module_name   )     ((op)->ops->add_module_qname (op, env, module_name))
 

Adds given module QName to module qname list.

See also:
axis2_op_ops::add_module_qname

#define AXIS2_OP_ADD_MSG op,
env,
label,
msg   )     ((op)->ops->add_msg(op, env, label, msg))
 

Adds message with given label.

See also:
axis2_op_ops::add_msg

#define AXIS2_OP_ADD_OUT_FAULT op,
env,
out_fault   )     ((op)->ops->add_out_fault (op, env, out_fault))
 

Adds out fault.

See also:
axis2_op_ops::add_out_fault

#define AXIS2_OP_ADD_PARAM op,
env,
param   )     ((op)->ops->add_param (op, env, param))
 

Adds parameter.

See also:
axis2_op_ops::add_param

#define AXIS2_OP_ADD_PROPERTY op,
env,
wsdl_property   )     ((op)->ops->add_property (op, env, wsdl_property))
 

Adds property.

See also:
axis2_op_ops::add_property

#define AXIS2_OP_ADD_TO_ENGAGED_MODULE_LIST op,
env,
module_name   )     ((op)->ops->add_to_engaged_module_list (op, env, module_name))
 

Adds the named module to engaged module list.

See also:
axis2_op_ops::add_to_engaged_module_list

#define AXIS2_OP_ENGAGE_MODULE op,
env,
moduleref,
conf   )     ((op)->ops->engage_module (op, env, moduleref, conf))
 

Engages the given module.

See also:
axis2_op_ops::engage_module

#define AXIS2_OP_FIND_FOR_EXISTING_OP_CTX op,
env,
wsdl_op   )     ((op)->ops->find_existing_op_ctx (op, env, wsdl_op))
 

Finds existing operation context related to this operation.

See also:
axis2_op_ops::find_existing_op_ctx

#define AXIS2_OP_FIND_OP_CTX op,
env,
msg_ctx,
svc_ctx   )     ((op)->ops->find_op_ctx (op, env, msg_ctx, svc_ctx))
 

Finds operation context related to this operation.

See also:
axis2_op_ops::find_op_ctx

#define AXIS2_OP_FREE op,
env   )     ((op)->ops->free (op, env))
 

Frees operation.

See also:
axis2_op_ops::free

#define AXIS2_OP_GET_ALL_FEATURES op,
env   )     ((op)->ops->get_all_features(op, env))
 

Gets all features.

See also:
axis2_op_ops::get_all_features

#define AXIS2_OP_GET_ALL_IN_FAULTS op,
env   )     ((op)->ops->get_all_in_faults (op, env))
 

Gets in faults.

See also:
axis2_op_ops::get_all_in_faults

#define AXIS2_OP_GET_ALL_MODULE_QNAMES op,
env   )     ((op)->ops->get_all_module_qnames (op, env))
 

Gets all module descriptions.

See also:
axis2_op_ops::get_all_module_qnames

#define AXIS2_OP_GET_ALL_MODULES op,
env   )     ((op)->ops->get_all_modules (op, env))
 

Gets all modules.

See also:
axis2_op_ops::get_all_modules

#define AXIS2_OP_GET_ALL_OUT_FAULTS op,
env   )     ((op)->ops->get_all_out_faults (op, env))
 

Gets out faults.

See also:
axis2_op_ops::get_all_out_faults

#define AXIS2_OP_GET_ALL_PARAMS op,
env   )     ((op)->ops->get_all_params (op, env))
 

Gets all the parameters as a list.

See also:
axis2_op_ops::get_all_params

#define AXIS2_OP_GET_ALL_PROPERTIES op,
env   )     ((op)->ops->get_all_properties (op, env))
 

Gets all properties.

See also:
axis2_op_ops::get_all_properties

#define AXIS2_OP_GET_AXIS_SPECIFIC_MEP_CONST op,
env   )     ((op)->ops->get_axis_specific_mep_const (op, env))
 

Gets Axis specific MEP constant.

See also:
axis2_op_ops::get_axis_specific_mep_const

#define AXIS2_OP_GET_FAULT_IN_FLOW op,
env   )     ((op)->ops->get_fault_in_flow (op, env))
 

Gets fault in flow.

See also:
axis2_op_ops::get_fault_in_flow

#define AXIS2_OP_GET_FAULT_OUT_FLOW op,
env   )     ((op)->ops->get_fault_out_flow (op, env))
 

Gets fault out flow.

See also:
axis2_op_ops::get_fault_out_flow

#define AXIS2_OP_GET_IN_FLOW op,
env   )     ((op)->ops->get_in_flow (op, env))
 

Gets in flow.

See also:
axis2_op_ops::get_in_flow

#define AXIS2_OP_GET_INPUT_MSG op,
env   )     ((op)->ops->get_input_msg (op, env))
 

Gets input message.

See also:
axis2_op_ops::get_input_msg

#define AXIS2_OP_GET_MSG op,
env,
label   )     ((op)->ops->get_msg(op, env, label))
 

Gets message corresponding to given label.

See also:
axis2_op_ops::get_msg

#define AXIS2_OP_GET_MSG_EXCHANGE_PATTERN op,
env   )     ((op)->ops->get_msg_exchange_pattern (op, env))
 

Gets message exchange pattern.

See also:
axis2_op_ops::get_msg_exchange_pattern

#define AXIS2_OP_GET_MSG_RECV op,
env   )     ((op)->ops->get_msg_recv (op, env))
 

Gets message receiver.

See also:
axis2_op_ops::get_msg_recv

#define AXIS2_OP_GET_OUT_FLOW op,
env   )     ((op)->ops->get_out_flow (op, env))
 

Gets out flow.

See also:
axis2_op_ops::get_out_flow

#define AXIS2_OP_GET_OUTPUT_MSG op,
env   )     ((op)->ops->get_output_msg (op, env))
 

Gets output message.

See also:
axis2_op_ops::get_output_msg

#define AXIS2_OP_GET_PARAM op,
env,
key   )     ((op)->ops->get_param (op, env, key))
 

Gets named parameter.

See also:
axis2_op_ops::get_param

#define AXIS2_OP_GET_PARENT op,
env   )     ((op)->ops->get_parent (op, env))
 

Gets parent service.

See also:
axis2_op_ops::get_parent

#define AXIS2_OP_GET_QNAME op,
env   )     (((axis2_op_t *) op)->ops->get_qname (op, env))
 

Gets QName.

See also:
axis2_op_ops::get_qname

#define AXIS2_OP_GET_STYLE op,
env   )     ((op)->ops->get_style (op, env))
 

Gets style of operation.

See also:
axis2_op_ops::get_style

#define AXIS2_OP_GET_TARGET_NAMESPACE op,
env   )     ((op)->ops->get_target_namespace (op, env))
 

Gets target namespace.

See also:
axis2_op_ops::get_target_namespace

#define AXIS2_OP_IS_PARAM_LOCKED op,
env,
param_name   )     ((op)->ops->is_param_locked(op, env, param_name))
 

Checks if the named parameter is locked.

See also:
axis2_op_ops::is_param_locked

#define AXIS2_OP_REGISTER_OP_CTX op,
env,
msg_ctx,
wsdl_op   )     ((op)->ops->register_op_ctx (op, env, msg_ctx, wsdl_op))
 

Registers given operation context against this operation.

See also:
axis2_op_ops::_register_op_ctx

#define AXIS2_OP_SET_FAULT_IN_FLOW op,
env,
list   )     ((op)->ops->set_fault_in_flow (op, env, list))
 

Sets fault in flow.

See also:
axis2_op_ops::set_fault_in_flow

#define AXIS2_OP_SET_FAULT_OUT_FLOW op,
env,
list   )     ((op)->ops->set_fault_out_flow (op, env, list))
 

Sets fault out flow.

See also:
axis2_op_ops::set_fault_out_flow

#define AXIS2_OP_SET_IN_FAULTS op,
env   )     ((op)->ops->set_in_faults (op, env, in_faults))
 

Sets in faults.

See also:
axis2_op_ops::set_in_faults

#define AXIS2_OP_SET_IN_FLOW op,
env,
list   )     ((op)->ops->set_in_flow (op, env, list))
 

Sets in flow.

See also:
axis2_op_ops::set_in_flow

#define AXIS2_OP_SET_INPUT_MSG op,
env   )     ((op)->ops->set_input_msg (op, env, input_msg))
 

Sets input message.

See also:
axis2_op_ops::set_input_msg

#define AXIS2_OP_SET_MSG_EXCHANGE_PATTERN op,
env,
msg_exchange_pattern   ) 
 

Value:

((op)->ops->set_msg_exchange_pattern (op, env, \
        msg_exchange_pattern))
Sets message exchange pattern.
See also:
axis2_op_ops::set_msg_exchange_pattern

#define AXIS2_OP_SET_MSG_RECV op,
env,
msg_recv   )     ((op)->ops->set_msg_recv (op, env, msg_recv))
 

Sets message receiver.

See also:
axis2_op_ops::set_msg_recv

#define AXIS2_OP_SET_OUT_FAULTS op,
env   )     ((op)->ops->set_out_faults (op, env, out_faults))
 

Sets out faults.

See also:
axis2_op_ops::set_out_faults

#define AXIS2_OP_SET_OUT_FLOW op,
env,
list   )     ((op)->ops->set_out_flow (op, env, list))
 

Sets out flow.

See also:
axis2_op_ops::set_out_flow

#define AXIS2_OP_SET_OUTPUT_MSG op,
env   )     ((op)->ops->set_output_msg (op, env, output_msg))
 

Sets output message.

See also:
axis2_op_ops::set_output_msg

#define AXIS2_OP_SET_PARENT op,
env,
service_desc   )     ((op)->ops->set_parent (op, env, service_desc))
 

Sets parent service.

See also:
axis2_op_ops::set_parent

#define AXIS2_OP_SET_QNAME op,
env,
qname   )     ((op)->ops->set_qname (op, env, qname))
 

Sets QName.

See also:
axis2_op_ops::set_qname

#define AXIS2_OP_SET_STYLE op,
env,
style   )     ((op)->ops->set_style (op, env, style))
 

Sets style of operation.

See also:
axis2_op_ops::set_style

#define AXIS2_OP_SET_WSDL_OP op,
env,
wsdl_op   )     ((op)->ops->set_wsdl_op (op, env, wsdl_op))
 

Sets wsdl operation.

See also:
axis2_op_ops::set_wsdl_op

#define AXIS2_SOAP_ACTION   "soapAction"
 

SOAP action string constant


Typedef Documentation

typedef struct axis2_op_ops axis2_op_ops_t
 

Type name for struct axis2_op_ops

typedef struct axis2_op axis2_op_t
 

Type name for struct axis2_op


Function Documentation

AXIS2_EXTERN axis2_op_t* axis2_op_create const axis2_env_t env  ) 
 

Creates operation struct.

Parameters:
env pointer to environment struct
Returns:
pointer to newly created operation

AXIS2_EXTERN axis2_op_t* axis2_op_create_with_qname const axis2_env_t env,
const axis2_qname_t *  name
 

Creates operation struct with given QName.

Parameters:
env pointer to environment struct
name pointer to QName
Returns:
pointer to newly created operation

AXIS2_EXTERN axis2_op_t* axis2_op_create_with_wsdl_op const axis2_env_t env,
struct axis2_wsdl_op *  wsdl_op
 

Creates operation struct with given WSDL operation as base.

Parameters:
env pointer to environment struct
wsdl_op pointer to WSDL operation
Returns:
pointer to newly created operation

AXIS2_EXTERN axis2_status_t axis2_op_free_void_arg void *  op,
const axis2_env_t env
 

Frees the operation given as a void pointer. This method would cast the void parameter to an operation pointer and then call free method.

Parameters:
pointer to operation as a void pointer
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE


Generated on Thu Aug 31 17:32:42 2006 for Axis2/C by  doxygen 1.4.6