axis2_endpoint_ref_ops Struct Reference
[endpoint reference]

#include <axis2_endpoint_ref.h>

List of all members.

Public Attributes

const axis2_char_t *(* get_address )(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)
axis2_status_t(* set_address )(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, const axis2_char_t *address)
const axis2_qname_t *(* get_interface_qname )(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)
axis2_status_t(* set_interface_qname )(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, const axis2_qname_t *interface_qname)
axis2_array_list_t *(* get_ref_param_list )(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)
axis2_array_list_t *(* get_metadata_list )(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)
axis2_array_list_t *(* get_ref_attribute_list )(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)
axis2_array_list_t *(* get_metadata_attribute_list )(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)
axis2_array_list_t *(* get_extension_list )(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)
axis2_status_t(* add_ref_param )(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, axiom_node_t *ref_param_node)
axis2_status_t(* add_metadata )(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, axiom_node_t *metadata_node)
axis2_status_t(* add_ref_attribute )(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, axiom_attribute_t *attr)
axis2_status_t(* add_metadata_attribute )(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, axiom_attribute_t *attr)
axis2_status_t(* add_extension )(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, axiom_node_t *extension_node)
axis2_svc_name_t *(* get_svc_name )(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)
axis2_status_t(* set_svc_name )(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, axis2_svc_name_t *svc_name)
axis2_status_t(* free )(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)


Detailed Description

endpoint reference ops struct. Encapsulator struct for operations of axis2_endpoint_ref.


Member Data Documentation

axis2_status_t( * axis2_endpoint_ref_ops::add_extension)(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, axiom_node_t *extension_node)

Adds an extension in the form of an AXIOM node.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
extension_node pointer to AXIOM node representing extension, endpoint reference does not assume the ownership of the node
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_endpoint_ref_ops::add_metadata)(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, axiom_node_t *metadata_node)

Adds metadata in the form of an AXIOM node. An endpoint can have different associated metadata such as WSDL, XML Schema and WS-Policy policies.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
metadata_node AXIOM node representing metadata, endpoint reference does not assume the ownership of the node
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_endpoint_ref_ops::add_metadata_attribute)(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, axiom_attribute_t *attr)

Adds a meta attribute in the form of an AXIOM attribute.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
attr AXIOM attribute representing meta attribute, endpoint reference does not assume the ownership of the attribute
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_endpoint_ref_ops::add_ref_attribute)(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, axiom_attribute_t *attr)

Adds a reference attribute in the form of an AXIOM attribute.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
attr AXIOM attribute representing reference attribute, endpoint reference does not assume the ownership of the attribute
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_endpoint_ref_ops::add_ref_param)(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, axiom_node_t *ref_param_node)

Adds a reference parameter in the form of an AXIOM node.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
ref_param_node pointer to AXIOM node representing reference parameter, endpoint reference does not assume the ownership of the node
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_endpoint_ref_ops::free)(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)

Frees endpoint reference struct.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

const axis2_char_t*( * axis2_endpoint_ref_ops::get_address)(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)

Gets endpoint address. Address URI identifies the endpoint. This may be a network address or a logical address.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
Returns:
endpoint address string

axis2_array_list_t*( * axis2_endpoint_ref_ops::get_extension_list)(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)

Gets the list of extensions. Extensions are a mechanism to allow additional elements to be specified in association with the endpoint.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
Returns:
pointer to array list containing extensions, returns a reference, not a cloned copy

const axis2_qname_t*( * axis2_endpoint_ref_ops::get_interface_qname)(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)

Gets interface QName. QName represents the primary portType of the endpoint being conveyed.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
Returns:
pointer to interface QName, returns a reference, not a cloned copy

axis2_array_list_t*( * axis2_endpoint_ref_ops::get_metadata_attribute_list)(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)

Gets the list of metadata attributes.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
Returns:
pointer to array list containing metadata attributes, returns a reference, not a cloned copy

axis2_array_list_t*( * axis2_endpoint_ref_ops::get_metadata_list)(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)

Gets the list of metadata. An endpoint can have different associated metadata such as WSDL, XML Schema, and WS-Policy policies.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
Returns:
pointer to array list containing metadata, returns a reference, not a cloned copy

axis2_array_list_t*( * axis2_endpoint_ref_ops::get_ref_attribute_list)(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)

Gets the list of reference attributes.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
Returns:
pointer to array list containing reference attributes, returns a reference, not a cloned copy

axis2_array_list_t*( * axis2_endpoint_ref_ops::get_ref_param_list)(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)

Gets reference parameter list. A reference may contain a number of individual parameters which are associated with the endpoint to facilitate a particular interaction. Reference parameters are element information items that are named by QName and are required to properly interact with the endpoint.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
Returns:
pointer to array list containing all reference parameters, returns a reference, not a cloned copy

axis2_svc_name_t*( * axis2_endpoint_ref_ops::get_svc_name)(const axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env)

Gets service name. An endpoint in WS-Addressing has a QName identifying the WSDL service element that contains the definition of the endpoint being conveyed. The service name provides a link to a full description of the service endpoint.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
Returns:
pointer to service name struct, returns a reference, not a cloned copy

axis2_status_t( * axis2_endpoint_ref_ops::set_address)(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, const axis2_char_t *address)

Sets endpoint address. Address URI identifies the endpoint. This may be a network address or a logical address.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
address address string
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_endpoint_ref_ops::set_interface_qname)(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, const axis2_qname_t *interface_qname)

Sets interface QName. QName represents the primary portType of the endpoint being conveyed.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
interface_name pointer to interface QName, this method creates a clone of the QName
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_endpoint_ref_ops::set_svc_name)(axis2_endpoint_ref_t *endpoint_ref, const axis2_env_t *env, axis2_svc_name_t *svc_name)

Sets service name. An endpoint in WS-Addressing has a QName identifying the WSDL service element that contains the definition of the endpoint being conveyed. The service name provides a link to a full description of the service endpoint.

Parameters:
endpoint_ref pointer to endpoint reference struct
env pointer to environment struct
svc_name pointer to service name struct, endpoint 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