com.hp.sdn.adm.auditlog

Interface AuditLogService

All Known Subinterfaces:

AuditLogServiceInternal

public interface AuditLogService

Basic service supporting audit log management.

Author:

Scott Simes, Stephen Cobbe

Method Summary

Modifier and Type	Method and Description
long	entryCount() Returns the number of audit log entries maintained in persistence.
List<AuditLogEntry>	find(AuditLogFilter filter, SortSpecification<AuditLogSortAttribute> sortSpec) Returns a list of all AuditLogEntry objects present in the system, based on the criteria exposed by the supplied filter, and sorted based on the supplied sort specification.
Page<AuditLogEntry>	find(AuditLogFilter filter, SortSpecification<AuditLogSortAttribute> sortSpec, PageRequest pageRequest) Returns a page of AuditLogEntry objects present in the system, based on the page specification, based on the criteria exposed by the supplied filter, and sorted based on the supplied sort specification
void	importAuditLogEntry(AuditLogEntry entry) Add an audit log entry to this system.
AuditLogEntry	post(String user, String origin, String activity, String description) Creates a new AuditLogEntry based on the supplied parameters.
String	requestCSV(AuditLogFilter filter) Request asynchronous production of an audit log csv file.
File	retrieveCSVFile(String ticket) Retrieve the zip file containing the audit log csv data, based on the given ticket.

Method Detail

post

AuditLogEntry post(String user,
                   String origin,
                   String activity,
                   String description)

Creates a new AuditLogEntry based on the supplied parameters.

Parameters:

user - User associated with this AuditLog

origin - the originating entity for this alert

activity - The activity associated with this AuditLog

description - a description of the AuditLog activity

Returns:

The created AuditLogEntry object

importAuditLogEntry

void importAuditLogEntry(AuditLogEntry entry)

Add an audit log entry to this system.

Parameters:

entry - the audit log entry to add

entryCount

long entryCount()

Returns the number of audit log entries maintained in persistence.

Returns:

the number of audit log entries

find

List<AuditLogEntry> find(AuditLogFilter filter,
                         SortSpecification<AuditLogSortAttribute> sortSpec)

Returns a list of all AuditLogEntry objects present in the system, based on the criteria exposed by the supplied filter, and sorted based on the supplied sort specification.

Parameters:

filter - object expressing the desired filtering criteria to consider for restricting the resulting list of AuditLog objects

sortSpec - defines how the data should be sorted for return. The SortSpecification must be typed with an AuditLogSortAttribute representation.

Returns:

the list of AuditLogEntry objects

find

Page<AuditLogEntry> find(AuditLogFilter filter,
                         SortSpecification<AuditLogSortAttribute> sortSpec,
                         PageRequest pageRequest)

Returns a page of AuditLogEntry objects present in the system, based on the page specification, based on the criteria exposed by the supplied filter, and sorted based on the supplied sort specification

Parameters:

filter - object expressing the desired filtering criteria to consider for restricting the resulting list of AuditLog objects

sortSpec - defines how the data should be sorted for return. The SortSpecification must be typed with an AuditLogSortAttribute representation.

pageRequest - definition of the desired page

Returns:

a page of AuditLogEntry data

requestCSV

String requestCSV(AuditLogFilter filter)
           throws IOException

Request asynchronous production of an audit log csv file. A ticket is issued representing the unique identification of this request for audit log csv data. The consumers of this method must call back via the retrieveCSVFile(java.lang.String) method with the issued ticket to obtain the support log data.

Parameters:

filter - object expressing the desired filtering criteria to consider for restricting the resulting list of AuditLog objects

Returns:

the unique ticket to retrieve the CSV audit log data

Throws:

IOException - im error occurs writing data

retrieveCSVFile

File retrieveCSVFile(String ticket)

Retrieve the zip file containing the audit log csv data, based on the given ticket. If unable to locate a matching request for asynchronous collection of csv audit log data, an IllegalArgumentException is thrown.

Parameters:

ticket - the ticket issued when the request was made

Returns:

the audit log csv data in a compressed file