com.ibm.eNetwork.security.sso.CMResponse

Your plug-in bundles its response into this object and returns it to ZIETrans. The following are its members and methods.

Members:

Status Code
ID (Host ID or Network ID)
User Credentials (Password or Passticket)

Methods:

public CMResponse()

public CMResponse(Object id, Object password, int status)

public int getStatus()

public void setStatus(int status)

The Credential Mapper plug-in uses the status element to provide the status of the return value. If the plug-in query fails for any reason, this field reports that failure to Web Express Logon. Failure codes are defined in the com.ibm.eNetwork.security.sso.SSOConstants class. Status code definitions contains the status code numeric values, constant strings, and definitions.

Table 1. Status code definitions
Status code	Constant value	Description
0	`SSO_CMR_SUCCESS`	Success
1	`SSO_CMR_UNKNOWN_STATUS_CODE`	Unknown status code
2	`SSO_CMR_CREDENTIAL_MAPPER _NOT_FOUND`	Credential Mapper not found
3	`SSO_CMR_INVALID_WEB_ID`	Web ID not valid
4	`SSO_CMR_INVALID_APPL_ID`	Application ID not valid
5	`SSO_CMR_INVALID_SERVER_ADDR`	Server address not valid
6	`SSO_CMR_DATABASE_CONNECTION_ ERROR`	Database connection error
7	`SSO_CMR_USER_ID_NOT_FOUND_ IN_DB`	User ID not found in database
8	`SSO_CMR_EXCEPTION`	Exception
9	`SSO_CMR_INVALID_USER_ID`U	Invalid user ID not valid
10	`SSO_CMR_PASSTICKET_ERROR`	Passticket error
11	`SSO_CMR_TIMEOUT`	Timeout
12	`SSO_CMR_UNEXPECTED_DCAS_RC`	Unexpected DCAS return code
13	`SSO_CMR_API_NOT_SUPPORTED`	API not supported
14	`SSO_CMR_BAD_URL`	Bad URL
15	`SSO_CMR_UNABLE_TO_PARSE_ RESPONSE`	Unable to parse response
16	`SSO_CMR_LOCAL_USERID_NOT_ AVAILABLE`	Local user ID not available
17	`SSO_CMR_DUPLICATE_XML_TAGS`	Duplicate XML tags
18	`SSO_CMR_CLIENT_EXCEPTION`	An exception occurred while processing the credential request
19	`SSO_CMR_NO_NETWORK_SECURITY_ PLUGIN`	Network Security plug-in is not defined to Web Express™ Logon

public Object getID()

public String getIDasString()

public void setID(Object id): Your CMSGetUserCredentials() method can use this method to return the network user ID from a Network Security plug-in or the host user ID from a Credential Mapper plug-in.

public Object getPassword()

public String getPasswordasString()

public void setPassword(Object password)