modules/core/src/main/java/org/apache/ignite/events/JobEvent.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.ignite.events;

import java.util.UUID;
import org.apache.ignite.cluster.ClusterNode;
import org.apache.ignite.compute.ComputeJobResultPolicy;
import org.apache.ignite.internal.util.typedef.internal.S;
import org.apache.ignite.internal.util.typedef.internal.U;
import org.apache.ignite.lang.IgniteUuid;
import org.jetbrains.annotations.Nullable;

/**
 * Grid job event.
 * <p>
 * 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:
 * <ul>
 * <li>
 * {@link org.apache.ignite.IgniteEvents#remoteQuery(org.apache.ignite.lang.IgnitePredicate, long, int...)} -
 * asynchronously querying events occurred on the nodes specified, including remote nodes.
 * </li>
 * <li>
 * {@link org.apache.ignite.IgniteEvents#localQuery(org.apache.ignite.lang.IgnitePredicate, int...)} - querying only
 * local events stored on this local node.
 * </li>
 * <li>
 * {@link org.apache.ignite.IgniteEvents#localListen(org.apache.ignite.lang.IgnitePredicate, int...)} - listening to
 * local grid events (events from remote nodes not included).
 * </li>
 * </ul>
 * User can also wait for events using method {@link org.apache.ignite.IgniteEvents#waitForLocal(org.apache.ignite.lang.IgnitePredicate,
 * int...)}.
 * <h1 class="header">Events and Performance</h1>
 * 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.
 * <p>
 * It is <b>highly recommended</b> to enable only those events that your application logic requires by using {@link
 * org.apache.ignite.configuration.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 EventType#EVT_JOB_CANCELLED
 * @see EventType#EVT_JOB_FAILED
 * @see EventType#EVT_JOB_FAILED_OVER
 * @see EventType#EVT_JOB_FINISHED
 * @see EventType#EVT_JOB_MAPPED
 * @see EventType#EVT_JOB_QUEUED
 * @see EventType#EVT_JOB_REJECTED
 * @see EventType#EVT_JOB_RESULTED
 * @see EventType#EVT_JOB_STARTED
 * @see EventType#EVT_JOB_TIMEDOUT
 * @see EventType#EVTS_JOB_EXECUTION
 */
public class JobEvent extends EventAdapter {
    /** */
    private static final long serialVersionUID = 0L;

    /** */
    private String taskName;

    /** */
    private String taskClsName;

    /** */
    private IgniteUuid sesId;

    /** */
    private IgniteUuid jobId;

    /** */
    private ClusterNode taskNode;

    /** */
    private UUID taskSubjId;

    /** */
    private ComputeJobResultPolicy resPlc;

    /** {@inheritDoc} */
    @Override public String shortDisplay() {
        return name() + ": taskName=" + taskName;
    }

    /**
     * No-arg constructor.
     */
    public JobEvent() {
        // No-op.
    }

    /**
     * Creates job event with given parameters.
     *
     * @param node Node.
     * @param msg Optional message.
     * @param type Event type.
     */
    public JobEvent(ClusterNode node, String msg, int type) {
        super(node, msg, type);
    }

    /**
     * Gets name of the task that triggered the event.
     *
     * @return Name of the task that triggered the event.
     */
    public String taskName() {
        return taskName;
    }

    /**
     * Gets name of task class that triggered this event.
     *
     * @return Name of task class that triggered the event.
     */
    public String taskClassName() {
        return taskClsName;
    }

    /**
     * Gets task session ID of the task that triggered this event.
     *
     * @return Task session ID of the task that triggered the event.
     */
    public IgniteUuid taskSessionId() {
        return sesId;
    }

    /**
     * Gets job ID.
     *
     * @return Job ID.
     */
    public IgniteUuid jobId() {
        return jobId;
    }

    /**
     * Sets name of the task that triggered this event.
     *
     * @param taskName Task name to set.
     */
    public void taskName(String taskName) {
        assert taskName != null;

        this.taskName = taskName;
    }

    /**
     * Sets name of the task class that triggered this event.
     *
     * @param taskClsName Task class name to set.
     */
    public void taskClassName(String taskClsName) {
        this.taskClsName = taskClsName;
    }

    /**
     * Sets task session ID of the task that triggered this event.
     *
     * @param sesId Task session ID to set.
     */
    public void taskSessionId(IgniteUuid sesId) {
        assert sesId != null;

        this.sesId = sesId;
    }

    /**
     * Sets job ID.
     *
     * @param jobId Job ID to set.
     */
    public void jobId(IgniteUuid jobId) {
        assert jobId != null;

        this.jobId = jobId;
    }

    /**
     * Get node where parent task of the job has originated.
     *
     * @return Node where parent task of the job has originated.
     */
    public ClusterNode taskNode() {
        return taskNode;
    }

    /**
     * Sets node where parent task of the job has originated.
     *
     * @param taskNode Node where parent task of the job has originated.
     */
    public void taskNode(ClusterNode taskNode) {
        this.taskNode = taskNode;
    }

    /**
     * Gets task subject ID.
     *
     * @return Task subject ID.
     */
    public UUID taskSubjectId() {
        return taskSubjId;
    }

    /**
     * Sets task subject ID.
     *
     * @param taskSubjId Task subject ID.
     */
    public void taskSubjectId(UUID taskSubjId) {
        this.taskSubjId = taskSubjId;
    }

    /**
     * Gets job result policy. Not null for {@link EventType#EVT_JOB_RESULTED}
     * and {@link EventType#EVT_JOB_FAILED_OVER} event types.
     *
     * @return Result policy.
     */
    @Nullable public ComputeJobResultPolicy resultPolicy() {
        return resPlc;
    }

    /**
     * Sets job result policy.
     *
     * @param resPlc New result policy.
     */
    public void resultPolicy(@Nullable ComputeJobResultPolicy resPlc) {
        this.resPlc = resPlc;
    }

    /** {@inheritDoc} */
    @Override public String toString() {
        return S.toString(JobEvent.class, this,
            "nodeId8", U.id8(node().id()),
            "msg", message(),
            "type", name(),
            "tstamp", timestamp());
    }
}