|
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object jp.go.nict.langrid.foundation.AbstractLangridService jp.go.nict.langrid.foundation.servicemonitor.ServiceMonitor
public class ServiceMonitor
サービスモニタ。
コンストラクタの概要 | |
---|---|
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)
指定されたサービスのユーザアクセスを集計する。 |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
コンストラクタの詳細 |
---|
public ServiceMonitor()
public ServiceMonitor(ServiceContext serviceContext)
serviceContext
- サービスコンテキストメソッドの詳細 |
---|
@AccessRightValidatedMethod(policy=ADMINONLY) @TransactionMethod public void clear() throws AccessLimitExceededException, NoAccessPermissionException, ServiceConfigurationException, UnknownException
ServiceMonitorService
の記述:
ServiceMonitorService
内の clear
AccessLimitExceededException
- アクセス制限に違反した
NoAccessPermissionException
- 呼び出しを行ったユーザに実行権限が無い
ServiceConfigurationException
- サービスの設定が適切に行われていない
UnknownException
- 不明な例外が発生した@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
- ユーザIdserviceId
- サービスIdstartDateTime
- ログの開始日時。この日時のログは結果に含まれるendDateTime
- ログの終了日時。この日時のログは結果に含まれないorders
- ソート方向
InvalidParameterException
- 不正なパラメータが渡された
NoAccessPermissionException
- 呼び出しを行ったユーザに実行権限が無い
ServiceConfigurationException
- サービスの設定が適切に行われていない
UnknownException
- 不明な例外が発生した@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
- ユーザIdserviceId
- サービスIdstartDateTime
- ログの開始日時。この日時のログは結果に含まれるendDateTime
- ログの終了日時。この日時のログは結果に含まれないorders
- ソート方向
InvalidParameterException
- 不正なパラメータが渡された
NoAccessPermissionException
- 呼び出しを行ったユーザに実行権限が無い
ServiceConfigurationException
- サービスの設定が適切に行われていない
UnknownException
- 不明な例外が発生した@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
- ユーザIDserviceId
- サービスID。指定しない場合空文字列baseDateTime
- 基準日時period
- 集計期間("DAY" or "MONTH" or "YEAR")
InvalidParameterException
- 不正なパラメータが渡された
NoAccessPermissionException
- 呼び出しを行ったユーザに実行権限が無い
ServiceConfigurationException
- サービスの設定が適切に行われていない
UnknownException
- 不明な例外が発生した@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
の記述:
ServiceMonitorService
内の sumUpUserAccess
startIndex
- 取得開始位置maxCount
- 最大取得件数serviceId
- サービスIdstartDateTime
- 集計の開始日時endDateTime
- 集計の終了日時period
- ランキングを集計する期間("YEAR", "MONTH", "DATE")orders
- ソート条件
AccessLimitExceededException
- アクセス制限に違反した
InvalidParameterException
- パラメータが不正
NoAccessPermissionException
- 呼び出しを行ったユーザに実行権限が無い
ServiceConfigurationException
- サービスの設定が適切に行われていない
UnknownException
- 不明なエラーが発生した
|
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |