jp.go.nict.langrid.foundation.nodemanagement
クラス NodeManagement

java.lang.Object
  jp.go.nict.langrid.foundation.AbstractLangridService
      jp.go.nict.langrid.foundation.nodemanagement.NodeManagement

すべての実装されたインタフェース:

NodeManagementService

public class NodeManagement
extends AbstractLangridService
implements NodeManagementService

ノード管理サービス。

バージョン:

$Revision: 11299 $

作成者:

Takao Nakaguchi, $Author: Takao Nakaguchi $

コンストラクタの概要

NodeManagement()
コンストラクタ。

NodeManagement(ServiceContext nodeContext)
コンストラクタ。

メソッドの概要

void	activateNode(String nodeId) ノードをアクティブ状態にする。
void	addNode(String nodeId, NodeProfile profile, Attribute[] attributes) 追加するノードが複合ノードの場合、参照しているWSDLファイルのtargetNamespace から既存のノードが検索され、見つかった場合、参照ノードのリストに加えられる。
void	addNodeAs(String ownerUserId, String nodeId, NodeProfile profile, Attribute[] attributes) 所有権を持つユーザを指定してノードを追加する。
void	clear() 全ノードを消去する。
void	deactivateNode(String nodeId) ノードを非アクティブ状態にする。
void	deleteNode(String nodeId) 登録されているノードを削除する。
Attribute[]	getNodeAttributes(String nodeId, String[] attributeNames) ノードの属性を取得する。
NodeProfile	getNodeProfile(String nodeId) ノードのプロファイル情報を取得する。
String	getSelfNodeId() このノードのノードIDを取得する。
boolean	isNodeActive(String nodeId) ノードがアクティブかどうかを返す。
NodeEntrySearchResult	searchNodes(int startIndex, int maxCount, MatchingCondition[] conditions, Order[] orders, String scope) 指定された条件でノードを検索し、ソートして返す。
void	setNodeAttributes(String nodeId, Attribute[] attributes) ノードの属性を設定する。
void	setNodeProfile(String nodeId, NodeProfile profile) ノードのプロファイル情報を設定する。
protected static void	validateInputAttribute(String parameterName, Attribute[] attributes) 属性を検証する。

クラス jp.go.nict.langrid.foundation.AbstractLangridService から継承されたメソッド

adjustDateFieldName, adjustDateFieldName, convert, convertException, convertException, convertException, convertException, convertException, convertException, convertException, convertException, convertException, convertUserOrder, copyAttributes, copyAttributes, copyProperties, getAccessLimitDao, getAccessLogDao, getAccessRightDao, getAccessStateDao, getConverter, getCoreNodeUrl, getDaoContext, getDaoFactory, getDefaultGridId, getFederationDao, getGridDao, getGridId, getNodeDao, getOverUseLimitDao, getOverUseStateDao, getResourceDao, getServiceContext, getServiceDao, getServiceDeploymentDao, getServiceLogic, getSubscriptionLogic, getSystemPropertyDao, getTargetServiceIds, getTemporaryUserDao, getUserChecker, getUserDao, getUserLogic, unsetFactory

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

NodeManagement

public NodeManagement()

コンストラクタ。

NodeManagement

public NodeManagement(ServiceContext nodeContext)

コンストラクタ。

パラメータ:

nodeContext - サービスコンテキスト

メソッドの詳細

clear

@AccessRightValidatedMethod(policy=ADMINONLY)
@TransactionMethod
public void clear()
           throws AccessLimitExceededException,
                  NoAccessPermissionException,
                  ServiceConfigurationException,
                  UnknownException

インタフェース NodeManagementService の記述:

全ノードを消去する。 関連するアクセスログ、アクセス権(アクセス可否、アクセス制限)も削除される。

定義:

インタフェース NodeManagementService 内の clear

例外:

AccessLimitExceededException - アクセス制限に違反した

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスが適切に設定されていない

UnknownException - 処理に失敗した

searchNodes

@AccessRightValidatedMethod
@ValidatedMethod
@TransactionMethod
public NodeEntrySearchResult searchNodes(@IntNotNegative
                                                                                                      int startIndex,
                                                                                                      @IntInRange(minimum=0,maximum=100)
                                                                                                      int maxCount,
                                                                                                      @NotNull@EachElement@ValidMatchingCondition
                                                                                                      MatchingCondition[] conditions,
                                                                                                      @NotNull@EachElement@ValidOrder
                                                                                                      Order[] orders,
                                                                                                      @NotEmpty@ValidEnum(value=Scope.class)
                                                                                                      String scope)
                                  throws AccessLimitExceededException,
                                         InvalidParameterException,
                                         NoAccessPermissionException,
                                         ServiceConfigurationException,
                                         UnknownException,
                                         UnsupportedMatchingMethodException

インタフェース NodeManagementService の記述:

指定された条件でノードを検索し、ソートして返す。 マッチング条件及びソート条件は、ノードのプロファイル情報と属性情報に対して設定可能。

定義:

インタフェース NodeManagementService 内の searchNodes

パラメータ:

startIndex - 結果の取得開始位置

maxCount - 最大取得件数

conditions - マッチング条件。AND検索

orders - ソート条件

scope - 対象範囲("ALL", "MINE", "ACCESSIBLE")

戻り値:

検索結果のうち、startIndex、maxCountで指定された範囲の情報

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正な引数が渡された

UnsupportedMatchingMethodException - 対応していないマッチング方法が指定された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスが適切に設定されていない

UnknownException - 不明な理由で処理に失敗した

UnsupportedMatchingMethodException

addNode

@AccessRightValidatedMethod
@ValidatedMethod
@TransactionMethod
public void addNode(@NotEmpty@ValidNodeId
                                                                                 String nodeId,
                                                                                 @NotNull@ValidNodeProfile
                                                                                 NodeProfile profile,
                                                                                 @NotNull@EachElement@ValidAttribute
                                                                                 Attribute[] attributes)
             throws AccessLimitExceededException,
                    InvalidParameterException,
                    NoAccessPermissionException,
                    NodeAlreadyExistsException,
                    ServiceConfigurationException,
                    UnknownException

追加するノードが複合ノードの場合、参照しているWSDLファイルのtargetNamespace から既存のノードが検索され、見つかった場合、参照ノードのリストに加えられる。 このリストは、searchCompositeNodesの戻り値に含まれる CompositeNodeのnodesInUseプロパティを設定する際に利用される。 既存ユーザのに対して、追加されるノードのアクセス権が設定される。 attributes内にデフォルトアクセス権情報が含まれる場合はそれを、 無い場合は"許可"が設定される。アクセス制限は何も追加されない。

定義:

インタフェース NodeManagementService 内の addNode

パラメータ:

nodeId - ノードID

profile - ノードの情報

attributes - ノードの拡張属性情報

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

NodeAlreadyExistsException - 指定されたノードは既に存在する

ServiceConfigurationException - サービスの設定が不正なため処理に失敗した

UnknownException - 処理に失敗した

addNodeAs

@AccessRightValidatedMethod(policy=ADMINONLY)
@ValidatedMethod
@TransactionMethod
public void addNodeAs(@NotEmpty@ValidUserId
                                                                                                  String ownerUserId,
                                                                                                  @NotEmpty@ValidNodeId
                                                                                                  String nodeId,
                                                                                                  @NotNull@ValidNodeProfile
                                                                                                  NodeProfile profile,
                                                                                                  @NotNull@EachElement@ValidAttribute
                                                                                                  Attribute[] attributes)
               throws AccessLimitExceededException,
                      InvalidParameterException,
                      NoAccessPermissionException,
                      NodeAlreadyExistsException,
                      ServiceConfigurationException,
                      UnknownException

インタフェース NodeManagementService の記述:

所有権を持つユーザを指定してノードを追加する。

定義:

インタフェース NodeManagementService 内の addNodeAs

パラメータ:

ownerUserId - 所有権を持つユーザ

nodeId - ノードID

profile - ノードの情報

attributes - ノードの拡張属性情報

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

NodeAlreadyExistsException - 指定されたノードは既に存在する

ServiceConfigurationException - サービスの設定が不正なため処理に失敗した

UnknownException - 処理に失敗した

deleteNode

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public void deleteNode(@NotEmpty@ValidNodeId
                                                                                    String nodeId)
                throws AccessLimitExceededException,
                       InvalidParameterException,
                       NoAccessPermissionException,
                       ServiceConfigurationException,
                       NodeNotFoundException,
                       NodeNotInactiveException,
                       UnknownException

インタフェース NodeManagementService の記述:

登録されているノードを削除する。

定義:

インタフェース NodeManagementService 内の deleteNode

パラメータ:

nodeId - 削除するノードのID

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が不正なため処理に失敗した

NodeNotFoundException - 指定されたノードが見つからない

NodeNotInactiveException - 指定されたノードが非アクティブ状態でない

UnknownException - 不明な原因で処理に失敗した

getNodeProfile

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public NodeProfile getNodeProfile(@NotEmpty@ValidNodeId
                                                                                               String nodeId)
                           throws AccessLimitExceededException,
                                  InvalidParameterException,
                                  NoAccessPermissionException,
                                  ServiceConfigurationException,
                                  NodeNotFoundException,
                                  UnknownException

インタフェース NodeManagementService の記述:

ノードのプロファイル情報を取得する。

定義:

インタフェース NodeManagementService 内の getNodeProfile

パラメータ:

nodeId - ノードID

戻り値:

プロファイル情報

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が不正なため処理に失敗した

NodeNotFoundException - 指定されたノードが見つからない

UnknownException - 不明な原因で処理に失敗した

setNodeProfile

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public void setNodeProfile(@NotEmpty@ValidNodeId
                                                                                        String nodeId,
                                                                                        @NotNull@ValidNodeProfile
                                                                                        NodeProfile profile)
                    throws AccessLimitExceededException,
                           InvalidParameterException,
                           NoAccessPermissionException,
                           ServiceConfigurationException,
                           NodeNotFoundException,
                           UnknownException

インタフェース NodeManagementService の記述:

ノードのプロファイル情報を設定する。

定義:

インタフェース NodeManagementService 内の setNodeProfile

パラメータ:

nodeId - ノードID

profile - プロファイル情報

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が不正なため処理に失敗した

NodeNotFoundException - 指定されたノードが見つからない

UnknownException - 不明な原因で処理に失敗した

getNodeAttributes

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public Attribute[] getNodeAttributes(@NotEmpty@ValidNodeId
                                                                                                  String nodeId,
                                                                                                  @NotNull@EachElement@ValidAttributeName
                                                                                                  String[] attributeNames)
                              throws AccessLimitExceededException,
                                     InvalidParameterException,
                                     NoAccessPermissionException,
                                     ServiceConfigurationException,
                                     NodeNotFoundException,
                                     UnknownException

ノードの属性を取得する。

attributeNamesに存在しない属性名が指定された場合、その属性名は無視される。 空配列を指定した場合は取得可能な全ての属性を取得する。

定義:

インタフェース NodeManagementService 内の getNodeAttributes

パラメータ:

nodeId - ノードID

attributeNames - 取得する属性名の配列

戻り値:

属性配列

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が不正なため処理に失敗した

NodeNotFoundException - 指定されたノードが見つからない

UnknownException - 不明な原因で処理に失敗した

setNodeAttributes

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public void setNodeAttributes(@NotEmpty@ValidNodeId
                                                                                           String nodeId,
                                                                                           @EachElement@ValidAttribute
                                                                                           Attribute[] attributes)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              NodeNotFoundException,
                              UnknownException

ノードの属性を設定する。

指定された属性のvalueフィールドが空文字列の場合、その属性は削除される。

定義:

インタフェース NodeManagementService 内の setNodeAttributes

パラメータ:

nodeId - ノードID

attributes - 設定する属性

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が不正なため処理に失敗した

NodeNotFoundException - 指定されたノードが見つからない

UnknownException - 不明な原因で処理に失敗した

activateNode

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public void activateNode(@NotEmpty@ValidNodeId
                                                                                      String nodeId)
                  throws AccessLimitExceededException,
                         InvalidParameterException,
                         NoAccessPermissionException,
                         ServiceConfigurationException,
                         NodeNotFoundException,
                         UnknownException

インタフェース NodeManagementService の記述:

ノードをアクティブ状態にする。 既にアクティブ状態の場合、何もしない。

定義:

インタフェース NodeManagementService 内の activateNode

パラメータ:

nodeId - ノードID

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が不正なため処理に失敗した

NodeNotFoundException - 指定されたノードが見つからない

UnknownException - 不明な原因で処理に失敗した

deactivateNode

@ValidatedMethod
@AccessRightValidatedMethod(policy=ADMINONLY)
@TransactionMethod
public void deactivateNode(@NotEmpty@ValidNodeId
                                                                                                       String nodeId)
                    throws AccessLimitExceededException,
                           InvalidParameterException,
                           NoAccessPermissionException,
                           ServiceConfigurationException,
                           NodeNotFoundException,
                           UnknownException

インタフェース NodeManagementService の記述:

ノードを非アクティブ状態にする。 既に非アクティブ状態の場合、何もしない。

定義:

インタフェース NodeManagementService 内の deactivateNode

パラメータ:

nodeId - ノードID

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が不正なため処理に失敗した

NodeNotFoundException - 指定されたノードが見つからない

UnknownException - 不明な原因で処理に失敗した

isNodeActive

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public boolean isNodeActive(@NotEmpty@ValidNodeId
                                                                                         String nodeId)
                     throws AccessLimitExceededException,
                            InvalidParameterException,
                            NoAccessPermissionException,
                            ServiceConfigurationException,
                            NodeNotFoundException,
                            UnknownException

インタフェース NodeManagementService の記述:

ノードがアクティブかどうかを返す。

定義:

インタフェース NodeManagementService 内の isNodeActive

パラメータ:

nodeId - ノードID

戻り値:

アクティブの場合true

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が不正なため処理に失敗した

NodeNotFoundException - 指定されたノードが見つからない

UnknownException - 不明な原因で処理に失敗した

getSelfNodeId

@AccessRightValidatedMethod
@TransactionMethod
public String getSelfNodeId()
                     throws AccessLimitExceededException,
                            NoAccessPermissionException,
                            ServiceConfigurationException,
                            UnknownException

インタフェース NodeManagementService の記述:

このノードのノードIDを取得する。 ノードIDが未設定の場合、ServiceConfigurationExceptionが発生する。

定義:

インタフェース NodeManagementService 内の getSelfNodeId

戻り値:

ノードID

例外:

AccessLimitExceededException - アクセス制限に違反した

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が不正なため処理に失敗した

UnknownException - 不明な原因で処理に失敗した

validateInputAttribute

protected static void validateInputAttribute(String parameterName,
                                             Attribute[] attributes)
                                      throws InvalidParameterException

属性を検証する。 profileがnullでないか、各キーがnull又は空文字列でないかをチェックする。

パラメータ:

parameterName - パラメータ名

attributes - 検証する属性

例外:

InvalidParameterException - パラメータが不正