SOAP Message Attributes

Defines

Typedefs

Enumerations

Functions

Define Documentation

#define GLOBUS_SOAP_MESSAGE_SERVICE_ENDPOINT_KEY

Service Endpoint.

This attribute is of type char *. It contains path used to invoke the service. Services should not modify its value.

#define GLOBUS_SOAP_MESSAGE_SOAP_ACTION_KEY

SOAP Action.

This attribute is of type char * and is populated with the SOAPAction of the operation being invoked.

#define GLOBUS_SOAP_MESSAGE_HTTP_VERSION_KEY

HTTP Version.

This attribute is of type char * and is the HTTP Version to use for transporting SOAP messages. Legal values are "1.0" and "1.1".

#define GLOBUS_SOAP_MESSAGE_AUTHENTICATION_METHOD_KEY

Authentication Method.

This attribute is of type globus_soap_message_auth_method_t.

#define GLOBUS_SOAP_MESSAGE_USER_CREDENTIAL_KEY

User Credential.

This attribute is of type gss_cred_id_t *.

#define GLOBUS_SOAP_MESSAGE_AUTH_PROTECTION_KEY

Message protection mode.

This attribute is of type globus_soap_message_auth_protection_level_t.

#define GLOBUS_SOAP_MESSAGE_AUTHZ_METHOD_KEY

Authorization method

This attribute is of type globus_soap_message_authz_method_t.

#define GLOBUS_SOAP_MESSAGE_AUTH_ANONYMOUS_KEY

Anonymous authentication.

This attribute is of type globus_bool_t. The default, if this attribute is not present, or its value is GLOBUS_FALSE, is to use the current user's security credentials when authenticating with the service. If set to GLOBUS_TRUE, then anonymous authentication will be used.

#define GLOBUS_SOAP_MESSAGE_CONNECTION_KEY

Connection close.

This attribute is of type char *. If not present, or its value is not "close", then persistent TCP connections will be used on a message handle. If its value is "close", then the TCP connection will be closed after the HTTP request/reply protocol has completed for a SOAP message.

#define GLOBUS_SOAP_MESSAGE_VERBOSE_ERRORS_KEY

Verbose errors.

This attribute is of type int. If not present, or its value is zero, then constant error results indicating the failure type will be returned when a parsing error occurs. Otherwise, detailed error objects will be created.

#define GLOBUS_SOAP_MESSAGE_PEER_IDENTITY_KEY

Peer Identity.

This attribute is of type gss_name_t

#define GLOBUS_SOAP_MESSAGE_LOGGER_KEY

Logging module.

This attribute is of type globus_logging_module_t *

#define GLOBUS_SOAP_MESSAGE_RETRY_ON_DROP_KEY

Retry Persistent Connections.

This attribute is of type globus_bool_t When set to GLOBUS_TRUE on a soap message handle, if an SOAP message fails while a persistent connection is being reused and the message was not acknowleged by the server, retry sending the message.

Typedef Documentation

typedef globus_hashtable_t globus_soap_message_attr_t

SOAP Message Attribute Type.

typedef globus_result_t(* globus_soap_message_attr_copy_func_t)(void **new_attr, const void *attr)

Attribute value copy function type.

typedef globus_hashtable_destructor_func_t globus_soap_message_attr_destroy_func_t

Attribute value destructor function type.

Enumeration Type Documentation

enum globus_soap_message_auth_method_t

Authentication method types

SOAP operations transported over HTTP may use different authentication methods.

This type is used as the value of the GLOBUS_SOAP_MESSAGE_AUTHENTICATION_METHOD_KEY attribute to indicate which is used.

Note:
The GLOBUS_SOAP_MESSAGE_AUTH_SECURE_CONVERSATION method is currently not implemented.
See also:
GLOBUS_SOAP_MESSAGE_AUTHENTICATION_METHOD_KEY
Enumerator:
GLOBUS_SOAP_MESSAGE_AUTH_NONE  Use no authentication.
GLOBUS_SOAP_MESSAGE_AUTH_SECURE  Depending on the transport, use either TLS or WS-Secure Message to authenticate SOAP messages.
GLOBUS_SOAP_MESSAGE_AUTH_SECURE_MESSAGE  Use WS-Secure Message to authenticate SOAP messages.
GLOBUS_SOAP_MESSAGE_AUTH_SECURE_CONVERSATION  Use WS-Secure Conversation to authenticate SOAP messages.

Note:
This is not currently implemented.

enum globus_soap_message_auth_protection_level_t

SOAP protection types

SOAP operations transported over HTTP with TLS may use different protection levels.

This type is used as the value of the GLOBUS_SOAP_MESSAGE_AUTH_PROTECTION_KEY attribute to indicate which is used.

See also:
GLOBUS_SOAP_MESSAGE_AUTH_PROTECTION_KEY
Enumerator:
GLOBUS_SOAP_MESSAGE_AUTH_PROTECTION_NOT_SET  Use the default protection level.
GLOBUS_SOAP_MESSAGE_AUTH_PROTECTION_INTEGRITY  Use integrity protection (secure message hashing).
GLOBUS_SOAP_MESSAGE_AUTH_PROTECTION_PRIVACY  Use privacy protection (encryption).

enum globus_soap_message_authz_method_t

SOAP authorization types

SOAP operations may use different authorization methods.

This type is used as the value of the GLOBUS_SOAP_MESSAGE_AUTHZ_METHOD_KEY attribute to indicate which is used.

See also:
GLOBUS_SOAP_MESSAGE_AUTHZ_METHOD_KEY
Enumerator:
GLOBUS_SOAP_MESSAGE_AUTHZ_HOST_SELF  Host or self authorization---allow peers with the same security subject name or whose subject matches their host name.
GLOBUS_SOAP_MESSAGE_AUTHZ_IDENTITY  Do no subject-based authorization.

Identity authorization---only allow peers with an explicitly named subject name.

GLOBUS_SOAP_MESSAGE_AUTHZ_HOST  Host authorization---only allow peers whose subject matches their host name.
GLOBUS_SOAP_MESSAGE_AUTHZ_SELF  Self authorization---only allow peers with the same security subject name.

Function Documentation

globus_result_t globus_soap_message_attr_init ( globus_soap_message_attr_t *  attrs  ) 

Initialize a new SOAP Message Attribute Set.

Parameters:
attrs New attribute set to initialize.
Return values:
GLOBUS_SUCCESS Attributes successfully initialized.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM The attrs parameter was NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY Insufficient memory to initialize the attributes.

globus_result_t globus_soap_message_attr_copy ( globus_soap_message_attr_t *  copied_attrs,
globus_soap_message_attr_t  attrs 
)

Copy the contents of a SOAP Message Attribute Set to a new Attribute Set.

Parameters:
copied_attrs Attribute set to be initialized to contain the same attributes as attrs.
attrs Attribute set to copy.
Return values:
GLOBUS_SUCCESS Attributes successfully copied.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM The copied_attrs or attrs parameter was NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY Insufficient memory to copy the attributes.

void globus_soap_message_attr_destroy ( globus_soap_message_attr_t  attrs  ) 

Destroy a SOAP Message Attribute Set.

Parameters:
attrs Attribute set to destroy.

globus_result_t globus_soap_message_attr_set ( globus_soap_message_attr_t  attrs,
const char *  name,
globus_soap_message_attr_copy_func_t  copy,
globus_soap_message_attr_destroy_func_t  destroy,
void *  attrvalue 
)

Set the value of an attribute.

Parameters:
attrs Attribute set to modify.
name Name of the attribute to set.
copy Function to make a copy of the attribute value. If this is NULL, then the attribute value will be treated as a scalar.
destroy Function to destroy a copy of the attribute value. This may be NULL if the attribute value is a scalar.
attrvalue Value to set the attribute to.
Return values:
GLOBUS_SUCCESS Attributes successfully set.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM The attrs or name parameter was NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY Insufficient memory to set the attribute.

globus_result_t globus_soap_message_handle_set_attr ( globus_soap_message_handle_t  handle,
const char *  attr_name,
globus_soap_message_attr_copy_func_t  copy,
globus_soap_message_attr_destroy_func_t  destroy,
void *  attrvalue 
)

Set the value of an attribute on a handle

Adds or changes the value of a SOAP attribute on a SOAP message handle.

Parameters:
handle Handle whose attributes will be modified.
attr_name Name of the attribute to set.
copy Function to make a copy of the attribute value. If this is NULL, then the attribute value will be treated as a scalar.
destroy Function to destroy a copy of the attribute value. This may be NULL if the attribute value is a scalar.
attrvalue Value to set the attribute to.
Return values:
GLOBUS_SUCCESS Attributes successfully set.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM The handle or name parameter was NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY Insufficient memory to set the attribute.

void* globus_soap_message_attr_remove ( globus_soap_message_attr_t  attrs,
const char *  attr_name 
)

Remove an attribute from an attribute set.

Parameters:
attrs Attribute set to modify.
attr_name Name of the attribute to remove from the attribute set. Its current value will be returned.
Returns:
Returns the current value of the named attribute. This value is not managed by the handle and should be freed by the caller if it is a non-scalar value.

void* globus_soap_message_handle_remove_attr ( globus_soap_message_handle_t  handle,
const char *  attr_name 
)

Remove an attribute from a handle's attribute set.

Parameters:
handle Handle to modify.
attr_name Name of the attribute to remove from the handle's attribute set. Its current value will be returned.
Returns:
Returns the current value of the named attribute. This value is not managed by the handle and should be freed by the caller if it is a non-scalar value.

void* globus_soap_message_attr_get ( globus_soap_message_attr_t  attrs,
const char *  attr_name 
)

Get the current value of a SOAP message attribute.

Parameters:
attrs Attribute set to query.
attr_name Name of the attribute to retrieve.
Returns:
Returns the current value of the named attribute. This value is managed by the handle and should not be freed or modified by the caller.

void* globus_soap_message_handle_get_attr ( globus_soap_message_handle_t  handle,
char *  attr_name 
)

Get the current value of a SOAP message attribute from a handle.

Parameters:
handle Handle to query.
attr_name Name of the attribute to retrieve.
Returns:
Returns the current value of the named attribute. This value is managed by the handle and should not be freed or modified by the caller.

globus_result_t globus_soap_message_handle_set_attrs ( globus_soap_message_handle_t  handle,
globus_soap_message_attr_t  attrs 
)

Copy a SOAP message attribute set to a handle

Replaces all of the attributes in an SOAP message handle with those in the given attribute set.

Parameters:
handle Handle to modify. If this function is successfull, all attributes set on the handle will be freed and a copy of the attributes in attrs will be set on the handle.
attrs New attributes to set on the handle.
Return values:
GLOBUS_SUCCESS Attributes successfully set.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM The handle or attrs parameter was NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY Insufficient memory to copy the attributes.

globus_result_t globus_soap_message_attr_copy_string ( void **  new_str,
const void *  str 
)

String copy wrapper for SOAP Message Attributes

A version of strdup which matches the globus_soap_message_attr_copy_func_t function signature.

Parameters:
new_str 
str 
Return values:
GLOBUS_SUCCESS String successfully copied.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_NULL_PARAM The new_str or str parameter was NULL.
GLOBUS_SOAP_MESSAGE_ERROR_TYPE_OUT_OF_MEMORY Insufficient memory to copy the string.

about globus | grid research | globus toolkit | software development

Comments? webmaster@globus.org