com.sas.hls.security.audit
Interface AuditService


public interface AuditService

Service that provides a way to query the global audit history or an object audit history. User must have the View Audit History privilege to view the global audit trail and either View Audit History or View Item Audit Records privilege to view an object audit history.


Method Summary
 void clearAuditEntriesInfo(AuditToken token)
          Releases the token and any cached information about the query associated with the token.
 List<AuditEntry> getAuditEntries(AuditToken token, int fromRow, int toRow)
          Gets AuditEntry objects using a token from AuditEntriesInfo which is obtained by calling getAuditEntriesInfoByQuery.
 AuditEntriesInfo getAuditEntriesInfoByQuery(AuditEntryQuery aq)
          Returns an AuditEntriesInfo object which contains a token and row count in which to request audit entries.
 List<AuditEntryDetail> getAuditEntryDetails(String identifier)
          Retrieve audit details for the audit entry with the given identifier.
 int getPageSizeLimit()
          Gets the maximum number of audit entries that can be returned in a single request.
 

Method Detail

getAuditEntryDetails

List<AuditEntryDetail> getAuditEntryDetails(String identifier)
Retrieve audit details for the audit entry with the given identifier. The details contain the old and new values of what was changed.

Parameters:
identifier - Identifier of the AuditEntry
Returns:
a list of AuditEntryDetail objects containing the details of what information has changed

getAuditEntriesInfoByQuery

AuditEntriesInfo getAuditEntriesInfoByQuery(AuditEntryQuery aq)
Returns an AuditEntriesInfo object which contains a token and row count in which to request audit entries.

Parameters:
aq - AuditEntryQuery containing criteria in which to filter the audit history.
Returns:
AuditEntriesInfo containing a token and a row count indicating how many audit records are returned by the query

getAuditEntries

List<AuditEntry> getAuditEntries(AuditToken token,
                                 int fromRow,
                                 int toRow)
                                 throws AuditEntrySearchException
Gets AuditEntry objects using a token from AuditEntriesInfo which is obtained by calling getAuditEntriesInfoByQuery. The fromRow and toRow values used should be between 1 and the rowCount specified on AuditEntriesInfo. Note the maximum number of records that can be returned is determined by getPageSizeLimit(). The default maximum is 5000.

Parameters:
token - A token identifying a generated audit query on the server
fromRow - Row number in which to start with. Must be greater than 0.
toRow - Row number to end with. Must be less than or equal to the rowCount on AuditEntriesInfo
Returns:
list of AuditEntry objects based on token and rows provided
Throws:
AuditEntrySearchException - thrown if the token has been cleared from the server or if the total row number requested exceeds the page size limit

clearAuditEntriesInfo

void clearAuditEntriesInfo(AuditToken token)
Releases the token and any cached information about the query associated with the token. This should be called once in a finally block for each call to getAuditEntriesInfoByQuery.

Parameters:
token - A token identifying a generated audit query on the server

getPageSizeLimit

int getPageSizeLimit()
Gets the maximum number of audit entries that can be returned in a single request. By default, this is configured to be 5000.

Returns:
the page size limit


Copyright (c) 2013, SAS Institute Inc., Cary, NC, USA