com.ibm.eNetwork.security.sso.cms.CMInterface

The CMInterface interface contains the following methods:

public int Init(Properties p, String id)

This method is used to initialize the plug-in. Any configuration parameters that are needed to initialize the plug-in are passed in with the properties object parameter. The parameters are configured in ZIETrans Toolkit and stored in the Web Express Logon configuration file, zietranswelcfg.xml. The id parameter is the symbolic name of the plug-in that is generated by ZIETrans. This value is used to qualify the instance of the plug-in in the event multiple instances of the plug-in are running. The Network Security plug-in always get initialized with the default value of "" (empty string), because only one instance of this plug-in ever gets created. This method should return one of the SSOConstants values listed in Table 1.

public void Destroy()

This method is called when ZIETrans is shutting down.

public CMResponse CMSGetUserCredentials(CMRequest req)

ZIETrans calls this method when it has selected the plug-in to respond to a request. If the plug-in is a network security type, it is expected that the plug-in will return the user's network user id. If the plug-in is a host user credential type, then this method will need to return the user's host credentials. The CMResponse and CMRequest objects used by this method are described below.

The following methods are needed for plug-in identification and selection.

public String getName();

This method returns a string that identifies the plug-in.

public String getDescription();

This method returns a string that contains information that describes the purpose and function of the plug-in.

public String getAuthor();

This method is needed to identify the originating company or person of the plug-in.

public String[] getParameters();

This method returns a string array containing the names of parameters that can be used to configure this plug-in. These tokens are the keys that are specified in the parameters section of the Web Express Logon editor in ZIETrans Toolkit. The symbolic name of the plug-in generated by ZIETrans (id) is prepended to each parameter name when the parameters are passed into the Init() method. If no parameters are needed for configuration, the method might return null.

public Properties getParameterInfo(String strParm);

Given a parameter token, this method returns a properties object with the list of properties for the given parameter. Possible properties are as follows:

• cmiDefaultValue. This property contains the default value for the specified parameter. This property is optional; if it is not specified, there is no default value for the parameter.
• cmiEncrypted. This property determines whether the parameter must be encrypted. Valid values are the strings true and false. If this parameter is set to true, you must use the encryption and decryption methods that are provided by Web Express Logon. See Encrypting and decrypting plug-in parameter strings for information about these methods.
• cmiRequired. This property identifies whether or not a parameter is required for initialization of the plug-in. Valid values are the strings true and false.