/*
* 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.resources;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotates a field or a setter method for injection of Spring ApplicationContext resource.
* When Ignite starts using Spring configuration, the Application Context for Spring
* Configuration is injected as this resource.
* method.
* <p>
* Spring Application Context can be injected into instances of following classes:
* <ul>
* <li>{@link org.apache.ignite.compute.ComputeTask}</li>
* <li>{@link org.apache.ignite.compute.ComputeJob}</li>
* <li>{@link org.apache.ignite.spi.IgniteSpi}</li>
* <li>{@link org.apache.ignite.lifecycle.LifecycleBean}</li>
* </ul>
* <p>
* Here is how injection would typically happen:
* <pre name="code" class="java">
* public class MyGridJob implements ComputeJob {
* ...
* @SpringApplicationContextResource
* private ApplicationContext springCtx;
* ...
* }
* </pre>
* or
* <pre name="code" class="java">
* public class MyGridJob implements ComputeJob {
* ...
* private ApplicationContext springCtx;
* ...
* @SpringApplicationContextResource
* public void setApplicationContext(ApplicationContext springCtx) {
* this.springCtx = springCtx;
* }
* ...
* }
* </pre>
* <p>
* <img src="http://ignite.apache.org/images/spring-small.png">
* <br>
* For information about Spring framework visit <a href="http://www.springframework.org/">www.springframework.org</a>
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD})
public @interface SpringApplicationContextResource {
// No-op.
}