Package com.atlassian.bamboo.persister

Class AuditLogHibernateDao

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate5.support.HibernateDaoSupport

com.atlassian.bamboo.persistence3.StatelessSessionHibernateDaoSupport

com.atlassian.bamboo.persistence3.BambooHibernateObjectDao<AuditLogEntry>

com.atlassian.bamboo.persister.AuditLogHibernateDao

All Implemented Interfaces:

BambooObjectDao<AuditLogEntry>, AuditLogDao, org.springframework.beans.factory.InitializingBean

public class AuditLogHibernateDao
extends BambooHibernateObjectDao<AuditLogEntry>
implements AuditLogDao

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

Constructors

Constructor	Description
AuditLogHibernateDao()

Method Summary

Modifier and Type	Method	Description
long	countAuditLogMessagesForEntity(@NotNull String entityId, @Nullable AuditLogEntityType entityType, long startDate, long endDate, @Nullable String searchTerm)	Retrieve the number of audit log messages recorded against the specified entity between the startDate and endDate (inclusive).
long	countAuditLogMessagesForEntity(@NotNull String entityId, AuditLogEntityType entityType, long startDate, long endDate)	Retrieve the number of audit log messages recorded against the specified entity between the startDate and endDate (inclusive).
long	countGlobalAuditLogMessages()	Count global audit log messages.
long	countGlobalAuditLogMessages(@Nullable String searchTerm)	Count global audit log messages.
void	deleteAllAuditLogMessages()	Delete all audit logs
void	deleteAuditLogMessagesByTypeAndEntityId(String entityId, AuditLogEntityType entityType)
@NotNull Collection<? extends AuditLogEntry>	findAll()
List<AuditLogEntry>	getAgentAuditLogsMessagesByAgentName(@NotNull String agentName)	Provide a list of audit log messages filter by Agent Name.
List<AuditLogEntry>	getAgentAuditLogsMessagesByAgentName(String agentName, @Nullable String searchTerm)	Provide a list of audit log messages filter by Agent Name and the Search Term.
List<AuditLogEntry>	getAuditLogMessagesForEntity(@NotNull String entityId, @Nullable AuditLogEntityType entityType, long startDate, long endDate, int firstResult, int maxResults)
List<AuditLogEntry>	getAuditLogMessagesForEntity(@NotNull String entityId, @Nullable AuditLogEntityType entityType, long startDate, long endDate, int firstResult, int maxResults, @Nullable String searchTerm)	Provide a paginated list of all audit log messages written against an entity between input dates and requested search term.
List<AuditLogEntry>	getAuditLogMessagesForPlan(ImmutablePlan plan, long startDate, long endDate, int firstResult, int maxResults)	Deprecated. used only in tests
List<AuditLogEntry>	getGlobalAuditLogMessages()	Provide a list of all audit log messages written against the system.
List<AuditLogEntry>	getGlobalAuditLogMessages(int firstResult, int maxResults)	Provide a page of a list of all audit log messages written against the system.
List<AuditLogEntry>	getGlobalAuditLogMessages(int firstResult, int maxResults, @Nullable String searchTerm)	Provide a page of a list of all audit log messages written against the system filtered by delivered searchTerm.
long	scrollAuditLogsForExport(Consumer<AuditLogEntry> consumer)	Scroll through all AuditLogEntry records and pass them to consumer

Methods inherited from class com.atlassian.bamboo.persistence3.BambooHibernateObjectDao

convertSearchTermToLikeExpression, countAll, countWithRestriction, delete, deleteAll, executeCountQuery, findAll, findById, merge, save, saveAll

Methods inherited from class com.atlassian.bamboo.persistence3.StatelessSessionHibernateDaoSupport

getCacheAwareHibernateTemplate

Methods inherited from class org.springframework.orm.hibernate5.support.HibernateDaoSupport

checkDaoConfig, createHibernateTemplate, currentSession, getHibernateTemplate, getSessionFactory, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.persistence3.BambooObjectDao

countAll, countWithRestriction, delete, deleteAll, findAll, findById, merge, save, saveAll

Constructor Detail

AuditLogHibernateDao

public AuditLogHibernateDao()

Method Detail

getAuditLogMessagesForEntity

public List<AuditLogEntry> getAuditLogMessagesForEntity(@NotNull
                                                        @NotNull String entityId,
                                                        @Nullable
                                                        @Nullable AuditLogEntityType entityType,
                                                        long startDate,
                                                        long endDate,
                                                        int firstResult,
                                                        int maxResults)

Specified by:

getAuditLogMessagesForEntity in interface AuditLogDao

getAuditLogMessagesForEntity

public List<AuditLogEntry> getAuditLogMessagesForEntity(@NotNull
                                                        @NotNull String entityId,
                                                        @Nullable
                                                        @Nullable AuditLogEntityType entityType,
                                                        long startDate,
                                                        long endDate,
                                                        int firstResult,
                                                        int maxResults,
                                                        @Nullable
                                                        @Nullable String searchTerm)

Description copied from interface: AuditLogDao

Provide a paginated list of all audit log messages written against an entity between input dates and requested search term.

Specified by:

getAuditLogMessagesForEntity in interface AuditLogDao

Parameters:

entityId - to find audit messages for

entityType - type of entity associated with the entityId

startDate - if specified, messages before this date will be excluded. Represented as milliseconds after January 1, 1970 00:00:00 GMT. Passing 0 or a negative number will not set a start range.

endDate - if specified, messages after this date will be excluded. Represented as milliseconds after January 1, 1970 00:00:00 GMT. Passing 0 or a negative number will not set an end range.

firstResult - if specified marks a first item to be returned, passing 0 or negative number will effect with returning elements from the beginning

maxResults - if specified marks a total number of items to be returned, passing 0 or negative number will effect with returning all elements until the end

searchTerm - value against which the results are filtered out

Returns:

List of audit log entries for the given entity

countAuditLogMessagesForEntity

public long countAuditLogMessagesForEntity(@NotNull
                                           @NotNull String entityId,
                                           AuditLogEntityType entityType,
                                           long startDate,
                                           long endDate)

Description copied from interface: AuditLogDao

Retrieve the number of audit log messages recorded against the specified entity between the startDate and endDate (inclusive). This is equivalent to but usually faster than checking the size of AuditLogDao.getAuditLogMessagesForPlan(ImmutablePlan, long, long, int, int).

Specified by:

countAuditLogMessagesForEntity in interface AuditLogDao

startDate - only messages at or after this time will be retrieved. Represented as milliseconds after January 1, 1970 00:00:00 GMT. Passing 0 or a negative number will not set a start range.

endDate - only messages at or before this time will be retrieved. Represented as milliseconds after January 1, 1970 00:00:00 GMT. Passing 0 or a negative number will not set an end range.

Returns:

the number of audit messages found. Always 0 or more.

countAuditLogMessagesForEntity

public long countAuditLogMessagesForEntity(@NotNull
                                           @NotNull String entityId,
                                           @Nullable
                                           @Nullable AuditLogEntityType entityType,
                                           long startDate,
                                           long endDate,
                                           @Nullable
                                           @Nullable String searchTerm)

Description copied from interface: AuditLogDao

Retrieve the number of audit log messages recorded against the specified entity between the startDate and endDate (inclusive). This is equivalent to but usually faster than checking the size of AuditLogDao.getAuditLogMessagesForPlan(ImmutablePlan, long, long, int, int).

Specified by:

countAuditLogMessagesForEntity in interface AuditLogDao

startDate - only messages at or after this time will be retrieved. Represented as milliseconds after January 1, 1970 00:00:00 GMT. Passing 0 or a negative number will not set a start range.

endDate - only messages at or before this time will be retrieved. Represented as milliseconds after January 1, 1970 00:00:00 GMT. Passing 0 or a negative number will not set an end range.

searchTerm - value against which the results are filtered out

Returns:

the number of audit messages found. Always 0 or more.

getGlobalAuditLogMessages

public List<AuditLogEntry> getGlobalAuditLogMessages()

Description copied from interface: AuditLogDao

Provide a list of all audit log messages written against the system.

Specified by:

getGlobalAuditLogMessages in interface AuditLogDao

Returns:

a list of audit log entries for the system

getGlobalAuditLogMessages

public List<AuditLogEntry> getGlobalAuditLogMessages(int firstResult,
                                                     int maxResults)

Description copied from interface: AuditLogDao

Provide a page of a list of all audit log messages written against the system.

Specified by:

getGlobalAuditLogMessages in interface AuditLogDao

Returns:

a list of audit log entries for the system

getGlobalAuditLogMessages

public List<AuditLogEntry> getGlobalAuditLogMessages(int firstResult,
                                                     int maxResults,
                                                     @Nullable
                                                     @Nullable String searchTerm)

Description copied from interface: AuditLogDao

Provide a page of a list of all audit log messages written against the system filtered by delivered searchTerm.

Specified by:

getGlobalAuditLogMessages in interface AuditLogDao

searchTerm - the phrase against which the search will be made

Returns:

a list of audit log entries for the system

countGlobalAuditLogMessages

public long countGlobalAuditLogMessages()

Description copied from interface: AuditLogDao

Count global audit log messages.

Specified by:

countGlobalAuditLogMessages in interface AuditLogDao

Returns:

number of potential results

countGlobalAuditLogMessages

public long countGlobalAuditLogMessages(@Nullable
                                        @Nullable String searchTerm)

Description copied from interface: AuditLogDao

Count global audit log messages.

Specified by:

countGlobalAuditLogMessages in interface AuditLogDao

Parameters:

searchTerm - the phrase against which the results will be counted

Returns:

number of potential results

getAgentAuditLogsMessagesByAgentName

public List<AuditLogEntry> getAgentAuditLogsMessagesByAgentName(@NotNull
                                                                @NotNull String agentName)

Description copied from interface: AuditLogDao

Provide a list of audit log messages filter by Agent Name.

Specified by:

getAgentAuditLogsMessagesByAgentName in interface AuditLogDao

Parameters:

agentName - the name of the agent

Returns:

List of audit log entries for the given Agent Name.

getAgentAuditLogsMessagesByAgentName

public List<AuditLogEntry> getAgentAuditLogsMessagesByAgentName(String agentName,
                                                                @Nullable
                                                                @Nullable String searchTerm)

Description copied from interface: AuditLogDao

Provide a list of audit log messages filter by Agent Name and the Search Term.

Specified by:

getAgentAuditLogsMessagesByAgentName in interface AuditLogDao

Parameters:

agentName - the name of the agent

searchTerm - the value searched in the Agent related audit log

Returns:

List of audit log entries for the given Agent Name and Search Term.

getAuditLogMessagesForPlan

@Deprecated
public List<AuditLogEntry> getAuditLogMessagesForPlan(ImmutablePlan plan,
                                                      long startDate,
                                                      long endDate,
                                                      int firstResult,
                                                      int maxResults)

Deprecated.

used only in tests

Specified by:

getAuditLogMessagesForPlan in interface AuditLogDao

deleteAllAuditLogMessages

public void deleteAllAuditLogMessages()

Description copied from interface: AuditLogDao

Delete all audit logs

Specified by:

deleteAllAuditLogMessages in interface AuditLogDao

deleteAuditLogMessagesByTypeAndEntityId

public void deleteAuditLogMessagesByTypeAndEntityId(String entityId,
                                                    AuditLogEntityType entityType)

Specified by:

deleteAuditLogMessagesByTypeAndEntityId in interface AuditLogDao

findAll

@NotNull
public @NotNull Collection<? extends AuditLogEntry> findAll()

Specified by:

findAll in interface AuditLogDao

scrollAuditLogsForExport

public long scrollAuditLogsForExport(Consumer<AuditLogEntry> consumer)

Description copied from interface: AuditLogDao

Scroll through all AuditLogEntry records and pass them to consumer

Specified by:

scrollAuditLogsForExport in interface AuditLogDao