public class ServiceMonitor extends AbstractLangridService implements ServiceMonitorService
Constructor and Description |
---|
ServiceMonitor()
Constructor.
|
ServiceMonitor(ServiceContext serviceContext)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
Erases access log.
|
int[] |
getAccessCounts(String userId,
String serviceId,
Calendar baseDateTime,
String period)
Returns the access count over the specified totalling period.
|
AccessLogSearchResult |
searchAccessLogs(int startIndex,
int maxCount,
String userId,
String serviceId,
Calendar startDateTime,
Calendar endDateTime,
Order[] orders)
Searches access log.
|
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)
Totals the user accesses of the specified service.
|
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, getSystemPropertyDao, getTargetServiceIds, getTemporaryUserDao, getUserChecker, getUserDao, getUserLogic, unsetFactory
public ServiceMonitor()
public ServiceMonitor(ServiceContext serviceContext)
serviceContext
- Service context@AccessRightValidatedMethod(policy=ADMINONLY) @TransactionMethod public void clear() throws AccessLimitExceededException, NoAccessPermissionException, ServiceConfigurationException, UnknownException
ServiceMonitorService
clear
in interface ServiceMonitorService
AccessLimitExceededException
- Violated an access restrictionNoAccessPermissionException
- The user executing the call lacks execution privilegesServiceConfigurationException
- The service setup was not done appropriatelyUnknownException
- An unknwon exception occurred@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
When an empty string is specified as userId, doesn't narrow down according to user. When an empty string is specified for serviceId, do a search on all services registered by the user calling this API.
searchAccessLogs
in interface ServiceMonitorService
startIndex
- Starting position of acquisitionmaxCount
- Maximum number of acquired resultsuserId
- User IDserviceId
- Service IDstartDateTime
- Log start date and time. Logs at this date and time are included in resultsendDateTime
- End date and time of the log. Logs at this date and time are not included in the resultsorders
- Sort directionInvalidParameterException
- An invalid parameter was passedNoAccessPermissionException
- The user executing the call lacks execution privilegesServiceConfigurationException
- The service setup was not done appropriatelyUnknownException
- An unknwon exception occurred@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
searchServiceCallLogs
in interface ServiceMonitorService
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
When an empty string is specified as userId, doesn't narrow down according to user. When an empty string is specified for serviceId, do a search on all services registered by the user calling this API.
getAccessCounts
in interface ServiceMonitorService
userId
- User IDserviceId
- Service ID. When unspecified, an empty stringbaseDateTime
- Base date and timeperiod
- Aggregation period ("DAY" or "MONTH" or "YEAR")InvalidParameterException
- An invalid parameter was passedNoAccessPermissionException
- The user executing the call lacks execution privilegesServiceConfigurationException
- The service setup was not done appropriatelyUnknownException
- An unknwon exception occurred@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
sumUpUserAccess
in interface ServiceMonitorService
startIndex
- Starting position of acquisitionmaxCount
- Maximum number of acquired resultsserviceId
- Service IDstartDateTime
- Start date and time of aggregationendDateTime
- End date and time of aggregationperiod
- Period to aggregate ranking ("YEAR", "MONTH", "DATE")orders
- Sort conditionAccessLimitExceededException
- Violated an access restrictionInvalidParameterException
- The parameter is invalidNoAccessPermissionException
- The user executing the call lacks execution privilegesServiceConfigurationException
- The service setup was not done appropriatelyUnknownException
- An unknown error occurred