org.gridgain.grid.events

Class GridAuthenticationEvent

java.lang.Object

org.gridgain.grid.events.GridEventAdapter

org.gridgain.grid.events.GridAuthenticationEvent

All Implemented Interfaces:

Serializable, Comparable<GridEvent>, GridEvent

public class GridAuthenticationEvent
extends GridEventAdapter

Grid authentication event.

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

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

User can also wait for events using method GridEvents.waitForLocal(GridPredicate, int...).

Events and Performance

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

See Also:

GridEventType.EVT_AUTHENTICATION_FAILED, GridEventType.EVT_AUTHENTICATION_SUCCEEDED, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridAuthenticationEvent() No-arg constructor.
GridAuthenticationEvent(GridNode node, String msg, int type) Creates authentication event with given parameters.
GridAuthenticationEvent(GridNode node, String msg, int type, GridSecuritySubjectType subjType, UUID subjId, Object login) Creates authentication event with given parameters.

Method Summary

Methods

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.
UUID	subjectId() Gets subject ID that triggered the event.
void	subjectId(UUID subjId) Sets subject ID that triggered the event.
GridSecuritySubjectType	subjectType() Gets subject type that triggered the event.
void	subjectType(GridSecuritySubjectType subjType) Sets subject type that triggered the event.
String	toString()

Methods inherited from class org.gridgain.grid.events.GridEventAdapter

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

GridAuthenticationEvent

public GridAuthenticationEvent()

No-arg constructor.

GridAuthenticationEvent

public GridAuthenticationEvent(GridNode node,
                       String msg,
                       int type)

Creates authentication event with given parameters.

Parameters:

msg - Optional message.

type - Event type.

GridAuthenticationEvent

public GridAuthenticationEvent(GridNode node,
                       String msg,
                       int type,
                       GridSecuritySubjectType subjType,
                       UUID subjId,
                       Object login)

Creates authentication event with given parameters.

Parameters:

node - Node.

msg - Optional message.

type - Event type.

subjType - Subject type.

subjId - Subject ID.

Method Detail

shortDisplay

public String shortDisplay()

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

Specified by:

shortDisplay in interface GridEvent

Overrides:

shortDisplay in class GridEventAdapter

Returns:

Shortened version of toString() result.

subjectType

public GridSecuritySubjectType 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(GridSecuritySubjectType 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.

toString

public String toString()

Overrides:

toString in class GridEventAdapter