Grid Community Toolkit
6.2.1541705016
|
Macros | |
#define | GLOBUS_GRAM_CLIENT_NO_ATTR |
Default GRAM client operation attribute. More... | |
Typedefs | |
typedef void * | globus_gram_client_attr_t |
GRAM client operation attribute. More... | |
Functions | |
int | globus_gram_client_attr_init (globus_gram_client_attr_t *attr) |
Initialize a GRAM client attribute. More... | |
int | globus_gram_client_attr_destroy (globus_gram_client_attr_t *attr) |
Destroy a GRAM client attribute. More... | |
int | globus_gram_client_attr_set_credential (globus_gram_client_attr_t attr, gss_cred_id_t credential) |
Set a GRAM client attribute's security credential. More... | |
int | globus_gram_client_attr_get_credential (globus_gram_client_attr_t attr, gss_cred_id_t *credential) |
Get a GRAM client attribute's security credential. More... | |
int | globus_gram_client_attr_set_delegation_mode (globus_gram_client_attr_t attr, globus_io_secure_delegation_mode_t mode) |
Set a GRAM client attribute's delegation mode. More... | |
int | globus_gram_client_attr_get_delegation_mode (globus_gram_client_attr_t attr, globus_io_secure_delegation_mode_t *mode) |
Get a GRAM client attribute's security credential. More... | |
#define GLOBUS_GRAM_CLIENT_NO_ATTR |
Default GRAM client operation attribute.
The GLOBUS_GRAM_CLIENT_NO_ATTR macro defines a constant for use when a user of the GRAM client API does not want to specify any non-default GRAM attributes.
typedef void* globus_gram_client_attr_t |
GRAM client operation attribute.
The globus_gram_client_attr_t type is an opaque type describing GRAM attributes. It can be accessed or modified by functions in the GRAM Client Attribute Functions documentation.
int globus_gram_client_attr_destroy | ( | globus_gram_client_attr_t * | attr | ) |
Destroy a GRAM client attribute.
The globus_gram_client_attr_destroy() function destroys and frees a GRAM client attribute. After this function returns, the value pointed to by attr is no longer valid and must not be used.
attr | A pointer to the attribute to destroy. All data associated with the attribute will be freed and it will be an invalid attribute. |
GLOBUS_SUCCESS | Success |
GLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR | Invalid attribute |
int globus_gram_client_attr_get_credential | ( | globus_gram_client_attr_t | attr, |
gss_cred_id_t * | credential | ||
) |
Get a GRAM client attribute's security credential.
The globus_gram_client_attr_get_credential() function gets the value of the credential in an attribute and modifies the credential parameter to point to it. This is a shallow copy.
attr | The attribute set to query for its credential. |
credential | An output parameter that will be initialized to point to the GSSAPI credential which the attr is currently using. |
GLOBUS_SUCCESS | Success |
GLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR | Invalid attribute |
GLOBUS_GRAM_PROTOCOL_ERROR_NULL_PARAMETER | Null parameter |
int globus_gram_client_attr_get_delegation_mode | ( | globus_gram_client_attr_t | attr, |
globus_io_secure_delegation_mode_t * | mode | ||
) |
Get a GRAM client attribute's security credential.
The globus_gram_client_attr_get_delegation_mode() function gets the value of the delegation_mode in an attribute and modifies the mode parameter to point to its value.
attr | The attribute set to query for its delegation_mode. |
mode | An output parameter that will be set to point to the delegation mode which the attr is currently using. |
GLOBUS_SUCCESS | Success |
GLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR | Invalid attribute |
GLOBUS_GRAM_PROTOCOL_ERROR_NULL_PARAMETER | Null parameter |
int globus_gram_client_attr_init | ( | globus_gram_client_attr_t * | attr | ) |
Initialize a GRAM client attribute.
The globus_gram_client_attr_init() function creates a new opaque structure that can be used to specify custom attributes for performing GRAM client operations.
attr | An output parameter which will be set to the newly initialized attribute. |
GLOBUS_SUCCESS | Success |
GLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR | Invalid attribute |
GLOBUS_GRAM_PROTOCOL_ERROR_MALLOC_FAILED | Out of memory |
int globus_gram_client_attr_set_credential | ( | globus_gram_client_attr_t | attr, |
gss_cred_id_t | credential | ||
) |
Set a GRAM client attribute's security credential.
The globus_gram_client_attr_set_credential() function sets the value of the credential in an attribute to the GSSAPI credential named by the credential parameter. This is done as a shallow copy, so the value of credential must not be freed until the attribute will no longer be used.
attr | The attribute set to modify to use the credential named by the credential parameter. |
credential | The GSSAPI credential to use with the attribute named by the attr parameter. This may be GSS_C_NO_CREDENTIAL to set the attribute to use the default security credential. |
GLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR | An invalid attribute set was passed to this function. |
int globus_gram_client_attr_set_delegation_mode | ( | globus_gram_client_attr_t | attr, |
globus_io_secure_delegation_mode_t | mode | ||
) |
Set a GRAM client attribute's delegation mode.
The globus_gram_client_attr_set_delegation_mode() function sets the value of the delegation_mode in an attribute to the delegation mode in the mode parameter.
The GRAM client supports the following delegation modes:
attr | The attribute set to modify to use the delegation mode in the mode parameter. |
mode | The new value of the delegation mode. |
GLOBUS_SUCCESS | Success |
GLOBUS_GRAM_PROTOCOL_ERROR_INVALID_ATTR | Invalid attribute |