org.apache.ignite.events

Class ServiceEvent

java.lang.Object

org.apache.ignite.events.EventAdapter

org.apache.ignite.events.ServiceEvent

All Implemented Interfaces:

Serializable, Comparable<Event>, Event

public class ServiceEvent
extends EventAdapter

Grid service 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(org.apache.ignite.lang.IgnitePredicate, long, int...) - asynchronously querying events occurred on the nodes specified, including remote nodes.
• IgniteEvents.localQuery(org.apache.ignite.lang.IgnitePredicate, int...) - querying only local events stored on this local node.
• IgniteEvents.localListen(org.apache.ignite.lang.IgnitePredicate, int...) - listening to local grid events (events from remote nodes not included).

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

Events and Performance

Note that by default all events in Ignite are enabled and therefore generated and stored by whatever event storage SPI is configured. Ignite can and often does generate thousands events per seconds under the load and therefore it creates a significant additional load on the system. If these events are not needed by the application this load is unnecessary and leads to significant performance degradation.

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 SPI if they are disabled in Ignite configuration.

See Also:

EventType.EVT_SERVICE_METHOD_EXECUTION_STARTED, EventType.EVT_SERVICE_METHOD_EXECUTION_FINISHED, EventType.EVT_SERVICE_METHOD_EXECUTION_FAILED, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ServiceEvent(ClusterNode node, String msg, int type, String svcName, @Nullable String mtdName, @Nullable UUID subjId, UUID requestId) Creates service event with given parameters.

Method Summary

Modifier and Type	Method and Description
String	methodName() Gets name of service method that triggered this event.
UUID	requestId() Gets service request ID initiated this service event.
String	serviceName() Gets name of the service that triggered this event.
String	shortDisplay() Gets a shortened version of toString() result.
UUID	subjectId() Gets security subject ID initiated this service 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

ServiceEvent

public ServiceEvent(ClusterNode node,
                    String msg,
                    int type,
                    String svcName,
                    @Nullable
                    @Nullable String mtdName,
                    @Nullable
                    @Nullable UUID subjId,
                    UUID requestId)

Creates service event with given parameters.

Parameters:

node - Node that raised this event.

msg - Optional message.

type - Event type.

svcName - Service name.

mtdName - Service method name.

subjId - Security 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 Event

Overrides:

shortDisplay in class EventAdapter

Returns:

Shortened version of toString() result.

serviceName

public String serviceName()

Gets name of the service that triggered this event.

Returns:

Name of the service that triggered the event.

methodName

public String methodName()

Gets name of service method that triggered this event.

Returns:

Name of service method that triggered the event.

subjectId

public UUID subjectId()

Gets security subject ID initiated this service event.

Subject ID will be set either to node ID or client ID initiated service execution.

Returns:

Subject ID.

requestId

public UUID requestId()

Gets service request ID initiated this service event.

Returns:

Request ID.

toString

public String toString()

Overrides:

toString in class EventAdapter