|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AuditLogService
Service allowing you to register audit messages against the system or against plans. Audit messages allow you to track changes to configuration.
Nested Class Summary | |
---|---|
static interface |
AuditLogService.FieldChange
Simple interface that provides information about a changed field. |
Method Summary | |
---|---|
java.util.List<AuditLogEntry> |
getAuditLogMessagesForPlan(Plan plan)
Provide a list of all audit log messages written against a plan. |
java.util.List<AuditLogEntry> |
getAuditLogMessagesForPlan(Plan plan,
long startDate,
long endDate)
Provide a list of all audit log messages written against a plan between input dates. |
java.util.List<AuditLogEntry> |
getGlobalAuditLogMessages()
Provide a list of all audit log messages written against the system. |
boolean |
isEnabled()
Returns whether loggings is enabled |
void |
log(AuditLogEntry msg)
Add a log to the audit log. |
void |
log(java.util.Collection<AuditLogService.FieldChange> changes,
PlanKey plan)
Add 'field change' messages to the system audit log. |
void |
log(java.lang.String msg)
Add a message to the system audit log. |
void |
log(java.lang.String msg,
PlanKey plan)
Add a message to the plans audit log. |
void |
log(java.lang.String s,
PlanKey planKey,
AuditLogEntity entity)
Add a message to the plans audit log. |
void |
log(java.lang.String fieldName,
java.lang.String oldValue,
java.lang.String newValue,
PlanKey plan)
Add 'field change' message to the system audit log. |
void |
log(java.lang.String fieldName,
java.lang.String oldValue,
java.lang.String newValue,
PlanKey planKey,
AuditLogEntity entity)
Add 'field change' message to the system audit log. |
void |
log(com.atlassian.user.User user,
java.lang.String msg)
Add a message to the system audit log. |
void |
log(com.atlassian.user.User user,
java.lang.String msg,
PlanKey plan)
Add a message to the plans audit log. |
void |
log(com.atlassian.user.User user,
java.lang.String msg,
PlanKey planKey,
AuditLogEntity entity)
Add a message to the plans audit log. |
void |
removeAllAuditLogMessages()
Deletes all log messages in the database |
void |
removeAuditLogMessagesForPlan(Plan 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 |
Method Detail |
---|
void log(@NotNull AuditLogEntry msg)
msg
- (fully populated) to be loggedvoid log(@NotNull java.lang.String msg)
msg
- the text of the message to add.void log(@NotNull java.util.Collection<AuditLogService.FieldChange> changes, @Nullable PlanKey plan)
changes
- plan
- void log(@NotNull java.lang.String fieldName, @Nullable java.lang.String oldValue, @Nullable java.lang.String newValue, @Nullable PlanKey plan)
fieldName
- oldValue
- newValue
- plan
- void log(@NotNull java.lang.String fieldName, @Nullable java.lang.String oldValue, @Nullable java.lang.String newValue, @Nullable PlanKey planKey, @Nullable AuditLogEntity entity)
fieldName
- oldValue
- newValue
- plan
- entity
- job's task or chain's stage affected by the changevoid log(@Nullable com.atlassian.user.User user, @NotNull java.lang.String msg)
user
- who caused the event being loggedmsg
- the text of the message to add.void log(@NotNull java.lang.String msg, @Nullable PlanKey plan)
msg
- to logplan
- to log it againstvoid log(@NotNull java.lang.String s, @Nullable PlanKey planKey, @Nullable AuditLogEntity entity)
msg
- to logplan
- to log it againstentity
- job's task, chain' stage etc. to log againstvoid log(@Nullable com.atlassian.user.User user, @NotNull java.lang.String msg, @Nullable PlanKey plan)
user
- who caused the event being loggedmsg
- to be loggedplan
- to log the message against.void log(@Nullable com.atlassian.user.User user, @NotNull java.lang.String msg, @Nullable PlanKey planKey, @Nullable AuditLogEntity entity)
user
- who caused the event being loggedmsg
- to be loggedplan
- to log the message against.entity
- header of job's task, chain' stage etc. to log againstjava.util.List<AuditLogEntry> getAuditLogMessagesForPlan(@NotNull Plan plan)
plan
- to find audit messages for
java.util.List<AuditLogEntry> getAuditLogMessagesForPlan(@NotNull Plan plan, long startDate, long endDate)
plan
- to find audit messages forstartDate
- endDate
-
java.util.List<AuditLogEntry> getGlobalAuditLogMessages()
void removeGlobalAuditLogMessages()
void removeAuditLogMessagesForPlan(@NotNull Plan plan)
plan
- to delete messages forvoid removeAllAuditLogMessages()
boolean isEnabled()
void setEnabled(boolean enabled)
enabled
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |