ExternalServiceManagementService (Language Grid API)

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

jp.go.nict.langrid.service_1_2.foundation.servicemanagement
インタフェース ExternalServiceManagementService

既知の実装クラスの一覧:: ExternalServiceManagement

public interface ExternalServiceManagementService

外部サービス固有の情報を管理するためのAPIを提供する。

バージョン:: $Revision: 10415 $
作成者:: $Author: Takao Nakaguchi $

メソッドの概要
`void`	`addActualEndpoint(String serviceId, Endpoint endpoint)` エンドポイントを追加する。
`void`	`deleteActualEndpoint(String serviceId, String url, String userName)` エンドポイントを削除する。
`void`	`disableActualEndpoint(String serviceId, String url, String userName)` エンドポイントを無効化する。
`void`	`enableActualEndpoint(String serviceId, String url, String userName)` エンドポイントを有効化する。
`Endpoint[]`	`listActualEndpoints(String serviceId)` 指定されたサービスのエンドポイント一覧を取得する。

メソッドの詳細

listActualEndpoints

Endpoint[] listActualEndpoints(String serviceId)
                               throws AccessLimitExceededException,
                                      InvalidParameterException,
                                      NoAccessPermissionException,
                                      ServiceConfigurationException,
                                      ServiceNotFoundException,
                                      UnknownException

指定されたサービスのエンドポイント一覧を取得する。

パラメータ:: serviceId - サービスID
戻り値:: エンドポイント一覧
例外:: AccessLimitExceededException - アクセス制限に違反した; InvalidParameterException - 不正な引数が渡された; NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い; ServiceConfigurationException - サービスが適切に設定されていない; ServiceNotFoundException - 指定されたサービスが見つからない; UnknownException - 不明な理由で処理に失敗した

addActualEndpoint

void addActualEndpoint(String serviceId,
                       Endpoint endpoint)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              ServiceNotFoundException,
                              UnknownException

エンドポイントを追加する。エンドポイントはurlとuserNameで識別される。同じurlとuserNameを持つエンドポイントが既に追加されていた場合、InvalidParameterExceptionが発生する。

パラメータ:: serviceId - サービスID; endpoint - エンドポイント
例外:: AccessLimitExceededException - アクセス制限に違反した; InvalidParameterException - 不正な引数が渡された; NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い; ServiceConfigurationException - サービスが適切に設定されていない; ServiceNotFoundException - 指定されたサービスが見つからない; UnknownException - 不明な理由で処理に失敗した

deleteActualEndpoint

void deleteActualEndpoint(String serviceId,
                          String url,
                          String userName)
                          throws AccessLimitExceededException,
                                 EndpointNotFoundException,
                                 InvalidParameterException,
                                 NoAccessPermissionException,
                                 ServiceConfigurationException,
                                 ServiceNotFoundException,
                                 UnknownException

エンドポイントを削除する。

パラメータ:: serviceId - サービスID; url - エンドポイントのURL; userName - エンドポイントのBASIC認証ユーザ名
例外:: AccessLimitExceededException - アクセス制限に違反した; EndpointNotFoundException - エンドポイントが見つからない; InvalidParameterException - 不正な引数が渡された; NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い; ServiceConfigurationException - サービスが適切に設定されていない; ServiceNotFoundException - 指定されたサービスが見つからない; UnknownException - 不明な理由で処理に失敗した

enableActualEndpoint

void enableActualEndpoint(String serviceId,
                          String url,
                          String userName)
                          throws AccessLimitExceededException,
                                 EndpointNotFoundException,
                                 InvalidParameterException,
                                 NoAccessPermissionException,
                                 ServiceConfigurationException,
                                 ServiceNotFoundException,
                                 UnknownException

エンドポイントを有効化する。

パラメータ:: serviceId - サービスID; url - エンドポイントのURL; userName - エンドポイントのBASIC認証ユーザ名
例外:: AccessLimitExceededException - アクセス制限に違反した; EndpointNotFoundException - エンドポイントが見つからない; InvalidParameterException - 不正な引数が渡された; NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い; ServiceConfigurationException - サービスが適切に設定されていない; ServiceNotFoundException - 指定されたサービスが見つからない; UnknownException - 不明な理由で処理に失敗した

disableActualEndpoint

void disableActualEndpoint(String serviceId,
                           String url,
                           String userName)
                           throws AccessLimitExceededException,
                                  EndpointNotFoundException,
                                  InvalidParameterException,
                                  NoAccessPermissionException,
                                  ServiceConfigurationException,
                                  ServiceNotFoundException,
                                  UnknownException

エンドポイントを無効化する。

パラメータ:: serviceId - サービスID; url - エンドポイントのURL; userName - エンドポイントのBASIC認証ユーザ名
例外:: AccessLimitExceededException - アクセス制限に違反した; EndpointNotFoundException - エンドポイントが見つからない; InvalidParameterException - 不正な引数が渡された; NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い; ServiceConfigurationException - サービスが適切に設定されていない; ServiceNotFoundException - 指定されたサービスが見つからない; UnknownException - 不明な理由で処理に失敗した