com.atlassian.confluence.event.events.security

Class LogoutEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

com.atlassian.event.Event

com.atlassian.confluence.event.events.ConfluenceEvent

com.atlassian.confluence.event.events.security.SecurityEvent

com.atlassian.confluence.event.events.security.LogoutEvent

All Implemented Interfaces:

Authentication, Serializable

public class LogoutEvent
extends SecurityEvent

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
LogoutEvent(Object src, String username, String sessionId)
LogoutEvent(Object src, String username, String sessionId, String remoteHost, String remoteIP)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Equals for ConfluenceEvents is defined such that specific sub-events are only equal to events of the same type.
boolean	getExplicitLogout()
int	hashCode() Subclasses must override this to hash their own fields.

Methods inherited from class com.atlassian.confluence.event.events.security.SecurityEvent

getRemoteHost, getRemoteIP, getSessionId, getUsername, setRemoteHost, setRemoteIP

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LogoutEvent

public LogoutEvent(Object src,
                   String username,
                   String sessionId)

LogoutEvent

public LogoutEvent(Object src,
                   String username,
                   String sessionId,
                   String remoteHost,
                   String remoteIP)

Method Detail

getExplicitLogout

public boolean getExplicitLogout()

Returns:

true if the event was fired as a result of the user logging themselves out. Returns false for all other system related logouts such as session timeouts, elevated security checks, security-rpc calls.

equals

public boolean equals(Object o)

Description copied from class: ConfluenceEvent

Equals for ConfluenceEvents is defined such that specific sub-events are only equal to events of the same type. It is incorrect to try to make an instance of a subclass equal to an instance of any of its superclasses.

Subclasses must override this to compare their own fields.

Overrides:

equals in class ConfluenceEvent

Parameters:

o - the object to compare.

Returns:

true, if the given object has the same runtime class as this object's runtime class, and the event sources are equal.

See Also:

Event.equals(Object)

hashCode

public int hashCode()

Description copied from class: ConfluenceEvent

Subclasses must override this to hash their own fields.

Overrides:

hashCode in class ConfluenceEvent

Returns:

the hashcode

See Also:

Event.hashCode()