|
CICS® Transaction Gateway Programming Reference v1.1.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.ctg.client.GatewayRequest
com.ibm.ctg.client.ESIRequest
public class ESIRequest
This class contains the details of an ESI request to the CICS Transaction Gateway. To execute the request, the ESIRequest object should be flowed to the Gateway using the JavaGateway.flow method
GatewayRequest
Field Summary | |
---|---|
static int |
ESI_CHANGE_PASSWORD
Call type for change password request. |
static int |
ESI_PASSWORD_MAX
Maximum number of characters for password. |
static int |
ESI_SYSTEM_MAX
Maximum number of characters for server. |
static int |
ESI_USERID_MAX
Maximum number of characters for user ID. |
static int |
ESI_VERIFY_PASSWORD
Call type for verify password request. |
Constructor Summary | |
---|---|
ESIRequest()
Default constructor, this leaves all the values set to their defaults. |
Method Summary | |
---|---|
void |
changePassword()
Sets the ESI request object to be a Change Password Request. |
static ESIRequest |
changePassword(java.lang.String strUserid,
java.lang.String strCurrentPassword,
java.lang.String strNewPassword,
java.lang.String strServer)
This method returns a new ESI Request object which can be used to invoke a changePassword request. |
int |
getCallType()
This method returns the Call_Type field of this ESIRequest object. |
java.lang.String |
getCallTypeString()
This method returns a String describing the Call_Type field of this ESIRequest object. |
int |
getCicsRc()
Gets the CICS return code set in this object. |
java.lang.String |
getCicsRcString()
Gets the CICS return code set in this object and returns it as a String. |
java.lang.String |
getCurrentPassword()
This method returns a String of the current password defined. |
java.util.Calendar |
getExpiry()
This method returns a java.util.Calendar object containing the date/time of when the user ID/password will expire on the server. |
int |
getInvalidCount()
This method returns a int containing the number of invalid password attempts for that user ID on the specified server. |
java.util.Calendar |
getLastAccess()
This method returns a java.util.Calendar object containing the date/time of when the user ID/password was last accessed on the server. |
java.util.Calendar |
getLastVerified()
This method returns a java.util.Calendar object containing the date/time of when the user ID/password was last verified on the server. |
java.lang.String |
getNewPassword()
This method returns a String of the new password defined. |
int |
getRc()
Gets the return code set in this object. |
java.lang.String |
getRcString()
Gets the return code set in this object and return it as a string. |
java.lang.String |
getServer()
This method returns a String of the server defined. |
java.lang.String |
getUserid()
This method returns a String of the current user ID defined. |
void |
setCurrentPassword(java.lang.String strPassword)
Set the current password for this object. |
void |
setNewPassword(java.lang.String strPassword)
Set the new password for this object. |
void |
setServer(java.lang.String strServer)
Sets the server to be used for this object. |
void |
setUserid(java.lang.String strUserid)
Set the user ID for this object. |
void |
verifyPassword()
Sets the ESI request object to be a Verify Password Request. |
static ESIRequest |
verifyPassword(java.lang.String strUserid,
java.lang.String strCurrentPassword,
java.lang.String strServer)
This method returns a new ESI Request object which can be used to invoke a verifyPassword request. |
Methods inherited from class com.ibm.ctg.client.GatewayRequest |
---|
getGatewayRc, getGatewayRcString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ESI_USERID_MAX
public static final int ESI_PASSWORD_MAX
public static final int ESI_SYSTEM_MAX
public static final int ESI_VERIFY_PASSWORD
public static final int ESI_CHANGE_PASSWORD
Constructor Detail |
---|
public ESIRequest()
You will need to use the various setter methods to define the required parameters for the type of call you require.
Method Detail |
---|
public java.lang.String getUserid()
public java.lang.String getCurrentPassword()
public java.lang.String getNewPassword()
changePassword()
call.
public java.lang.String getServer()
public java.util.Calendar getLastVerified()
public java.util.Calendar getExpiry()
public java.util.Calendar getLastAccess()
public int getInvalidCount()
public int getRc()
public java.lang.String getRcString()
public int getCicsRc()
public java.lang.String getCicsRcString()
The String returned is the name of the appropriate Java constant e.g. if the Cics_Rc is ESI_NO_ERROR, then the String returned will be "ESI_NO_ERROR". If the Cics_Rc is unknown then the String returned will be "ESI_UNKNOWN_CICS_RC".
NOTE: for CICS return codes that may have more than one meaning the String returned is a concatenation of the return codes. The two concatenated Strings are: ESI_ERR_NULL_OLD_PASSWORD_OR_ESI_ERR_NULL_PASSWORD.
public int getCallType()
public java.lang.String getCallTypeString()
The String returned is the name of the appropriate Java constant either ESI_VERIFY_PASSWORD or ESI_CHANGE_PASSWORD
public void setUserid(java.lang.String strUserid) throws java.lang.IllegalArgumentException
strUserid
- String The user ID
java.lang.IllegalArgumentException
- if the parameter value is
greater than 10 characterspublic void setCurrentPassword(java.lang.String strPassword) throws java.lang.IllegalArgumentException
strPassword
- String The current password
java.lang.IllegalArgumentException
- if the parameter value is
greater than 10 characterspublic void setNewPassword(java.lang.String strPassword) throws java.lang.IllegalArgumentException
strPassword
- String The new password
java.lang.IllegalArgumentException
- if the parameter value is
greater than 10 characterspublic void setServer(java.lang.String strServer) throws java.lang.IllegalArgumentException
strServer
- String The server
java.lang.IllegalArgumentException
- if the parameter value is
greater than 8 characterspublic void verifyPassword()
public void changePassword()
public static ESIRequest verifyPassword(java.lang.String strUserid, java.lang.String strCurrentPassword, java.lang.String strServer)
strUserid
- String The useridstrCurrentPassword
- String The current PasswordstrServer
- String The Server
java.lang.IllegalArgumentException
- if the parameters are too longpublic static ESIRequest changePassword(java.lang.String strUserid, java.lang.String strCurrentPassword, java.lang.String strNewPassword, java.lang.String strServer) throws java.lang.IllegalArgumentException
strUserid
- String The useridstrCurrentPassword
- String The current PasswordstrNewPassword
- String The New PasswordstrServer
- String The Server
java.lang.IllegalArgumentException
- if the parameters are too long
|
©Copyright IBM Corp. 1994, 2014 Legal |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |