com.ibm.eNetwork.security.SSO.CMS.CMInterface
CMInterface インターフェースには、以下のメソッドが含まれます。
- public int Init(Properties p, String id)
- このメソッドは、プラグインの初期化に使用されます。プラグインを初期化するのに必要な構成パラメーターは どれでも、プロパティー・オブジェクト・パラメーターと共に受け渡されます。これらのパラメーターは、サーブレットの web.xml ファイルに指定します。ID パラメーターは web.xml ファイルの CMS 構成部分で指定されたプラグインのシンボル名です。この値を使用して、プラグインの複数のインスタンスが実行しているイベントでプラグインのインスタンスを特定します。
- public void Destroy()
- このメソッドは CMS がシャットダウンするときにコールされます。
- public CMResponse CMSGetUserCredentials(CMRequest req)
- このメソッドは、CMS が要求に応答するためにプラグインを選択したときに CMS によってコールされます。プラグインがネットワーク・セキュリティー・タイプの場合は、そのプラグインがユーザーのネットワーク・ユーザー ID を戻すと予想されます。プラグインがホスト・ユーザー信任状タイプの場合は、このメソッドがユーザーのホスト信任状を戻す必要があります。
以下のメソッドは、プラグインの識別および選択に必要となります。
- public String getName();
- このメソッドはプラグインを識別するストリングを戻します。
- public String getDescription();
- このメソッドは、プラグインの目的と機能についての情報を含むストリングを戻します。
- public String getAuthor();
- このメソッドは、プラグインを作成した会社または担当者を識別する場合に必要になります。
- public String[] getParameters();
- このメソッドは、このプラグインを構成するために使用できるパラメーター・トークンを含むストリング配列を戻します。これらの トークンは、CMS サーブレットを定義するために使用される web.xml ファイルの初期化 (INIT) パラメーター・セクションに 指定されるキーです。構成にトークンが必要でなかった場合は、メソッドはヌル (null) を戻します。
- public Properties getParameterInfo(String strParm);
- パラメーター・トークンが指定されると、このメソッドは、指定されたパラメーターのプロパティーのリストを持つプロパティー・オブジェクトを戻します。可能なプロパティーの現行のリストは次のとおりです。
- cmiDefaultValue: このプロパティーには、指定されたパラメーターのデフォルト値が含まれます。
- cmiEncrypted: このプロパティーは、パラメーターを暗号化しなければならないかどうかを決めます (true または false)。
- cmiRequired: このプロパティーは、プラグインの初期化にパラメーターが必要かどうかを示します。