com.atlassian.crowd.plugin.rest.service.resource.audit

Class AuditResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.audit.AuditResource

@Path(value="auditlog")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public class AuditResource
extends Object

Constructor Summary

Constructors

Constructor and Description
AuditResource(AuditController auditController)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addChangeset(AuditLogChangesetRestDTO changeset) Stores a changeset in the audit log
AuditLogConfigurationEntity	getConfiguration() Retrieves current audit log configuration
javax.ws.rs.core.Response	getFilterValues(AuditLogQueryRestDTO searchRestriction, RestPageRequest pageRequest, String search, AuditLogChangesetProjection projection) Returns a list of unique items of the chosen type that exist in changesets matching the specified search restriction.
javax.ws.rs.core.Response	searchAuditLog(AuditLogQueryRestDTO searchRestriction, RestPageRequest pageRequest) Searches audit log for entries matching given restrictions.
AuditLogConfigurationEntity	setConfiguration(AuditLogConfigurationEntity newConfiguration) Saves new audit log configuration

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditResource

public AuditResource(AuditController auditController)

Method Detail

searchAuditLog

@POST
 @Path(value="query")
 @ExperimentalApi
public javax.ws.rs.core.Response searchAuditLog(AuditLogQueryRestDTO searchRestriction,
                                                                                              @Context
                                                                                              RestPageRequest pageRequest)

Searches audit log for entries matching given restrictions.

Multiple restrictions for a single category (for example multiple authors) are treated as logical ORs - the resulting changesets must match at least one of them. Restrictions of different categories (for example specifying an author and event type) are treated as logical ANDs - the resulting changesets must match all of them.

This resource is experimental and may be subject to change.

This resource supports pagination.

Parameters:

searchRestriction - the restriction

getFilterValues

@POST
 @Path(value="query/filter")
 @ExperimentalApi
public javax.ws.rs.core.Response getFilterValues(AuditLogQueryRestDTO searchRestriction,
                                                                                                      @Context
                                                                                                      RestPageRequest pageRequest,
                                                                                                      @QueryParam(value="search")
                                                                                                      String search,
                                                                                                      @QueryParam(value="projection")
                                                                                                      AuditLogChangesetProjection projection)

Returns a list of unique items of the chosen type that exist in changesets matching the specified search restriction.

Parameters:

search - returns only results with a name starting with the given value

projection - the item type requested. Currently supports 'EVENT_TYPE', 'AUTHOR', 'ENTITY_USER', 'ENTITY_GROUP', 'ENTITY_DIRECTORY', 'ENTITY_APPLICATION', 'SOURCE'

See Also:

AuditLogChangesetProjection

addChangeset

@POST
public javax.ws.rs.core.Response addChangeset(AuditLogChangesetRestDTO changeset)

Stores a changeset in the audit log

Parameters:

changeset - the changeset to store

getConfiguration

@GET
 @Path(value="/configuration")
public AuditLogConfigurationEntity getConfiguration()

Retrieves current audit log configuration

setConfiguration

@PUT
 @Path(value="/configuration")
public AuditLogConfigurationEntity setConfiguration(AuditLogConfigurationEntity newConfiguration)

Saves new audit log configuration