RM-2812 Add audit service and dependencies.

Having thought about this more, I don't think there's any problem adding
a deprecated class to the public API, as long as it's clearly marked as
such. It's deprecated at the moment because we think people might be using
it, but we want them to migrate to something else. Declaring this as part of
the public API formalises this process.

The RecordsManagementAuditService has the following dependencies:

RecordsManagementAuditQueryParameters <- RecordsManagementAuditService
RecordsManagementAuditEntry <- RecordsManagementAuditService
AuditEvent <- RecordsManagementAuditService
This commit is contained in:
Tom Page
2016-04-20 16:24:44 +01:00
parent 9c0b13133b
commit 9ead3bd771
5 changed files with 64 additions and 55 deletions

View File

@@ -31,6 +31,7 @@ import java.io.Serializable;
import java.util.Date;
import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementAction;
import org.alfresco.service.cmr.repository.NodeRef;
@@ -41,6 +42,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
* @since 2.1
* @deprecated as of 2.1, see {@link RecordsManagementAuditService}.
*/
@AlfrescoPublicApi
public interface RecordsManagementAuditServiceDeprecated
{
/**

View File

@@ -32,6 +32,7 @@ import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.Pair;
@@ -43,6 +44,7 @@ import org.springframework.extensions.surf.util.ISO8601DateFormat;
*
* @author Gavin Cornwell
*/
@AlfrescoPublicApi
public final class RecordsManagementAuditEntry
{
private final Date timestamp;

View File

@@ -29,6 +29,7 @@ package org.alfresco.module.org_alfresco_module_rm.audit;
import java.util.Date;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName;
@@ -38,6 +39,7 @@ import org.alfresco.service.namespace.QName;
*
* @author Gavin Cornwell
*/
@AlfrescoPublicApi
public final class RecordsManagementAuditQueryParameters
{
private int maxEntries = -1;

View File

@@ -33,6 +33,7 @@ import java.util.Date;
import java.util.List;
import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.module.org_alfresco_module_rm.audit.event.AuditEvent;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName;
@@ -42,7 +43,7 @@ import org.alfresco.service.namespace.QName;
*
* @author Gavin Cornwell
*/
// Not @AlfrescoPublicApi as extends the deprecated class RecordsManagementAuditServiceDeprecated.
@AlfrescoPublicApi
@SuppressWarnings("deprecation")
public interface RecordsManagementAuditService extends RecordsManagementAuditServiceDeprecated
{

View File

@@ -27,6 +27,7 @@
package org.alfresco.module.org_alfresco_module_rm.audit.event;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.module.org_alfresco_module_rm.audit.RecordsManagementAuditService;
import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
import org.alfresco.util.ParameterCheck;
@@ -40,6 +41,7 @@ import org.springframework.extensions.surf.util.I18NUtil;
* @author Roy Wetherall
* @since 1.0
*/
@AlfrescoPublicApi
public class AuditEvent implements RecordsManagementModel, Comparable<AuditEvent>
{
/** Name */