Go to the source code of this file.
Data Structures | |
struct | ESI_DATETIME |
The ESI_DATETIME structure contains the component parts for a date and time returned as part of the meta-data returned from an ESI request. More... | |
struct | ESI_DETAILS |
The ESI_DETAILS structure contains the meta-data returned from an ESI call. More... | |
Macros | |
#define | CICSCALL |
#define | ESI_SERVER_LENGTH 8 |
#define | ESI_NO_ERROR 0 |
#define | ESI_ERR_USERID_INVALID -300 |
#define | ESI_ERR_NULL_USERID -301 |
#define | ESI_ERR_PASSWORD_INVALID -302 |
#define | ESI_ERR_NULL_PASSWORD -303 |
#define | ESI_ERR_PEM_NOT_SUPPORTED -304 |
#define | ESI_ERR_PEM_NOT_ACTIVE -305 |
#define | ESI_ERR_PASSWORD_EXPIRED -306 |
#define | ESI_ERR_SECURITY_ERROR -307 |
#define | ESI_ERR_RESOURCE_SHORTAGE -308 |
#define | ESI_ERR_NO_SESSIONS -309 |
#define | ESI_ERR_NO_CICS -310 |
#define | ESI_ERR_CICS_DIED -311 |
#define | ESI_ERR_UNKNOWN_SERVER -312 |
#define | ESI_ERR_SYSTEM_ERROR -313 |
#define | ESI_ERR_NULL_OLD_PASSWORD ESI_ERR_NULL_PASSWORD |
#define | ESI_ERR_NULL_NEW_PASSWORD -314 |
#define | ESI_ERR_PASSWORD_REJECTED -315 |
#define | ESI_ERR_MAX_SYSTEMS -316 |
#define | ESI_ERR_MAX_SESSIONS -317 |
Functions | |
int | CTG_ESI_verifyPassword (CTG_ConnToken_t gwTok, const char *userid, const char *password, const char *server, ESI_DETAILS *esiDetailsPtr) |
int | CTG_ESI_changePassword (CTG_ConnToken_t gwTok, const char *userid, const char *oldPassword, const char *newPassword, const char *server, ESI_DETAILS *esiDetailsPtr) |
struct tm * | CTG_ESI_convertTime (const ESI_DATETIME *esiTime, struct tm *result) |
Detailed Description
Defines functions and typedefs for sending External Security Interface (ESI) requests to a Gateway daemon.
Definition in file ctgclient_esi.h.
Macro Definition Documentation
#define CICSCALL |
Definition at line 56 of file ctgclient_esi.h.
#define ESI_ERR_CICS_DIED -311 |
Communication with the target CICS server was interrupted during the request.
Definition at line 261 of file ctgclient_esi.h.
#define ESI_ERR_MAX_SESSIONS -317 |
There are insufficient communication resources to complete the request.
Definition at line 294 of file ctgclient_esi.h.
#define ESI_ERR_MAX_SYSTEMS -316 |
The CICS TG has reached its limit on the maximum number of CICS servers.
Definition at line 289 of file ctgclient_esi.h.
#define ESI_ERR_NO_CICS -310 |
Communication with the target CICS server could not be established.
Definition at line 256 of file ctgclient_esi.h.
#define ESI_ERR_NO_SESSIONS -309 |
There are insufficient communication resources to communicate with the target CICS server.
Definition at line 252 of file ctgclient_esi.h.
#define ESI_ERR_NULL_NEW_PASSWORD -314 |
The value of the new password was NULL or an empty string.
Definition at line 279 of file ctgclient_esi.h.
#define ESI_ERR_NULL_OLD_PASSWORD ESI_ERR_NULL_PASSWORD |
The value of the old password was NULL or an empty string.
Definition at line 275 of file ctgclient_esi.h.
#define ESI_ERR_NULL_PASSWORD -303 |
password is NULL or an empty string.
Definition at line 221 of file ctgclient_esi.h.
#define ESI_ERR_NULL_USERID -301 |
userid is NULL or an empty string.
Definition at line 212 of file ctgclient_esi.h.
#define ESI_ERR_PASSWORD_EXPIRED -306 |
The password for userid on the target CICS server has expired.
Definition at line 235 of file ctgclient_esi.h.
#define ESI_ERR_PASSWORD_INVALID -302 |
password is not the current password or password phrase for userid on the target CICS server.
Definition at line 217 of file ctgclient_esi.h.
#define ESI_ERR_PASSWORD_REJECTED -315 |
The new password does not conform to the standards defined for the External Security Manager of the target CICS server.
Definition at line 284 of file ctgclient_esi.h.
#define ESI_ERR_PEM_NOT_ACTIVE -305 |
Password Expiry Management has been disabled on the target CICS server.
Definition at line 231 of file ctgclient_esi.h.
#define ESI_ERR_PEM_NOT_SUPPORTED -304 |
The protocol used to communicate with the target CICS server does not support Password Expiry Management.
Definition at line 226 of file ctgclient_esi.h.
#define ESI_ERR_RESOURCE_SHORTAGE -308 |
There are insufficient resources to communicate with the target CICS server; details might be available in the CICS TG error log files.
Definition at line 247 of file ctgclient_esi.h.
#define ESI_ERR_SECURITY_ERROR -307 |
An error was detected by the External Security Manager.
This could be because the user ID has been revoked or the CICS server is not configured to communicate with the External Security Manager.
Definition at line 241 of file ctgclient_esi.h.
#define ESI_ERR_SYSTEM_ERROR -313 |
An internal system error has occurred.
If the problem persists, collect application and Gateway daemon trace and contact your IBM service representative.
Definition at line 271 of file ctgclient_esi.h.
#define ESI_ERR_UNKNOWN_SERVER -312 |
The target CICS server is unknown to the Gateway daemon.
Definition at line 265 of file ctgclient_esi.h.
#define ESI_ERR_USERID_INVALID -300 |
userid is rejected as invalid by the target CICS server.
Definition at line 208 of file ctgclient_esi.h.
#define ESI_NO_ERROR 0 |
No error.
Definition at line 204 of file ctgclient_esi.h.
#define ESI_SERVER_LENGTH 8 |
The maximum length of a server name.
Definition at line 114 of file ctgclient_esi.h.
Function Documentation
int CTG_ESI_changePassword | ( | CTG_ConnToken_t | gwTok, |
const char * | userid, | ||
const char * | oldPassword, | ||
const char * | newPassword, | ||
const char * | server, | ||
ESI_DETAILS * | esiDetailsPtr | ||
) |
Sends an ESI request to the Gateway to change the password or password phrase for the given user ID and then waits for the reply.
The reply is returned in the ESI_DETAILS structure.
- Parameters
-
[in] gwTok The reference to the open Gateway connection. [in] userid The User ID to verify in the CICS server. [in] oldPassword The current password or password phrase for the supplied User ID. [in] newPassword The new password or password phrase for the supplied User ID. [in] server The name of the CICS server the request should be sent to. [out] esiDetailsPtr A pointer to an ESI_DETAILS structure.
- Returns
- An integer value identifies whether the call was successful or not.
Possible values include Other possible values are all of the documented ESI return codes.
|
read |
Converts a supplied ESI_DATETIME structure into a tm structure.
The tm structure is defined by time.h
- Parameters
-
[in] esiTime A pointer to an ESI_Details structure. [out] result A pointer to a tm structure.
- Returns
- The pointer supplied in result.
int CTG_ESI_verifyPassword | ( | CTG_ConnToken_t | gwTok, |
const char * | userid, | ||
const char * | password, | ||
const char * | server, | ||
ESI_DETAILS * | esiDetailsPtr | ||
) |
Sends an ESI request to the Gateway to verify a User ID and password or password phrase and then waits for the reply.
The reply is returned in the ESI_DETAILS structure.
- Parameters
-
[in] gwTok The reference to the open Gateway connection. [in] userid The User ID to verify in the CICS server. [in] password The password or password phrase for the supplied User ID. [in] server The name of the CICS server the request should be sent to. [out] esiDetailsPtr A pointer to an ESI_DETAILS structure.
- Returns
- An integer value identifies whether the call was successful or not.
Possible values include Other possible values are all of the documented ESI return codes.