Package jetbrains.buildServer.serverSide.audit

Interface AuditLog

public interface AuditLog

Represents audit log for the specified object

Author:

Maxim.Manuylov Date: 24.04.2009

Method Summary

Modifier and Type	Method	Description
AuditLogObject	getObject()	Returns audit object
void	log(ActionType actionType, String message, String additionalData, SUser user, Object... additionalObjects)	Logs the action
void	logUserAction(ActionType actionType, String message, String additionalData, Object... additionalObjects)	Logs the user action.
void	logUserAction(ConfigAction cause, ActionType actionType, String message, String additionalData, Object... additionalObjects)	Logs the user action.

Method Detail

logUserAction

void logUserAction(@NotNull
                   ActionType actionType,
                   @Nullable
                   String message,
                   @Nullable
                   String additionalData,
                   @NotNull
                   Object... additionalObjects)
            throws IncorrectActionTypeError

Logs the user action. User is got from security context. If security context has no associated user the action will not be logged.

Parameters:

actionType - action type

message - message (comment)

additionalData - additional data

additionalObjects - additional objects

Throws:

IncorrectActionTypeError - throws when specified action type is not allowed for this type of objects

logUserAction

void logUserAction(@NotNull
                   ConfigAction cause,
                   @NotNull
                   ActionType actionType,
                   @Nullable
                   String message,
                   @Nullable
                   String additionalData,
                   @NotNull
                   Object... additionalObjects)
            throws IncorrectActionTypeError

Logs the user action. User is got from provided cause. If cause has no associated user the action will not be logged.

Parameters:

cause - change cause

actionType - action type

message - message (comment)

additionalData - additional data

additionalObjects - additional objects

Throws:

IncorrectActionTypeError - throws when specified action type is not allowed for this type of objects

log

void log(@NotNull
         ActionType actionType,
         @Nullable
         String message,
         @Nullable
         String additionalData,
         @Nullable
         SUser user,
         @NotNull
         Object... additionalObjects)
  throws IncorrectActionTypeError

Logs the action

Parameters:

actionType - action type

message - message (comment)

additionalData - additional data

user - user can be null for system actions; such actions are not shown to users on web UI, but can be used by system to get last action comment or something else (e.g. comment for agent authorization status)

additionalObjects - additional objects

Throws:

IncorrectActionTypeError - throws when specified action type is not allowed for this type of objects

getObject

@NotNull
AuditLogObject getObject()

Returns audit object

Returns: