com.atlassian.bamboo.persister

Class DefaultAuditLogService

java.lang.Object

com.atlassian.bamboo.persister.DefaultAuditLogService

All Implemented Interfaces:

AuditLogService

public class DefaultAuditLogService
extends Object
implements AuditLogService

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.persister.AuditLogService

AuditLogService.FieldChange

Constructor Summary

Constructors

Constructor and Description
DefaultAuditLogService(AuditLogDao auditLogDao, BambooAuthenticationContext authenticationContext, AdministrationConfigurationAccessor administrationConfigurationAccessor, AdministrationConfigurationPersister administrationConfigurationPersister)

Method Summary

Modifier and Type	Method and Description
long	countAuditLogMessagesForEntity(String entityId, AuditLogEntityType entityType, long startDate, long endDate)
long	countAuditLogMessagesForPlan(ImmutablePlan plan) Count audit log messages for plan
long	countAuditLogMessagesForPlan(ImmutablePlan plan, long startDate, long endDate) Count audit log messages for plan in a given time period
long	countGlobalAuditLogMessages() Count global audit log messages.
List<AuditLogEntry>	getAgentAuditLogsMessagesByAgentName(String agentName) Provide a list of audit log messages filter by Agent Name
List<AuditLogEntry>	getAuditLogMessagesForEntity(String entityId, AuditLogEntityType entityType, long startDate, long endDate, int firstResult, int maxResults)
List<AuditLogEntry>	getAuditLogMessagesForPlan(ImmutablePlan plan, long startDate, long endDate, int firstResult, int maxResults) Provide a paginated list of all audit log messages written against a plan between input dates.
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.
boolean	hasAuditLogMessagesForPlan(ImmutablePlan plan, long startDate, long endDate) Determine whether any log messages have been recorded against the specified plan between the startDate and endDate (inclusive).
boolean	isEnabled() Returns whether logging is enabled
void	log(AuditLogEntry msg) Add a log to the audit log.
void	log(Collection<AuditLogService.FieldChange> changes, Key key) Add 'field change' messages to the system audit log.
void	log(Iterable<AuditLogService.FieldChange> changes, AuditLogEntity entity) Add 'field change' messages to the system audit log.
void	log(Iterable<AuditLogService.FieldChange> changes, String entityId, AuditLogEntityType entityType, String childKey, AuditLogEntity entity)
void	log(String msg) Add a message to the system audit log.
void	log(String msg, Key key, AuditLogEntityType entityType) Add a message to the plans audit log.
void	log(String msg, Key key, AuditLogEntityType entityType, AuditLogEntity entity) Add a message to the entity's audit log.
void	log(String username, String msg, Key key, AuditLogEntityType entityType)
void	log(String username, String msg, Key key, AuditLogEntityType entityType, AuditLogEntity field)
void	log(String fieldName, String oldValue, String newValue, Key plan) Add 'field change' message to the system audit log.
void	log(String fieldName, String oldValue, String newValue, Key key, AuditLogEntityType entityType, AuditLogEntity entity) Add 'field change' message to the system audit log.
void	log(com.atlassian.user.User user, String msg) Add a message to the system audit log.
void	log(com.atlassian.user.User user, String msg, Key key, AuditLogEntityType entityType) Add a message to the entity's audit log.
void	log(com.atlassian.user.User user, String msg, Key key, AuditLogEntityType entityType, AuditLogEntity entity) Add a message to the plans audit log.
void	removeAllAuditLogMessages() Deletes all log messages in the database
void	removeAuditLogMessagesByTypeAndEntityId(String entityId, AuditLogEntityType entityType)
void	removeAuditLogMessagesForPlan(ImmutablePlan plan) Deletes all log messages for a given plan
void	removeGlobalAuditLogMessages() Deletes all Global audit log messages
void	setEnabled(boolean enabled) sets whether logging is enabled or not

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.persister.AuditLogService

log, log, log, log, log

Constructor Detail

DefaultAuditLogService

public DefaultAuditLogService(AuditLogDao auditLogDao,
                              BambooAuthenticationContext authenticationContext,
                              AdministrationConfigurationAccessor administrationConfigurationAccessor,
                              AdministrationConfigurationPersister administrationConfigurationPersister)

Method Detail

log

public void log(@NotNull
                AuditLogEntry msg)

Description copied from interface: AuditLogService

Add a log to the audit log.

Specified by:

log in interface AuditLogService

Parameters:

msg - (fully populated) to be logged

log

public void log(@NotNull
                String msg)

Description copied from interface: AuditLogService

Add a message to the system audit log. Message will be logged against the user that is currently set in the authentication context.

Specified by:

log in interface AuditLogService

Parameters:

msg - the text of the message to add.

log

public void log(@Nullable
                com.atlassian.user.User user,
                @NotNull
                String msg)

Description copied from interface: AuditLogService

Add a message to the system audit log. Message will be logged against the current logged in user (if available)

Specified by:

log in interface AuditLogService

Parameters:

user - who caused the event being logged

msg - the text of the message to add.

log

public void log(@NotNull
                String msg,
                @Nullable
                Key key,
                AuditLogEntityType entityType)

Description copied from interface: AuditLogService

Add a message to the plans audit log. Message will be logged against the current logged in user (if available)

Specified by:

log in interface AuditLogService

Parameters:

msg - to log

key - to log it against

log

public void log(@NotNull
                String msg,
                @Nullable
                Key key,
                AuditLogEntityType entityType,
                @Nullable
                AuditLogEntity entity)

Description copied from interface: AuditLogService

Add a message to the entity's audit log. Message will be logged against the current logged in user (if available)

Specified by:

log in interface AuditLogService

Parameters:

msg - to log

key - to log it against

entity - job's task, chain' stage etc. to log against

log

public void log(@Nullable
                com.atlassian.user.User user,
                @NotNull
                String msg,
                @Nullable
                Key key,
                AuditLogEntityType entityType)

Description copied from interface: AuditLogService

Add a message to the entity's audit log. Message will be logged against provided user

Specified by:

log in interface AuditLogService

Parameters:

user - who caused the event being logged

msg - to be logged

key - to log the message against.

log

public void log(@Nullable
                com.atlassian.user.User user,
                @NotNull
                String msg,
                @Nullable
                Key key,
                AuditLogEntityType entityType,
                @Nullable
                AuditLogEntity entity)

Description copied from interface: AuditLogService

Add a message to the plans audit log. Message will be logged against provided user

Specified by:

log in interface AuditLogService

Parameters:

user - who caused the event being logged

msg - to be logged

key - to log the message against.

entity - header of job's task, chain' stage etc. to log against

log

public void log(@Nullable
                String username,
                @NotNull
                String msg,
                @Nullable
                Key key,
                AuditLogEntityType entityType)

log

public void log(@Nullable
                String username,
                @NotNull
                String msg,
                @Nullable
                Key key,
                @Nullable
                AuditLogEntityType entityType,
                @Nullable
                AuditLogEntity field)

getAuditLogMessagesForPlan

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

Description copied from interface: AuditLogService

Provide a paginated list of all audit log messages written against a plan between input dates.

Specified by:

getAuditLogMessagesForPlan in interface AuditLogService

Parameters:

plan - to find audit messages for

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

Returns:

List of audit log entries for the given plan

getAuditLogMessagesForEntity

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

Specified by:

getAuditLogMessagesForEntity in interface AuditLogService

hasAuditLogMessagesForPlan

public boolean hasAuditLogMessagesForPlan(@NotNull
                                          ImmutablePlan plan,
                                          long startDate,
                                          long endDate)

Description copied from interface: AuditLogService

Determine whether any log messages have been recorded against the specified plan between the startDate and endDate (inclusive). This is equivalent to but usually faster than checking the emptiness of AuditLogService.getAuditLogMessagesForPlan(ImmutablePlan, long, long, int, int).

Specified by:

hasAuditLogMessagesForPlan in interface AuditLogService

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.

removeAuditLogMessagesForPlan

public void removeAuditLogMessagesForPlan(@NotNull
                                          ImmutablePlan plan)

Description copied from interface: AuditLogService

Deletes all log messages for a given plan

Specified by:

removeAuditLogMessagesForPlan in interface AuditLogService

Parameters:

plan - to delete messages for

removeAuditLogMessagesByTypeAndEntityId

public void removeAuditLogMessagesByTypeAndEntityId(@NotNull
                                                    String entityId,
                                                    @Nullable
                                                    AuditLogEntityType entityType)

Specified by:

removeAuditLogMessagesByTypeAndEntityId in interface AuditLogService

removeGlobalAuditLogMessages

public void removeGlobalAuditLogMessages()

Description copied from interface: AuditLogService

Deletes all Global audit log messages

Specified by:

removeGlobalAuditLogMessages in interface AuditLogService

removeAllAuditLogMessages

public void removeAllAuditLogMessages()

Description copied from interface: AuditLogService

Deletes all log messages in the database

Specified by:

removeAllAuditLogMessages in interface AuditLogService

getGlobalAuditLogMessages

public List<AuditLogEntry> getGlobalAuditLogMessages()

Description copied from interface: AuditLogService

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

Specified by:

getGlobalAuditLogMessages in interface AuditLogService

Returns:

a list of audit log entries for the system

getGlobalAuditLogMessages

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

Description copied from interface: AuditLogService

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

Specified by:

getGlobalAuditLogMessages in interface AuditLogService

Returns:

a list of audit log entries for the system

countGlobalAuditLogMessages

public long countGlobalAuditLogMessages()

Description copied from interface: AuditLogService

Count global audit log messages.

Specified by:

countGlobalAuditLogMessages in interface AuditLogService

countAuditLogMessagesForPlan

public long countAuditLogMessagesForPlan(@NotNull
                                         ImmutablePlan plan)

Description copied from interface: AuditLogService

Count audit log messages for plan

Specified by:

countAuditLogMessagesForPlan in interface AuditLogService

countAuditLogMessagesForPlan

public long countAuditLogMessagesForPlan(@NotNull
                                         ImmutablePlan plan,
                                         long startDate,
                                         long endDate)

Description copied from interface: AuditLogService

Count audit log messages for plan in a given time period

Specified by:

countAuditLogMessagesForPlan in interface AuditLogService

countAuditLogMessagesForEntity

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

Specified by:

countAuditLogMessagesForEntity in interface AuditLogService

log

public void log(@NotNull
                Collection<AuditLogService.FieldChange> changes,
                @Nullable
                Key key)

Description copied from interface: AuditLogService

Add 'field change' messages to the system audit log. The messages will be logged against the user that is currently set in the authentication context. If key is not null the message will be logged against the given entity.

Specified by:

log in interface AuditLogService

log

public void log(@NotNull
                Iterable<AuditLogService.FieldChange> changes,
                @Nullable
                String entityId,
                @Nullable
                AuditLogEntityType entityType,
                @Nullable
                String childKey,
                @Nullable
                AuditLogEntity entity)

Specified by:

log in interface AuditLogService

log

public void log(@NotNull
                Iterable<AuditLogService.FieldChange> changes,
                @Nullable
                AuditLogEntity entity)

Description copied from interface: AuditLogService

Add 'field change' messages to the system audit log. The messages will be logged against the user that is currently set in the authentication context. The message will be logged with the given entity type.

Specified by:

log in interface AuditLogService

log

public void log(@NotNull
                String fieldName,
                @Nullable
                String oldValue,
                @Nullable
                String newValue,
                @Nullable
                Key plan)

Description copied from interface: AuditLogService

Add 'field change' message to the system audit log. The messages will be logged against the user that is currently set in the authentication context. If plan key is not null the message will be logged against the given plan.

Specified by:

log in interface AuditLogService

log

public void log(@NotNull
                String fieldName,
                @Nullable
                String oldValue,
                @Nullable
                String newValue,
                @Nullable
                Key key,
                @Nullable
                AuditLogEntityType entityType,
                @Nullable
                AuditLogEntity entity)

Description copied from interface: AuditLogService

Add 'field change' message to the system audit log. The messages will be logged against the user that is currently set in the authentication context. If plan key is not null the message will be logged against the given plan.

Specified by:

log in interface AuditLogService

entity - job's task or chain's stage affected by the change

isEnabled

public boolean isEnabled()

Description copied from interface: AuditLogService

Returns whether logging is enabled

Specified by:

isEnabled in interface AuditLogService

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: AuditLogService

sets whether logging is enabled or not

Specified by:

setEnabled in interface AuditLogService

getAgentAuditLogsMessagesByAgentName

public List<AuditLogEntry> getAgentAuditLogsMessagesByAgentName(String agentName)

Description copied from interface: AuditLogService

Provide a list of audit log messages filter by Agent Name

Specified by:

getAgentAuditLogsMessagesByAgentName in interface AuditLogService

Parameters:

agentName - the name of the agent

Returns:

List of audit log entries for the given Agent Name