jp.go.nict.langrid.foundation.servicemonitor
クラス ServiceMonitor

java.lang.Object
  上位を拡張 jp.go.nict.langrid.foundation.AbstractLangridService
      上位を拡張 jp.go.nict.langrid.foundation.servicemonitor.ServiceMonitor
すべての実装されたインタフェース:
ServiceMonitorService

public class ServiceMonitor
extends AbstractLangridService
implements ServiceMonitorService

サービスモニタ。

バージョン:
$Revision: 11520 $
作成者:
Takao Nakaguchi, $Author: nakaguchi $

コンストラクタの概要
ServiceMonitor()
          コンストラクタ。
ServiceMonitor(ServiceContext serviceContext)
          コンストラクタ。
 
メソッドの概要
 void clear()
          アクセスログを消去する。
 int[] getAccessCounts(String userId, String serviceId, Calendar baseDateTime, String period)
          指定された集計期間のアクセス数を返す。
 AccessLogSearchResult searchAccessLogs(int startIndex, int maxCount, String userId, String serviceId, Calendar startDateTime, Calendar endDateTime, Order[] orders)
          アクセスログを検索する。
 ServiceCallLogSearchResult searchServiceCallLogs(int startIndex, int maxCount, String userId, String serviceId, Calendar startDateTime, Calendar endDateTime, Order[] orders)
          サービス呼び出しログを検索する。
 UserAccessEntrySearchResult sumUpUserAccess(int startIndex, int maxCount, String serviceId, Calendar startDateTime, Calendar endDateTime, String period, Order[] orders)
          指定されたサービスのユーザアクセスを集計する。
 
クラス 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
 

コンストラクタの詳細

ServiceMonitor

public ServiceMonitor()
コンストラクタ。


ServiceMonitor

public ServiceMonitor(ServiceContext serviceContext)
コンストラクタ。

パラメータ:
serviceContext - サービスコンテキスト
メソッドの詳細

clear

@AccessRightValidatedMethod(policy=ADMINONLY)
@TransactionMethod
public void clear()
           throws AccessLimitExceededException,
                  NoAccessPermissionException,
                  ServiceConfigurationException,
                  UnknownException
インタフェース ServiceMonitorService の記述:
アクセスログを消去する。 1件毎のアクセスログとアクセス集計が削除される。

定義:
インタフェース ServiceMonitorService 内の clear
例外:
AccessLimitExceededException - アクセス制限に違反した
NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い
ServiceConfigurationException - サービスの設定が適切に行われていない
UnknownException - 不明な例外が発生した

searchAccessLogs

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
public AccessLogSearchResult searchAccessLogs(@IntNotNegative
                                                                                                                                              int startIndex,
                                                                                                                                              @IntInRange(minimum=0,maximum=100)
                                                                                                                                              int maxCount,
                                                                                                                                              @NotNull@ValidUserId(allowEmpty=true)
                                                                                                                                              String userId,
                                                                                                                                              @NotNull@ValidServiceId(allowEmpty=true)
                                                                                                                                              String serviceId,
                                                                                                                                              @NotNull
                                                                                                                                              Calendar startDateTime,
                                                                                                                                              @NotNull
                                                                                                                                              Calendar endDateTime,
                                                                                                                                              @NotNull@EachElement@ValidOrder
                                                                                                                                              Order[] orders)
                                       throws InvalidParameterException,
                                              NoAccessPermissionException,
                                              ServiceConfigurationException,
                                              UnknownException
アクセスログを検索する。

userIdに空文字列を指定した場合、ユーザによる絞り込みを行わない。 serviceIdに空文字列を指定した場合、このAPIを呼び出したユーザが登録した全サービスについて検索を行う。

定義:
インタフェース ServiceMonitorService 内の searchAccessLogs
パラメータ:
startIndex - 取得開始位置
maxCount - 最大取得件数
userId - ユーザId
serviceId - サービスId
startDateTime - ログの開始日時。この日時のログは結果に含まれる
endDateTime - ログの終了日時。この日時のログは結果に含まれない
orders - ソート方向
戻り値:
検索されたログの配列
例外:
InvalidParameterException - 不正なパラメータが渡された
NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い
ServiceConfigurationException - サービスの設定が適切に行われていない
UnknownException - 不明な例外が発生した

searchServiceCallLogs

@ValidatedMethod
@AccessRightValidatedMethod(policy=SELF_OR_ADMIN,
                            argNames="userId")
@TransactionMethod
public ServiceCallLogSearchResult searchServiceCallLogs(@IntNotNegative
                                                                                                                                                int startIndex,
                                                                                                                                                @IntInRange(minimum=0,maximum=100)
                                                                                                                                                int maxCount,
                                                                                                                                                @NotNull@ValidUserId(allowEmpty=true)
                                                                                                                                                String userId,
                                                                                                                                                @NotNull@ValidServiceId(allowEmpty=true)
                                                                                                                                                String serviceId,
                                                                                                                                                @NotNull
                                                                                                                                                Calendar startDateTime,
                                                                                                                                                @NotNull
                                                                                                                                                Calendar endDateTime,
                                                                                                                                                @NotNull@EachElement@ValidOrder
                                                                                                                                                Order[] orders)
                                                 throws InvalidParameterException,
                                                        NoAccessPermissionException,
                                                        ServiceConfigurationException,
                                                        UnknownException
サービス呼び出しログを検索する。 複合サービス時の呼び出しログは、最初の複合サービスの情報のみ返され、複合サービス内から 呼び出された他のサービスのログは返されない。

userIdに空文字列を指定した場合、呼び出したユーザの呼び出しを取得する。 他のユーザのログは、管理者のみ取得できる。 serviceIdに空文字列を指定した場合、このAPIを呼び出したユーザが呼び出した全ログについて検索を行う。

定義:
インタフェース ServiceMonitorService 内の searchServiceCallLogs
パラメータ:
startIndex - 取得開始位置
maxCount - 最大取得件数
userId - ユーザId
serviceId - サービスId
startDateTime - ログの開始日時。この日時のログは結果に含まれる
endDateTime - ログの終了日時。この日時のログは結果に含まれない
orders - ソート方向
戻り値:
検索されたログの配列
例外:
InvalidParameterException - 不正なパラメータが渡された
NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い
ServiceConfigurationException - サービスの設定が適切に行われていない
UnknownException - 不明な例外が発生した

getAccessCounts

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
public int[] getAccessCounts(@NotNull@ValidUserId(allowEmpty=true)
                                                                                                                             String userId,
                                                                                                                             @NotNull@ValidServiceId(allowEmpty=true)
                                                                                                                             String serviceId,
                                                                                                                             @NotNull
                                                                                                                             Calendar baseDateTime,
                                                                                                                             @NotEmpty@ValidEnum(value=Period.class)
                                                                                                                             String period)
                      throws InvalidParameterException,
                             NoAccessPermissionException,
                             ServiceConfigurationException,
                             UnknownException
指定された集計期間のアクセス数を返す。

userIdに空文字列を指定した場合、ユーザによる絞り込みを行わない。 serviceIdに空文字列を指定した場合、このAPIを呼び出したユーザが登録した全サービスについて検索を行う。

定義:
インタフェース ServiceMonitorService 内の getAccessCounts
パラメータ:
userId - ユーザID
serviceId - サービスID。指定しない場合空文字列
baseDateTime - 基準日時
period - 集計期間("DAY" or "MONTH" or "YEAR")
戻り値:
アクセス集計(int[24] or int[31] or int[12])
例外:
InvalidParameterException - 不正なパラメータが渡された
NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い
ServiceConfigurationException - サービスの設定が適切に行われていない
UnknownException - 不明な例外が発生した

sumUpUserAccess

@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
@ValidatedMethod
public UserAccessEntrySearchResult sumUpUserAccess(@IntNotNegative
                                                                                                                                                   int startIndex,
                                                                                                                                                   @IntInRange(minimum=0,maximum=100)
                                                                                                                                                   int maxCount,
                                                                                                                                                   @NotEmpty@ValidServiceId
                                                                                                                                                   String serviceId,
                                                                                                                                                   @NotNull
                                                                                                                                                   Calendar startDateTime,
                                                                                                                                                   @NotNull
                                                                                                                                                   Calendar endDateTime,
                                                                                                                                                   @NotEmpty@ValidEnum(value=Period.class)
                                                                                                                                                   String period,
                                                                                                                                                   @NotNull@EachElement@ValidOrder
                                                                                                                                                   Order[] orders)
                                            throws AccessLimitExceededException,
                                                   InvalidParameterException,
                                                   NoAccessPermissionException,
                                                   ServiceConfigurationException,
                                                   UnknownException
インタフェース ServiceMonitorService の記述:
指定されたサービスのユーザアクセスを集計する。 ソートは、UserAccessEntryのフィールドを指定可能("accessCount", "transferredSize")。

定義:
インタフェース ServiceMonitorService 内の sumUpUserAccess
パラメータ:
startIndex - 取得開始位置
maxCount - 最大取得件数
serviceId - サービスId
startDateTime - 集計の開始日時
endDateTime - 集計の終了日時
period - ランキングを集計する期間("YEAR", "MONTH", "DATE")
orders - ソート条件
戻り値:
集計結果のうち、startIndex、maxCountで指定された範囲の情報
例外:
AccessLimitExceededException - アクセス制限に違反した
InvalidParameterException - パラメータが不正
NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い
ServiceConfigurationException - サービスの設定が適切に行われていない
UnknownException - 不明なエラーが発生した