Package com.broadleafcommerce.auth.user.domain

Class AuthenticationEvent

java.lang.Object

com.broadleafcommerce.auth.user.domain.AuthenticationEvent

All Implemented Interfaces:

Serializable

public class AuthenticationEvent
extends Object
implements Serializable

A message event dispatched after authentication events occur.

Author:

Jon Fleschler (jfleschler)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthenticationEvent()
AuthenticationEvent(String messageType, User user, Map<String,Object> attributes, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,Object>	getAttributes()	Any additional attributes that a service receiving the request may need
com.broadleafcommerce.data.tracking.core.context.ContextInfo	getContextInfo()	The ContextInfo derived from the original request containing tenant and sandbox info.
String	getMessageType()	The message type for this event.
User	getUser()	The user that made the request
int	hashCode()
void	setAttributes(Map<String,Object> attributes)	Any additional attributes that a service receiving the request may need
void	setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	The ContextInfo derived from the original request containing tenant and sandbox info.
void	setMessageType(String messageType)	The message type for this event.
void	setUser(User user)	The user that made the request
String	toString()
AuthenticationEvent	withAttribute(String key, Object value)	Convenience method for adding any additional attributes for the event

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationEvent

public AuthenticationEvent()

AuthenticationEvent

public AuthenticationEvent(String messageType,
                           User user,
                           Map<String,Object> attributes,
                           com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Method Detail

withAttribute

public AuthenticationEvent withAttribute(String key,
                                         Object value)

Convenience method for adding any additional attributes for the event

Parameters:

key - the key for the attribute

value - the value for the attribute

Returns:

the AuthenticationEvent

getMessageType

public String getMessageType()

The message type for this event.

See Also:

AuthenticationMessageType

getUser

public User getUser()

The user that made the request

getAttributes

public Map<String,Object> getAttributes()

Any additional attributes that a service receiving the request may need

getContextInfo

public com.broadleafcommerce.data.tracking.core.context.ContextInfo getContextInfo()

The ContextInfo derived from the original request containing tenant and sandbox info.

Returns:

The ContextInfo derived from the original request

setMessageType

public void setMessageType(String messageType)

The message type for this event.

See Also:

AuthenticationMessageType

setUser

public void setUser(User user)

The user that made the request

setAttributes

public void setAttributes(Map<String,Object> attributes)

Any additional attributes that a service receiving the request may need

setContextInfo

public void setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

The ContextInfo derived from the original request containing tenant and sandbox info.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object