com.atlassian.audit.api

Class AuditQuery

java.lang.Object

com.atlassian.audit.api.AuditQuery

public class AuditQuery
extends Object

Represents fields to be used for filtering AuditEntity. Following fields can be used in query -

• actions - Matches all the entities that have one of these actions. If not specified this filter will not be used
• categories - Matches all the entities that have one of these categories. If not specified this filter will not be used
• from - Matches all the entities logged starting from this time. Default value is 7 days ago
• to - Matches all the entities logged until this time. Default value is current time
• limit - Maximum number of records to return. Default value is 100
• offset - Number of matched records to skip. Default value is 0
• resourceId and resourceType - Matches all the entities that have affectedObject of given ID and type. If not specified this filter will not be used
• userIds - Matches all the entities that have user ID belonging to one of these IDs. If not specified this filter will not be used

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuditQuery.AuditResourceIdentifier
static class	AuditQuery.Builder

Method Summary

Modifier and Type	Method and Description
static AuditQuery.Builder	builder()
static AuditQuery.Builder	builder(AuditQuery query)
boolean	equals(Object o)
Set<String>	getActions()
Set<String>	getCategories()
Optional<Instant>	getFrom()
Optional<Long>	getMaxId()
Optional<Long>	getMinId()
Optional<String>	getResourceId() Deprecated. since release 1.5.0, replaced by getResources()
Set<AuditQuery.AuditResourceIdentifier>	getResources() The DB query will be conducted as: AND between different resource types OR with the same resource type For example, given Project P1 Repository R11 Repository R12 Project P2 Repository R21 Repository R22 then the resource filter [Project:P1] returns events belong to [R11, R12] the resource filter [Project:P1,Repository:R11] returns events belong to [R11] the resource filter [Project:P1,Repository:R11,Repository:R12] returns events belong to [R11,R12] the resource filter [Project:P1,Project:P2,Repository:R11,Repository:R12] returns events belong to [R11,R12] the resource filter [Project:P1,Project:P2,Repository:R11,Repository:R12, Repository:R21] returns events belong to [R11,R12,R21] the resource filter [Project:P1,Repository:R21,Repository:R22] returns no result
Optional<String>	getResourceType() Deprecated. since release 1.5.0, replaced by getResources()
Optional<String>	getSearchText()
Optional<Instant>	getTo()
Set<String>	getUserIds()
boolean	hasFilter()
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Detail

getActions

@Nonnull
public Set<String> getActions()

Returns:

the set of actions that should match AuditEntity to be queried. Empty list means this filter is not applied.

getCategories

@Nonnull
public Set<String> getCategories()

Returns:

the set of categories that should match AuditEntity to be queried. Empty list means this filter is not applied.

getFrom

@Nonnull
public Optional<Instant> getFrom()

Returns:

the start time from which AuditEntity needs to be queried.

getTo

@Nonnull
public Optional<Instant> getTo()

Returns:

the end time till which AuditEntity needs to be queried.

getResourceId

@Deprecated
 @Nonnull
public Optional<String> getResourceId()

Deprecated. since release 1.5.0, replaced by getResources()

Returns:

the ID of the first AuditResource returned by getResources()

getResourceType

@Deprecated
 @Nonnull
public Optional<String> getResourceType()

Deprecated. since release 1.5.0, replaced by getResources()

Returns:

the type of the first AuditResource returned by getResources()

getResources

@Nonnull
public Set<AuditQuery.AuditResourceIdentifier> getResources()

The DB query will be conducted as:

• AND between different resource types
• OR with the same resource type

For example, given

• Project P1
  • Repository R11
  • Repository R12
• Project P2
  • Repository R21
  • Repository R22

then

• the resource filter [Project:P1] returns events belong to [R11, R12]
• the resource filter [Project:P1,Repository:R11] returns events belong to [R11]
• the resource filter [Project:P1,Repository:R11,Repository:R12] returns events belong to [R11,R12]
• the resource filter [Project:P1,Project:P2,Repository:R11,Repository:R12] returns events belong to [R11,R12]
• the resource filter [Project:P1,Project:P2,Repository:R11,Repository:R12, Repository:R21] returns events belong to [R11,R12,R21]
• the resource filter [Project:P1,Repository:R21,Repository:R22] returns no result

Returns:

a set of AuditResource's. At least one of them should be present in AuditEntity.getAffectedObjects() for that entity to be found.

getUserIds

@Nonnull
public Set<String> getUserIds()

Returns:

the set of user IDs that should match AuditEntity.getAuthor() to be queried. Empty list means this filter is not applied.

getSearchText

@Nonnull
public Optional<String> getSearchText()

Returns:

the text that need to be matched against action, category, resource name, user name or IP address in AuditEntity

getMinId

@Nonnull
public Optional<Long> getMinId()

Returns:

the inclusive lower limit of Id, only applicable for DB storage

getMaxId

@Nonnull
public Optional<Long> getMaxId()

Returns:

the inclusive upper limit of Id, only applicable for DB storage

builder

public static AuditQuery.Builder builder()

builder

public static AuditQuery.Builder builder(AuditQuery query)

hasFilter

public boolean hasFilter()

Returns:

whether any filters have been applied

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object