org.gridgain.grid.resources.GridLocalNodeIdResource Maven / Gradle / Ivy

Go to download
/* 
 Copyright (C) GridGain Systems. All Rights Reserved.
 
 Licensed 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.gridgain.grid.resources;

import org.gridgain.grid.*;
import org.gridgain.grid.compute.*;
import org.gridgain.grid.spi.*;

import java.lang.annotation.*;
import java.util.*;

/**
 * Annotates a field or a setter method for injection of local node {@link UUID} resource. {@code Node UUID}
 * is a globally unique node identifier and is provided to grid via {@link GridConfiguration}.
 * 
 * Local node ID can be injected into instances of following classes:
 * 

 * {@link GridComputeTask}
 * {@link GridComputeJob}
 * {@link GridSpi}
 * {@link GridLifecycleBean}
 * {@link GridUserResource @GridUserResource}
 * 
 * 
 * Here is how injection would typically happen:
 * 
 * public class MyGridJob implements GridComputeJob {
 *      ...
 *      @GridLocalNodeIdResource
 *      private UUID nodeId;
 *      ...
 *  }
 * 
 * or
 *  * public class MyGridJob implements GridComputeJob {
 *     ...
 *     private UUID nodeId;
 *     ...
 *     @GridLocalNodeIdResource
 *     public void setLocalNodeId(UUID nodeId) {
 *          this.nodeId = nodeId;
 *     }
 *     ...
 * }
 * 
 * 
 * See {@link GridConfiguration#getNodeId()} for Grid configuration details.
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD})
public @interface GridLocalNodeIdResource {
    // No-op.
}