ctgclient_esi.h File Reference
#include <time.h>
#include "ctgclient.h"

Go to the source code of this file.

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

◆ CICSCALL

Definition at line 51 of file ctgclient_esi.h.

◆ ESI_ERR_CICS_DIED

Communication with the target CICS server was interrupted during the request.

Definition at line 258 of file ctgclient_esi.h.

◆ ESI_ERR_MAX_SESSIONS

There are insufficient communication resources to complete the request.

Definition at line 291 of file ctgclient_esi.h.

◆ ESI_ERR_MAX_SYSTEMS

The CICS TG has reached its limit on the maximum number of CICS servers.

Definition at line 286 of file ctgclient_esi.h.

◆ ESI_ERR_NO_CICS

Communication with the target CICS server could not be established.

Definition at line 253 of file ctgclient_esi.h.

◆ ESI_ERR_NO_SESSIONS

There are insufficient communication resources to communicate with the target CICS server.

Definition at line 249 of file ctgclient_esi.h.

◆ ESI_ERR_NULL_NEW_PASSWORD

The value of the new password was NULL or an empty string.

Definition at line 276 of file ctgclient_esi.h.

◆ ESI_ERR_NULL_OLD_PASSWORD

The value of the old password was NULL or an empty string.

Definition at line 272 of file ctgclient_esi.h.

◆ ESI_ERR_NULL_PASSWORD

password is NULL or an empty string.

Definition at line 218 of file ctgclient_esi.h.

◆ ESI_ERR_NULL_USERID

userid is NULL or an empty string.

Definition at line 209 of file ctgclient_esi.h.

◆ ESI_ERR_PASSWORD_EXPIRED

The password for userid on the target CICS server has expired.

Definition at line 232 of file ctgclient_esi.h.

◆ ESI_ERR_PASSWORD_INVALID

password is not the current password or password phrase for userid on the target CICS server.

Definition at line 214 of file ctgclient_esi.h.

◆ ESI_ERR_PASSWORD_REJECTED

The new password does not conform to the standards defined for the External Security Manager of the target CICS server.

Definition at line 281 of file ctgclient_esi.h.

◆ ESI_ERR_PEM_NOT_ACTIVE

Password Expiry Management has been disabled on the target CICS server.

Definition at line 228 of file ctgclient_esi.h.

◆ ESI_ERR_PEM_NOT_SUPPORTED

The protocol used to communicate with the target CICS server does not support Password Expiry Management.

Definition at line 223 of file ctgclient_esi.h.

◆ ESI_ERR_RESOURCE_SHORTAGE

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 244 of file ctgclient_esi.h.

◆ ESI_ERR_SECURITY_ERROR

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 238 of file ctgclient_esi.h.

◆ ESI_ERR_SYSTEM_ERROR

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 268 of file ctgclient_esi.h.

◆ ESI_ERR_UNKNOWN_SERVER

The target CICS server is unknown to the Gateway daemon.

Definition at line 262 of file ctgclient_esi.h.

◆ ESI_ERR_USERID_INVALID

userid is rejected as invalid by the target CICS server.

Definition at line 205 of file ctgclient_esi.h.

◆ ESI_NO_ERROR

No error.

Definition at line 201 of file ctgclient_esi.h.

◆ ESI_SERVER_LENGTH

The maximum length of a server name.

Definition at line 109 of file ctgclient_esi.h.

Function Documentation

◆ CTG_ESI_changePassword()

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
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.

◆ CTG_ESI_convertTime()

Converts a supplied ESI_DATETIME structure into a tm structure.

The tm structure is defined by time.h

Parameters
Returns
The pointer supplied in result.

◆ CTG_ESI_verifyPassword()

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
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.