com.atlassian.crowd.audit

Class ImmutableAuditLogChangeset

java.lang.Object

com.atlassian.crowd.audit.ImmutableAuditLogChangeset

All Implemented Interfaces:

AuditLogChangeset

public class ImmutableAuditLogChangeset
extends Object
implements AuditLogChangeset

Concrete implementation of an audit log changeset

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableAuditLogChangeset.Builder Builder for ImmutableAuditLogChangeset.

Constructor Summary

Constructors

Constructor and Description
ImmutableAuditLogChangeset(Long id, Instant timestamp, AuditLogAuthorType authorType, Long authorId, String authorName, AuditLogEventType eventType, AuditLogEntityType entityType, Long entityId, String entityName, String ipAddress, String eventMessage, List<ImmutableAuditLogEntry> entries) Deprecated. Use the ImmutableAuditLogChangeset.Builder instead

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static ImmutableAuditLogChangeset	from(AuditLogChangeset changeset)
AuditLogAuthor	getAuthor()
Long	getAuthorId()
String	getAuthorName() Returns the name of the author of the audit log entry.
AuditLogAuthorType	getAuthorType()
Collection<ImmutableAuditLogEntity>	getEntities()
Collection<ImmutableAuditLogEntry>	getEntries()
String	getEventMessage()
AuditLogEventType	getEventType()
Long	getId()
String	getIpAddress()
AuditLogEventSource	getSource()
Instant	getTimestampInstant()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.crowd.audit.AuditLogChangeset

getAdditionalEntities, getEntity, getEntityId, getEntityName, getEntityType

Constructor Detail

ImmutableAuditLogChangeset

@Deprecated
public ImmutableAuditLogChangeset(Long id,
                                              Instant timestamp,
                                              AuditLogAuthorType authorType,
                                              Long authorId,
                                              String authorName,
                                              AuditLogEventType eventType,
                                              AuditLogEntityType entityType,
                                              Long entityId,
                                              String entityName,
                                              String ipAddress,
                                              String eventMessage,
                                              List<ImmutableAuditLogEntry> entries)

Deprecated. Use the ImmutableAuditLogChangeset.Builder instead

Method Detail

getId

public Long getId()

Specified by:

getId in interface AuditLogChangeset

Returns:

The changeset identifier

getTimestampInstant

public Instant getTimestampInstant()

Specified by:

getTimestampInstant in interface AuditLogChangeset

Returns:

the creation date of the audit log entry

getAuthorType

public AuditLogAuthorType getAuthorType()

Specified by:

getAuthorType in interface AuditLogChangeset

Returns:

the type of the author of the audit log entry

getAuthorId

public Long getAuthorId()

Specified by:

getAuthorId in interface AuditLogChangeset

Returns:

the identifier of the author of the audit log entry (exact semantic depends on the author type)

getAuthorName

public String getAuthorName()

Description copied from interface: AuditLogChangeset

Returns the name of the author of the audit log entry. This is particularly useful when the author does not exist anymore

Specified by:

getAuthorName in interface AuditLogChangeset

Returns:

the name of the author of the audit log entry

getAuthor

public AuditLogAuthor getAuthor()

Specified by:

getAuthor in interface AuditLogChangeset

Returns:

the information about the author of the audit log entry (exact semantic depends on the author type)

getEventType

public AuditLogEventType getEventType()

Specified by:

getEventType in interface AuditLogChangeset

Returns:

information about the type of the event represented by this audit log entry

getIpAddress

public String getIpAddress()

Specified by:

getIpAddress in interface AuditLogChangeset

Returns:

the IP address of the entity which performed the auditable action

getEventMessage

public String getEventMessage()

Specified by:

getEventMessage in interface AuditLogChangeset

Returns:

custom message providing additional detail about the auditable event

getSource

public AuditLogEventSource getSource()

Specified by:

getSource in interface AuditLogChangeset

Returns:

the source of the auditable event (whether it was manual or changed by an automated process for example)

getEntries

public Collection<ImmutableAuditLogEntry> getEntries()

Specified by:

getEntries in interface AuditLogChangeset

Returns:

the entries contained in the changeset

getEntities

public Collection<ImmutableAuditLogEntity> getEntities()

Specified by:

getEntities in interface AuditLogChangeset

Returns:

the objects that were affected by the event reflected by the changeset

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

from

public static ImmutableAuditLogChangeset from(AuditLogChangeset changeset)

Returns:

an ImmutableAuditLogChangeset with the same properties as the given changeset. Will avoid creating a copy if possible.