com.jivesoftware.community.webservices
Interface AuditService

public interface AuditService

Provides a webservice for auditing actions from remote services.

For soap services this service can be accessed at /rpc/soap/AuditService For rest services this service can be accessed at /rpc/rest/audit

Method Summary

void	auditEvent(java.lang.String username, java.lang.String description, java.lang.String details) Audits (logs) a remote event with formatted data passed from remote service.
java.util.List<WSAuditMessage>	getAuditMessages() Retrieves audit logs and returns them to remote caller.

Method Detail

auditEvent

void auditEvent(java.lang.String username,
                java.lang.String description,
                java.lang.String details)
                throws UserNotFoundException

Audits (logs) a remote event with formatted data passed from remote service.

Parameters:

username - The name of user.

description - The description (summary) of the event.

details - The details of the method call.

Throws:

UserNotFoundException - Username passed does not match up to a real user.

getAuditMessages

java.util.List<WSAuditMessage> getAuditMessages()

Retrieves audit logs and returns them to remote caller.

Returns:

List of audit messages.