org.springframework.yarn.am.grid.support

Class AbstractGrid

java.lang.Object

org.springframework.yarn.am.grid.support.AbstractGrid

All Implemented Interfaces:

Grid

Direct Known Subclasses:

DefaultGrid

public abstract class AbstractGrid
extends java.lang.Object
implements Grid

Simple Grid base implementation.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
AbstractGrid()

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) Add a channel interceptor to the end of the list.
boolean	addMember(GridMember node) Adds a new grid member.
protected GridMemberInterceptorChain	getInterceptorChain() Exposes the interceptor chain for subclasses.
java.util.List<GridMemberInterceptor>	getInterceptors() Return a read-only list of the configured interceptors.
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.
protected void	notifyMemberAdded(GridMember member) Notifies registered ContainerGridListeners that a ContainerNode has been added to a ContainerGrid.
protected void	notifyMemberRemoved(GridMember member) Notifies registered ContainerGridListeners that a ContainerNode has been removed from a ContainerGrid.
boolean	removeMember(org.apache.hadoop.yarn.api.records.ContainerId id) Removes a grid member.
void	setInterceptors(java.util.List<GridMemberInterceptor> interceptors) Set the list of channel interceptors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractGrid

public AbstractGrid()

Method Detail

getMembers

public java.util.Collection<GridMember> getMembers()

Description copied from interface: Grid

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

Specified by:

getMembers in interface Grid

Returns:

Collection of grid members

getMember

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

Description copied from interface: Grid

Gets a grid member.

Specified by:

getMember in interface Grid

Parameters:

id - the container id identifier

Returns:

Grid member or NULL if member doesn't exist

addMember

public boolean addMember(GridMember node)

Description copied from interface: Grid

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.

Specified by:

addMember in interface Grid

Parameters:

node - the grid member

Returns:

true if this grid changed as a result of the call

removeMember

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

Description copied from interface: Grid

Removes a grid member.

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

Specified by:

removeMember in interface Grid

Parameters:

id - the container id identifier

Returns:

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

addGridListener

public void addGridListener(GridListener listener)

Description copied from interface: Grid

Adds a listener to be notified of grid members events.

Specified by:

addGridListener in interface Grid

Parameters:

listener - the grid listener

setInterceptors

public void setInterceptors(java.util.List<GridMemberInterceptor> interceptors)

Set the list of channel interceptors. This will clear any existing interceptors.

Parameters:

interceptors - list of interceptors

addInterceptor

public void addInterceptor(GridMemberInterceptor interceptor)

Add a channel interceptor to the end of the list.

Specified by:

addInterceptor in interface Grid

Parameters:

interceptor - the interceptor

getInterceptors

public java.util.List<GridMemberInterceptor> getInterceptors()

Return a read-only list of the configured interceptors.

Returns:

list of interceptors

getInterceptorChain

protected GridMemberInterceptorChain getInterceptorChain()

Exposes the interceptor chain for subclasses.

Returns:

interceptor chain

notifyMemberAdded

protected void notifyMemberAdded(GridMember member)

Notifies registered ContainerGridListeners that a ContainerNode has been added to a ContainerGrid.

Parameters:

member - the node

notifyMemberRemoved

protected void notifyMemberRemoved(GridMember member)

Notifies registered ContainerGridListeners that a ContainerNode has been removed from a ContainerGrid.

Parameters:

member - the node