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

CMInterface インターフェースには、以下のメソッドが含まれます。

public int Init(Properties p, String id)

このメソッドは、プラグインの初期化に使用されます。プラグインの初期化に必要な構成パラメーターは、プロパティー・オブジェクト・パラメーターによって受け渡されます。パラメーターは ZIETrans Toolkit で構成され、Web Expressログオン構成ファイル zietranswelcfg.xml に保管されます。id パラメーターは、ZIETrans が生成するプラグインのシンボル名です。この値は、プラグインの複数インスタンスが実行中の場合に、プラグインのインスタンスを修飾するのに使用されます。ネットワーク・セキュリティー・プラグインは、作成されるこのプラグインはいつも 1 インスタンスのみであるので、必ずデフォルト値 "" (空ストリング) で初期化されます。このメソッドは、表 1 にリストされた SSOConstants 値のいずれかを戻します。

public void Destroy()

このメソッドは ZIETrans がシャットダウンするときにコールされます。

public CMResponse CMSGetUserCredentials(CMRequest req)

ZIETrans は、要求に応答するプラグインを選択したときに、このメソッドを呼び出します。プラグインがネットワーク・セキュリティー・タイプの場合は、そのプラグインがユーザーのネットワーク・ユーザー ID を戻すと予想されます。プラグインがホスト・ユーザー信任状タイプの場合は、このメソッドがユーザーのホスト信任状を戻す必要があります。このメソッドで使用する CMResponse オブジェクトおよび CMRequest オブジェクトについては、この後で説明します。

以下のメソッドは、プラグインの識別および選択に必要となります。

public String getName();

このメソッドは、プラグインを識別するストリングを戻します。

public String getDescription();

このメソッドは、プラグインの目的と機能についての情報を含むストリングを戻します。

public String getAuthor();

このメソッドは、プラグインを作成した会社または担当者を識別する場合に必要になります。

public String[] getParameters();

このメソッドは、このプラグインの構成に使用されるパラメーター名を含むストリング配列を戻します。これらのトークンは、ZIETrans Toolkit の Web Expressログオン・エディターのパラメーター・セクションで指定される鍵です。パラメーターが Init() メソッドに渡される場合に、ZIETrans によって生成されたプラグインのシンボル名 (id) が各パラメーター名の前に付加されます。構成でパラメーターを必要としない場合、このメソッドはヌルを戻します。

public Properties getParameterInfo(String strParm);

パラメーター・トークンが指定されると、このメソッドは、指定されたパラメーターのプロパティーのリストを持つプロパティー・オブジェクトを戻します。使用可能なプロパティーは以下のとおりです。

• cmiDefaultValue。このプロパティーには、指定されたパラメーターのデフォルト値が含まれます。このプロパティーはオプションです。このプロパティーが指定されない場合、そのパラメーターにはデフォルト値はありません。
• cmiEncrypted。このプロパティーは、パラメーターを暗号化するかどうかを決定します。有効な値は、ストリング true および false です。このパラメーターを true に設定した場合は、Web Expressログオンで提供される暗号化および暗号化解除メソッドを使用する必要があります。これらのメソッドについては、プラグイン・パラメーター・ストリングの暗号化および暗号化解除を参照してください。
• cmiRequired。このプロパティーは、プラグインの初期化にパラメーターが必要かどうかを示します。有効な値は、ストリング true および false です。