Package org.alfresco.rest.v0

Class RMAuditAPI

java.lang.Object

org.alfresco.rest.core.v0.BaseAPI

org.alfresco.rest.v0.RMAuditAPI

@Component
public class RMAuditAPI
extends BaseAPI

The v0 REST API for rm audit logs

Since:

2.7

Author:

Rodica Sutu

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.rest.core.v0.BaseAPI

BaseAPI.PermissionType, BaseAPI.RETENTION_SCHEDULE, BaseAPI.RM_ACTIONS, BaseAPI.RMProperty

Field Summary

Fields inherited from class org.alfresco.rest.core.v0.BaseAPI

ACTIONS_API, contentService, NODE_PREFIX, NODE_REF_WORKSPACE_SPACES_STORE, RM_ACTIONS_API, RM_SITE_ID, SHARE_ACTION_API, UPDATE_METADATA_API

Constructor Summary

Constructors

Constructor	Description
RMAuditAPI()

Method Summary

Modifier and Type	Method	Description
void	clearAuditLog(String username, String password)	Clear the list of audit entries.
List<AuditEntry>	getRMAuditLog(String user, String password, int size, String event)	Returns a list of rm audit entries .
List<AuditEntry>	getRMAuditLogAll(String user, String password, int size)	Returns a list of rm audit entries .
org.apache.http.HttpResponse	logsAuditLogAsRecord(String username, String password, String recNodeRef, String destinationNodeRef)	Logs the Audit Log as Record.

Methods inherited from class org.alfresco.rest.core.v0.BaseAPI

addPropertyToRequest, deleteItem, doDeleteRequest, doGetRequest, doPostJsonRequest, doPostRequest, doPutJsonRequest, doPutRequest, doSlingshotPostJsonRequest, facetedRequest, getFilePlanPath, getItemNodeRef, getNodeRefSpacesStore, getObjectByPath, getPropertyValue, getPropertyValue, getPropertyValues, getPropertyValuesByUniquePropertyValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RMAuditAPI

public RMAuditAPI()

Method Details

getRMAuditLog

public List<AuditEntry> getRMAuditLog(String user,
 String password,
 int size,
 String event)

Returns a list of rm audit entries .

Parameters:

user - The username of the user to use.

password - The password of the user.

size - Maximum number of log entries to return

event - The name of audit event to be retrieved

Returns:

return Only return log entries matching this event

getRMAuditLogAll

public List<AuditEntry> getRMAuditLogAll(String user,
 String password,
 int size)

Returns a list of rm audit entries .

Parameters:

user - The username of the user to use.

password - The password of the user.

size - Maximum number of log entries to return

Returns:

return All return log entries

clearAuditLog

public void clearAuditLog(String username,
 String password)

Clear the list of audit entries.

Parameters:

username - The username of the user to use.

password - The password of the user.

Throws:

AssertionError - If the API call didn't clear the audit log.

logsAuditLogAsRecord

public org.apache.http.HttpResponse logsAuditLogAsRecord(String username,
 String password,
 String recNodeRef,
 String destinationNodeRef)

Logs the Audit Log as Record.

Parameters:

username - The username of the user to use.

password - The password of the user.

recNodeRef - The Record Node reference for which Audit log should be created as record

destinationNodeRef - The Folder id Node reference where the html file should be placed

Throws:

AssertionError - If the API call didn't create the Audit Log as Record.