com.atlassian.audit.api

Interface AuditSearchService

public interface AuditSearchService

Potential API

Implement to allow inspection of the AuditEntitys that have been consumed.

As per AuditConsumer it is expected that we will have multiple implementations eg: inspect entities recorded in a relational database inspect entities recorded in a file

Method Summary

Modifier and Type	Method and Description
long	count(AuditQuery query)
default Page<AuditEntity,AuditEntityCursor>	findBy(AuditQuery query, PageRequest<AuditEntityCursor> pageRequest) Use to find AuditEntitys that have been consumed
Page<AuditEntity,AuditEntityCursor>	findBy(AuditQuery query, PageRequest<AuditEntityCursor> pageRequest, int scanLimit) Use to find AuditEntitys that have been consumed while protecting data store from being overloaded by expensive queries.
void	stream(AuditQuery query, int offset, int limit, Consumer<AuditEntity> consumer) Searches database for AuditEntities and feeds the results one by one to the consumer

Method Detail

findBy

@Nonnull
default Page<AuditEntity,AuditEntityCursor> findBy(@Nonnull
                                                            AuditQuery query,
                                                            @Nonnull
                                                            PageRequest<AuditEntityCursor> pageRequest)
                                                     throws TimeoutException

Use to find AuditEntitys that have been consumed

Parameters:

query - filter the entities to be returned.

pageRequest - specifies which page of entities to be returned.

Throws:

TimeoutException

findBy

@Nonnull
Page<AuditEntity,AuditEntityCursor> findBy(@Nonnull
                                                    AuditQuery query,
                                                    @Nonnull
                                                    PageRequest<AuditEntityCursor> pageRequest,
                                                    int scanLimit)
                                             throws TimeoutException

Use to find AuditEntitys that have been consumed while protecting data store from being overloaded by expensive queries.

Parameters:

query - filter the entities to be returned.

pageRequest - specifies which page of entities to be returned.

scanLimit - the maximum number of entities to be scanned in the inverse insertion order, the Integer.MAX_VALUE which means there is no limit.

Throws:

TimeoutException

stream

void stream(@Nonnull
            AuditQuery query,
            int offset,
            int limit,
            @Nonnull
            Consumer<AuditEntity> consumer)
     throws TimeoutException

Searches database for AuditEntities and feeds the results one by one to the consumer

Parameters:

query - to filter the entities being returned

offset - number of records to skip

limit - maximum number of records to produce

consumer - consumes the AuditEntity

Throws:

TimeoutException

count

long count(@Nullable
           AuditQuery query)
    throws TimeoutException

Parameters:

query - filter used to search entities, null filter will count all entities

Returns:

number of entities match the filter

Throws:

TimeoutException