Package org.alfresco.rest.requests

Class Audit

java.lang.Object

org.alfresco.rest.requests.ModelRequest<Audit>

org.alfresco.rest.requests.Audit

public class Audit
extends ModelRequest<Audit>

Declares all Rest API under the /audit-applications path

Field Summary

Fields inherited from class org.alfresco.rest.requests.ModelRequest

restWrapper

Constructor Summary

Constructors

Constructor	Description
Audit(RestWrapper restWrapper)

Method Summary

Modifier and Type	Method	Description
void	deleteAuditEntriesForAnAuditApplication(java.lang.String auditApplicationId)	Deletes audit entries for audit application auditApplicationId using DELETE call on "/audit-applications/{auditApplicationId}/audit-entries"
void	deleteAuditEntryForAnAuditApplication(java.lang.String auditApplicationId, java.lang.String auditEntryId)	Deletes an audit entry auditEntryId for audit application auditApplicationId using DELETE call on "/audit-applications/{auditApplicationId}/audit-entries/{auditEntryId}"
RestAuditAppModel	getAuditApp(RestAuditAppModel restAuditAppModel)	Retrieves an audit application info with ID using GET call on "/audit-applications/{auditApplicationId}"
RestAuditAppModelsCollection	getAuditApplications()	Gets a list of audit applications in this repository using GET call on "/audit-applications"
RestAuditEntryModel	getAuditEntryForAnAuditApplication(java.lang.String auditApplicationId, java.lang.String auditEntryId)	Retrieves an audit entry auditEntryId for audit application auditApplicationId using GET call on "/audit-applications/{auditApplicationId}/audit-entries/{auditEntryId}"
RestAuditEntryModelsCollection	listAuditEntriesForAnAuditApplication(java.lang.String auditApplicationId)	Retrieves a list of audit entries for audit application auditApplicationId using GET call on "/audit-applications/{auditApplicationId}/audit-entries"
RestAuditEntryModelsCollection	listAuditEntriesForNode(java.lang.String nodeId)	Retrieves a list of audit entries for a node nodeId using GET call on "/nodes/{nodeId}/audit-entries"
RestAuditAppModel	updateAuditApp(RestAuditAppModel restAuditAppModel, java.lang.String key, java.lang.String value)	Disable or re-enable the audit application auditApplicationId using PUT call on "/audit-applications/{auditApplicationId}"

Methods inherited from class org.alfresco.rest.requests.ModelRequest

includePath, usingParams

Methods inherited from class java.lang.Object

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

Constructor Detail

Audit

public Audit(RestWrapper restWrapper)
      throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getAuditApplications

public RestAuditAppModelsCollection getAuditApplications()
                                                  throws java.lang.Exception

Gets a list of audit applications in this repository using GET call on "/audit-applications"

Returns:

Throws:

JsonToModelConversionException

java.lang.Exception

getAuditApp

public RestAuditAppModel getAuditApp(RestAuditAppModel restAuditAppModel)
                              throws java.lang.Exception

Retrieves an audit application info with ID using GET call on "/audit-applications/{auditApplicationId}"

Parameters:

auditApplicationId -

Returns:

Throws:

java.lang.Exception

listAuditEntriesForAnAuditApplication

public RestAuditEntryModelsCollection listAuditEntriesForAnAuditApplication(java.lang.String auditApplicationId)
                                                                     throws java.lang.Exception

Retrieves a list of audit entries for audit application auditApplicationId using GET call on "/audit-applications/{auditApplicationId}/audit-entries"

Parameters:

auditApplicationId -

Returns:

Throws:

java.lang.Exception

updateAuditApp

public RestAuditAppModel updateAuditApp(RestAuditAppModel restAuditAppModel,
                                        java.lang.String key,
                                        java.lang.String value)
                                 throws java.lang.Exception

Disable or re-enable the audit application auditApplicationId using PUT call on "/audit-applications/{auditApplicationId}"

Parameters:

restAuditAppModel -

key -

value -

Returns:

Throws:

java.lang.Exception

getAuditEntryForAnAuditApplication

public RestAuditEntryModel getAuditEntryForAnAuditApplication(java.lang.String auditApplicationId,
                                                              java.lang.String auditEntryId)
                                                       throws java.lang.Exception

Retrieves an audit entry auditEntryId for audit application auditApplicationId using GET call on "/audit-applications/{auditApplicationId}/audit-entries/{auditEntryId}"

Parameters:

auditApplicationId -

auditEntryId -

Returns:

Throws:

java.lang.Exception

deleteAuditEntryForAnAuditApplication

public void deleteAuditEntryForAnAuditApplication(java.lang.String auditApplicationId,
                                                  java.lang.String auditEntryId)
                                           throws java.lang.Exception

Deletes an audit entry auditEntryId for audit application auditApplicationId using DELETE call on "/audit-applications/{auditApplicationId}/audit-entries/{auditEntryId}"

Parameters:

auditApplicationId -

auditEntryId -

Throws:

java.lang.Exception

deleteAuditEntriesForAnAuditApplication

public void deleteAuditEntriesForAnAuditApplication(java.lang.String auditApplicationId)
                                             throws java.lang.Exception

Deletes audit entries for audit application auditApplicationId using DELETE call on "/audit-applications/{auditApplicationId}/audit-entries"

Parameters:

auditApplicationId -

Throws:

java.lang.Exception

listAuditEntriesForNode

public RestAuditEntryModelsCollection listAuditEntriesForNode(java.lang.String nodeId)
                                                       throws java.lang.Exception

Retrieves a list of audit entries for a node nodeId using GET call on "/nodes/{nodeId}/audit-entries"

Parameters:

nodeId -

Returns:

Throws:

java.lang.Exception