org.springframework.yarn.am.grid

Interface Grid

All Known Implementing Classes:

AbstractGrid, DefaultGrid

public interface Grid

Grid allows to track members in a grid.

Author:

Janne Valkealahti

Method Summary

Methods

Modifier and Type	Method and Description
void	addGridListener(GridListener listener) Adds a listener to be notified of grid members events.
void	addInterceptor(GridMemberInterceptor interceptor) Adds a grid member interceptor.
boolean	addMember(GridMember member) Adds a new grid member.
GridMember	getMember(org.apache.hadoop.yarn.api.records.ContainerId id) Gets a grid member.
java.util.Collection<GridMember>	getMembers() Gets collection of grid members know to the grid system or empty collection if there are no known members.
boolean	removeMember(org.apache.hadoop.yarn.api.records.ContainerId id) Removes a grid member.

Method Detail

getMembers

java.util.Collection<GridMember> getMembers()

Gets collection of grid members know to the grid system or empty collection if there are no known members.

Returns:

Collection of grid members

getMember

GridMember getMember(org.apache.hadoop.yarn.api.records.ContainerId id)

Gets a grid member.

Parameters:

id - the container id identifier

Returns:

Grid member or NULL if member doesn't exist

addMember

boolean addMember(GridMember member)

Adds a new grid member.

If a grid refuses to add a particular member for any reason other than that it already contains the member, it must throw an exception (rather than returning false). This preserves the invariant that a grid always contains the specified node after this call returns.

Parameters:

member - the grid member

Returns:

true if this grid changed as a result of the call

removeMember

boolean removeMember(org.apache.hadoop.yarn.api.records.ContainerId id)

Removes a grid member.

Removes a single instance of the specified member from this grid, if it is present.

Parameters:

id - the container id identifier

Returns:

true if a member was removed as a result of this call

addGridListener

void addGridListener(GridListener listener)

Adds a listener to be notified of grid members events.

Parameters:

listener - the grid listener

addInterceptor

void addInterceptor(GridMemberInterceptor interceptor)

Adds a grid member interceptor.

Parameters:

interceptor - the interceptor