public class DefaultAuditLogService extends Object implements AuditLogService
AuditLogService.FieldChange| Constructor and Description |
|---|
DefaultAuditLogService(AuditLogDao auditLogDao,
BambooAuthenticationContext authenticationContext,
AdministrationConfigurationAccessor administrationConfigurationAccessor,
AdministrationConfigurationPersister administrationConfigurationPersister) |
| Modifier and Type | Method and Description |
|---|---|
List<AuditLogEntry> |
getAgentAuditLogsMessagesByAgentName(String agentName)
Provide a list of audit log messages filter by Agent Name
|
List<AuditLogEntry> |
getAuditLogMessagesForPlan(ImmutablePlan plan)
Provide a list of all audit log messages written against a plan.
|
List<AuditLogEntry> |
getAuditLogMessagesForPlan(ImmutablePlan plan,
long startDate,
long endDate)
Provide a 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.
|
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 plan)
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(String msg)
Add a message to the system audit log.
|
void |
log(String msg,
Key planKey)
Add a message to the plans audit log.
|
void |
log(String msg,
Key planKey,
AuditLogEntity entity)
Add a message to the plans audit log.
|
void |
log(String username,
String msg,
Key planKey) |
void |
log(String username,
String msg,
Key planKey,
AuditLogEntity entity) |
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 planKey,
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 planKey)
Add a message to the plans audit log.
|
void |
log(com.atlassian.user.User user,
String msg,
Key planKey,
AuditLogEntity entity)
Add a message to the plans audit log.
|
void |
removeAllAuditLogMessages()
Deletes all log messages in the database
|
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
|
public DefaultAuditLogService(AuditLogDao auditLogDao, BambooAuthenticationContext authenticationContext, AdministrationConfigurationAccessor administrationConfigurationAccessor, AdministrationConfigurationPersister administrationConfigurationPersister)
public void log(@NotNull
AuditLogEntry msg)
AuditLogServicelog in interface AuditLogServicemsg - (fully populated) to be loggedpublic void log(@NotNull
String msg)
AuditLogServicelog in interface AuditLogServicemsg - the text of the message to add.public void log(@Nullable
com.atlassian.user.User user,
@NotNull
String msg)
AuditLogServicelog in interface AuditLogServiceuser - who caused the event being loggedmsg - the text of the message to add.public void log(@NotNull
String msg,
@Nullable
Key planKey)
AuditLogServicelog in interface AuditLogServicemsg - to logplanKey - to log it againstpublic void log(@NotNull
String msg,
@Nullable
Key planKey,
@Nullable
AuditLogEntity entity)
AuditLogServicelog in interface AuditLogServicemsg - to logplanKey - to log it againstentity - job's task, chain' stage etc. to log againstpublic void log(@Nullable
com.atlassian.user.User user,
@NotNull
String msg,
@Nullable
Key planKey)
AuditLogServicelog in interface AuditLogServiceuser - who caused the event being loggedmsg - to be loggedplanKey - to log the message against.public void log(@Nullable
com.atlassian.user.User user,
@NotNull
String msg,
@Nullable
Key planKey,
@Nullable
AuditLogEntity entity)
AuditLogServicelog in interface AuditLogServiceuser - who caused the event being loggedmsg - to be loggedplanKey - to log the message against.entity - header of job's task, chain' stage etc. to log againstpublic void log(@Nullable
String username,
@NotNull
String msg,
@Nullable
Key planKey,
@Nullable
AuditLogEntity entity)
public List<AuditLogEntry> getAuditLogMessagesForPlan(@NotNull ImmutablePlan plan)
AuditLogServicegetAuditLogMessagesForPlan in interface AuditLogServiceplan - to find audit messages forpublic List<AuditLogEntry> getAuditLogMessagesForPlan(@NotNull ImmutablePlan plan, long startDate, long endDate)
AuditLogServicegetAuditLogMessagesForPlan in interface AuditLogServiceplan - to find audit messages forstartDate - 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.public boolean hasAuditLogMessagesForPlan(@NotNull
ImmutablePlan plan,
long startDate,
long endDate)
AuditLogServiceAuditLogService.getAuditLogMessagesForPlan(ImmutablePlan, long, long).hasAuditLogMessagesForPlan in interface AuditLogServicestartDate - 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.public void removeAuditLogMessagesForPlan(@NotNull
ImmutablePlan plan)
AuditLogServiceremoveAuditLogMessagesForPlan in interface AuditLogServiceplan - to delete messages forpublic void removeGlobalAuditLogMessages()
AuditLogServiceremoveGlobalAuditLogMessages in interface AuditLogServicepublic void removeAllAuditLogMessages()
AuditLogServiceremoveAllAuditLogMessages in interface AuditLogServicepublic List<AuditLogEntry> getGlobalAuditLogMessages()
AuditLogServicegetGlobalAuditLogMessages in interface AuditLogServicepublic void log(@NotNull
Collection<AuditLogService.FieldChange> changes,
@Nullable
Key plan)
AuditLogServicelog in interface AuditLogServicepublic void log(@NotNull
Iterable<AuditLogService.FieldChange> changes,
@Nullable
AuditLogEntity entity)
AuditLogServicelog in interface AuditLogServicepublic void log(@NotNull
String fieldName,
@Nullable
String oldValue,
@Nullable
String newValue,
@Nullable
Key plan)
AuditLogServicelog in interface AuditLogServicepublic void log(@NotNull
String fieldName,
@Nullable
String oldValue,
@Nullable
String newValue,
@Nullable
Key planKey,
@Nullable
AuditLogEntity entity)
AuditLogServicelog in interface AuditLogServiceentity - job's task or chain's stage affected by the changepublic boolean isEnabled()
AuditLogServiceisEnabled in interface AuditLogServicepublic void setEnabled(boolean enabled)
AuditLogServicesetEnabled in interface AuditLogServicepublic List<AuditLogEntry> getAgentAuditLogsMessagesByAgentName(String agentName)
AuditLogServicegetAgentAuditLogsMessagesByAgentName in interface AuditLogServiceagentName - the name of the agentCopyright © 2017 Atlassian Software Systems Pty Ltd. All rights reserved.