org.gridgain.grid.events

Class AuthenticationEvent

java.lang.Object

org.apache.ignite.events.EventAdapter

org.gridgain.grid.events.AuthenticationEvent

All Implemented Interfaces:

Serializable, Comparable<Event>, Event

public class AuthenticationEvent
extends EventAdapter

Grid authentication event.

Grid events are used for notification about what happens within the grid. Note that by design Ignite keeps all events generated on the local node locally and it provides APIs for performing a distributed queries across multiple nodes:

• IgniteEvents.remoteQuery(IgnitePredicate, long, int...) - asynchronously querying events occurred on the nodes specified, including remote nodes.
• IgniteEvents.localQuery(IgnitePredicate, int...) - querying only local events stored on this local node.
• IgniteEvents.localListen(IgnitePredicate, int...) - listening to local grid events (events from remote nodes not included).

User can also wait for events using method IgniteEvents.waitForLocal(IgnitePredicate, int...).

Events and Performance

It is highly recommended to enable only those events that your application logic requires by using IgniteConfiguration.getIncludeEventTypes() method in Ignite configuration. Note that certain events are required for Ignite's internal operations and such events will still be generated but not stored by event storage authentication if they are disabled in Ignite configuration.

See Also:

EventType.EVT_AUTHENTICATION_FAILED, EventType.EVT_AUTHENTICATION_SUCCEEDED, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticationEvent() No-arg constructor.
AuthenticationEvent(ClusterNode node, String msg, int type) Creates authentication event with given parameters.
AuthenticationEvent(ClusterNode node, String msg, int type, SecuritySubjectType subjType, UUID subjId, Object login, InetSocketAddress addr) Creates authentication event with given parameters.
AuthenticationEvent(ClusterNode node, String msg, int type, SecuritySubjectType subjType, UUID subjId, Object login, InetSocketAddress addr, List<InetSocketAddress> allAddr) Creates authentication event with given parameters.

Method Summary

Modifier and Type	Method and Description
Object	login() Gets login that triggered event.
void	login(Object login) Sets login that triggered event.
String	shortDisplay() Gets a shortened version of toString() result.
InetSocketAddress	subjectAddress() Gets subject address of the event.
void	subjectAddress(InetSocketAddress addr) Sets subject address of the event.
List<InetSocketAddress>	subjectAllAddress() Gets All the subject addresses of the event.
void	subjectAllAddresses(List<InetSocketAddress> allAddr) Sets All the subject addresses of the event.
UUID	subjectId() Gets subject ID that triggered the event.
void	subjectId(UUID subjId) Sets subject ID that triggered the event.
SecuritySubjectType	subjectType() Gets subject type that triggered the event.
void	subjectType(SecuritySubjectType subjType) Sets subject type that triggered the event.
String	toString()

Methods inherited from class org.apache.ignite.events.EventAdapter

compareTo, equals, hashCode, id, localOrder, message, message, name, node, node, timestamp, type, type

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationEvent

public AuthenticationEvent()

No-arg constructor.

AuthenticationEvent

public AuthenticationEvent(ClusterNode node,
                           String msg,
                           int type)

Creates authentication event with given parameters.

Parameters:

msg - Optional message.

type - Event type.

AuthenticationEvent

public AuthenticationEvent(ClusterNode node,
                           String msg,
                           int type,
                           SecuritySubjectType subjType,
                           UUID subjId,
                           Object login,
                           InetSocketAddress addr)

Creates authentication event with given parameters.

Parameters:

node - Node.

msg - Optional message.

type - Event type.

subjType - Subject type.

subjId - Subject ID.

addr - Subject address.

AuthenticationEvent

public AuthenticationEvent(ClusterNode node,
                           String msg,
                           int type,
                           SecuritySubjectType subjType,
                           UUID subjId,
                           Object login,
                           InetSocketAddress addr,
                           List<InetSocketAddress> allAddr)

Creates authentication event with given parameters.

Parameters:

node - Node.

msg - Optional message.

type - Event type.

subjType - Subject type.

subjId - Subject ID.

addr - Subject address.

allAddr - All Subject addresses.

Method Detail

shortDisplay

public String shortDisplay()

Gets a shortened version of toString() result. Suitable for humans to read.

Specified by:

shortDisplay in interface Event

Overrides:

shortDisplay in class EventAdapter

Returns:

Shortened version of toString() result.

subjectType

public SecuritySubjectType subjectType()

Gets subject type that triggered the event.

Returns:

Subject type that triggered the event.

subjectId

public UUID subjectId()

Gets subject ID that triggered the event.

Returns:

Subject ID that triggered the event.

subjectType

public void subjectType(SecuritySubjectType subjType)

Sets subject type that triggered the event.

Parameters:

subjType - Subject type to set.

login

public Object login()

Gets login that triggered event.

Returns:

Login object.

login

public void login(Object login)

Sets login that triggered event.

Parameters:

login - Login object.

subjectId

public void subjectId(UUID subjId)

Sets subject ID that triggered the event.

Parameters:

subjId - Subject ID to set.

subjectAddress

public InetSocketAddress subjectAddress()

Gets subject address of the event.

Returns:

Login object.

subjectAddress

public void subjectAddress(InetSocketAddress addr)

Sets subject address of the event.

Parameters:

addr - Subject address.

subjectAllAddress

public List<InetSocketAddress> subjectAllAddress()

Gets All the subject addresses of the event.

subjectAllAddresses

public void subjectAllAddresses(List<InetSocketAddress> allAddr)

Sets All the subject addresses of the event.

Parameters:

allAddr - Subject address.

toString

public String toString()

Overrides:

toString in class EventAdapter