Java のユーティリティ パッケージ

ポリシー管理 API または DMS API 内の関数を呼び出すには、Java アプリケーションの構築にユーティリティ パッケージ内の関数を使用する必要があります。
casso11jp
ポリシー管理 API または DMS API 内の関数を呼び出すには、Java アプリケーションの構築にユーティリティ パッケージ内の関数を使用する必要があります。
ユーティリティ パッケージのクラス
ユーティリティ パッケージは、以下のクラスを提供します。
  • 接続に関する SmApiConnection
  • セッションに関する SmApiSession
  • 結果に関する SmApiResult
  • 例外に関する SmApiException
  • プロパティに関する SmProperty
クラスは以下のサービスを提供します。
  • ポリシー サーバへの接続の確立
  • セッションの取得
  • API 要求の結果を保存する結果オブジェクトの提供
  • 例外と結果の処理
  • プロパティ データのカプセル化
Connection クラス
API 接続オブジェクトを作成し、エージェント API およびポリシー サーバ間の接続を確立するために SmApiConnection 接続クラスを使用します。使用するコンストラクタに応じて、デフォルト接続またはユーザ定義の接続のいずれかを確立できます。
SmApiConnection クラスの中心となるメソッドは以下のとおりです。
Method
説明
getAgentApiConnection()
現在の接続用の エージェント API ハンドルを取得します。後続の Java API 要求をポリシー サーバに発行する場合にこのハンドルを使用します。
isValidApiConnection()
有効な エージェント API 接続が利用可能かどうかを確認します。
setAgentApiConnection()
メソッドへ渡されたハンドルを介してユーザ定義の接続を確立します。NULL が渡される場合、スタティックな接続が確立されます。
 
注:
クライアント アプリケーションから execute() メソッドを呼び出さないでください。このメソッドは内部使用専用です。
Session クラス
SmApiSession セッション クラスを使用して、ユーザに有効な API 接続、およびユーザが使用するコンストラクタによってはセッション指定を渡すことで、ユーザがセッション オブジェクトを作成します。
: セッション指定はセッション チケットとしても知られています。
Method
説明
getApiConnection()
現在の接続用の SmApiConnection オブジェクトを取得します。
getSessionSpec()
現在のセッションに対する指定を取得します。
login()
CA Single Sign-on 管理者としてログインします。ポリシー サーバは、セッションのセッション指定を発行します。
logout()
CA Single Sign-on 管理者をログアウトします。
setApiConnection()
有効な API 接続を設定します。
setSessionSpec()
既存のセッション指定を設定します。
 
注:
エンド ユーザ、DMS 組織管理者、および DMS スーパー管理者のログインおよびログアウトに関しては、エージェント API パッケージの AgentAPI.login() および AgentAPI.logout() メソッドを使用します。
Result クラス
SmApiResult 結果クラスは、
CA Single Sign-on
Java API リクエストの結果を格納します。
CA Single Sign-on
の結果は、以下の要素で構成されます。
  • ファシリティ。結果の発生元。たとえば、結果はクライアントまたはサーバ上で発生する場合があります。
  • 重大度。情報または警告のような結果の重大度。
  • ステータス。結果のステータス コード。ステータス コードは各ファシリティ内で一意です。ファシリティの一意のステータス コードを使用して、特定の結果を同じファシリティで発生した他の結果と識別することができます。
  • メッセージ。説明文または数値の詳細など結果に関する追加の情報。
結果には理由コードも含まれる場合があります。たとえば、パスワード ポリシー結果には、パスワードが必須最小文字数を満たしていないことを示す理由コード 1001 が含まれる場合があります。結果用の理由コードを検索するには、getReason() を呼び出します。
サーバ側のエラーがすべて例外ではなく結果として返されます。ただし、クライアント側の例外がスローされる場合、SmApiResult オブジェクトは例外に埋め込まれています。
結果オブジェクトの解釈
各結果オブジェクトおよびそのファシリティ/重大度/ステータスの組み合わせは一意の値によって表されます。これらの一意の値は、たとえば SERVER_CONFIGURATION_FAILURE のように、SmApiResult クラスで定義された事前定義済み定数と関連付けられます。
結果に対するファシリティ/重大度/ステータス情報を判断するには、equals() メソッドを呼び出してSmApiResult を結果定数と比較することができます。
  • 機能: FACILITY_CONNECTION
  • 重大度: SEVERITY_ERROR
  • ステータス: 4
  • メッセージ: サーバ設定を取得できません (Unable to get server configuration)
結果オブジェクトを文字列として出力できます。たとえば、SmApiResult オブジェクト上で toString() を呼び出すことで、結果文字列を生成できます。
結果文字列にはスペースで区切られた 5 つの名前/値ペアが以下の形式で含まれています。
[facility=facility severity=severity reason=reason
status=statusCode message=message]
たとえば、ユーザがパスワードの英数字数の下限より少ない文字数でパスワードを作成しようとした場合に発生する SmApiResult オブジェクトに対して toString() を呼び出したとします。メソッドは、以下のように見える結果文字列を返す場合があります。
[facility=4 severity=3 reason=1008 status=13 message=nArg=1,Arg1=3]
結果内のフィールドには以下の意味があります。
  • facility=4。結果はサーバで発生しました。
  • severity=3。結果はエラーです。
  • reason=1008。要求されたパスワードの文字数がパスワードに必要な英数字の最小数より少ないため、エラーが発生しました。
  • status=13。このファシリティに対する一意の結果ステータス コード。
  • message=nArg=1,Arg1=3 結果の追加の説明。このフィールドの 2 つの部分には以下の意味があります。
    • nArg1=1。エラーには単に 1 つのエラー説明が含まれます。
    • Arg1=3。エラー説明は 3 です。理由コード 1008 のコンテキストでは、Arg1 値はパスワードに少なくとも 3 つの英数字が含まれる必要があることを示しています。
 Result クラスの中心的なメソッド
Method
説明
equals()
現在のオブジェクトがメソッドに渡されたオブジェクトと等しいかどうかを示します。
getError()
一意のエラー コードを取得します。
getFacility()
エラーと関連付けられたファシリティ コードを取得します。
getMessage()
エラーと関連付けられたメッセージを取得します。
getReason()
エラーの理由コードを取得します。
getSeverity()
エラーと関連付けられた重大度コードを取得します。
getStatus()
現在のファシリティ内のステータス コードを取得します。このメソッドはサーバからのパラメータを結果コードとして使用することができます。
isSuccess()
要求が成功したかどうかをレポートします。
toString()
SmApiResult オブジェクトの文字列の表現を返します。
Exception クラス
SmApiException 例外クラスには、結果クラス SmApiResult が含まれます。以下のパッケージが SmApiException を使用します。
  • com.netegrity.sdk.policyapi
  • com.netegrity.sdk.dmsapi
  • com.netegrity.sdk.apiutil
Method
説明
getFacility()
例外のファシリティ コードを取得します。
getReason()
例外の理由コードを取得します。
getSeverity()
例外の重大度コードを取得します。
getStatus()
例外のステータス コードを取得します。
toString()
SmApiResult オブジェクトの文字列の表現を返します。
Exception クラスは java.lang.Exception を拡張します。継承された getMessage() メソッドを呼び出すことで、例外と関連付けられたメッセージを取得することができます。
Property クラス
Property クラス、SmProperty は、プロパティに関する以下の情報を保持します。
  • Name
  • タイプ(暗号化/プレーン)
Method
説明
getName()
プロパティの名前を取得します。
getType()
プロパティのタイプ(つまり、プレーン テキストの場合は 0、暗号化される場合は 1)を取得します。
getValue()
プロパティの値を取得します。
setName()
プロパティの名前を設定します。
setType()
プロパティのタイプを設定します。プレーン テキストの場合は 0、暗号化される場合は 1 になります。
setValue()
プロパティの値を設定します。
内部使用クラス
ユーティリティ パッケージは、以下のクラスを
Single Sign-On
内部使用のみを目的として提供します。
  • SmApiConstants
  • SmApiObject
  • SmApiPropertySets
  • SmApiExportFileHandler
  • SmApiImportFileHandler
  • SmFlag