org.gridgain.grid.resources

Annotation Type GridLoggerResource

@Documented
@Retention(value=RUNTIME)
@Target(value={METHOD,FIELD})
public @interface GridLoggerResource

Annotates a field or a setter method for injection of GridLogger. Grid logger is provided to grid via GridConfiguration.

Logger can be injected into instances of following classes:

• GridComputeTask
• GridComputeJob
• GridSpi
• GridLifecycleBean
• @GridUserResource

Here is how injection would typically happen:

 public class MyGridJob implements GridComputeJob {
      ...
      @GridLoggerResource
      private GridLogger log;
      ...
  }
 

or

 public class MyGridJob implements GridComputeJob {
     ...
     private GridLogger log;
     ...
     @GridLoggerResource
     public void setGridLogger(GridLogger log) {
          this.log = log;
     }
     ...
 }
 

See GridConfiguration.getGridLogger() for Grid configuration details.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class	categoryClass Optional log category class.
String	categoryName Optional log category name.

Element Detail

categoryClass

public abstract Class categoryClass

Optional log category class. If not provided (i.e. by default Void class is returned), then the category will be the class into which resource is assigned.

Either categoryClass or categoryName() can be provided, by not both.

Returns:

Category class of the injected logger.

Default:

java.lang.Void.class

categoryName

public abstract String categoryName

Optional log category name. If not provided, then categoryClass() value will be used.

Either categoryName or categoryClass() can be provided, by not both.

Returns:

Category name for the injected logger.

Default:

""