public interface ServiceMonitorService
| 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.
|
UserAccessEntrySearchResult |
sumUpUserAccess(int startIndex,
int maxCount,
String serviceId,
Calendar startDateTime,
Calendar endDateTime,
String period,
Order[] orders)
Totals the user accesses of the specified service.
|
void clear()
throws AccessLimitExceededException,
NoAccessPermissionException,
ServiceConfigurationException,
UnknownException
AccessLimitExceededException - Violated an access restrictionNoAccessPermissionException - The user executing the call lacks execution privilegesServiceConfigurationException - The service setup was not done appropriatelyUnknownException - An unknwon exception occurredAccessLogSearchResult searchAccessLogs(int startIndex, int maxCount, String userId, String serviceId, Calendar startDateTime, Calendar endDateTime, Order[] orders) throws AccessLimitExceededException, InvalidParameterException, NoAccessPermissionException, ServiceConfigurationException, UnknownException
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 directionAccessLimitExceededException - Violated an access restrictionInvalidParameterException - An invalid parameter was passedNoAccessPermissionException - The user executing the call lacks execution privilegesServiceConfigurationException - The service setup was not done appropriatelyUnknownException - An unknwon exception occurredint[] getAccessCounts(String userId, String serviceId, Calendar baseDateTime, String period) throws AccessLimitExceededException, InvalidParameterException, NoAccessPermissionException, ServiceConfigurationException, UnknownException
userId - User IDserviceId - Service ID. When unspecified, an empty stringbaseDateTime - Base date and timeperiod - Aggregation period ("DAY" or "MONTH" or "YEAR")AccessLimitExceededException - Violated an access restrictionInvalidParameterException - An invalid parameter was passedNoAccessPermissionException - The user executing the call lacks execution privilegesServiceConfigurationException - The service setup was not done appropriatelyUnknownException - An unknwon exception occurredUserAccessEntrySearchResult sumUpUserAccess(int startIndex, int maxCount, String serviceId, Calendar startDateTime, Calendar endDateTime, String period, Order[] orders) throws AccessLimitExceededException, InvalidParameterException, NoAccessPermissionException, ServiceConfigurationException, UnknownException
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