Package org.openspaces.admin.internal.gsa

Class DefaultGridServiceAgents

java.lang.Object

org.openspaces.admin.internal.gsa.DefaultGridServiceAgents

All Implemented Interfaces:

Iterable<GridServiceAgent>, AdminAware, DumpProvider, GridServiceAgents, InternalGridServiceAgents

public class DefaultGridServiceAgents
extends Object
implements InternalGridServiceAgents

Author:

kimchy

Constructor Summary

Constructors

Constructor	Description
DefaultGridServiceAgents(InternalAdmin admin)

Method Summary

Modifier and Type	Method	Description
void	addGridServiceAgent(InternalGridServiceAgent gridServiceAgent)
void	addLifecycleListener(GridServiceAgentLifecycleEventListener eventListener)	Allows to add a GridServiceAgentLifecycleEventListener.
DumpResult	generateDump(String cause, Map<String,Object> context)	Generates dump for all the provided dump processors.
DumpResult	generateDump(String cause, Map<String,Object> context, String... processor)	Generates dump for the provided processors.
Admin	getAdmin()	Returns the Admin associated with this element.
GridServiceAgent	getAgentByUID(String uid)	Returns an agent based on its uid.
GridServiceAgent[]	getAgents()	Returns all the currently discovered agents.
Map<GSAReservationId,Collection<GridServiceAgent>>	getAgentsGroupByReservationId()
GridServiceAgentAddedEventManager	getGridServiceAgentAdded()	Returns the grid service agent added event manager allowing to add and remove GridServiceAgentAddedEventListeners.
GridServiceAgentRemovedEventManager	getGridServiceAgentRemoved()	Returns the grid service agent added event manager allowing to add and remove GridServiceAgentRemovedEventListeners.
Map<String,GridServiceAgent>	getHostAddress()	Returns a map of grid service agent with the key as the host address it is running on.
Map<String,GridServiceAgent>	getHostNames()	Returns a map of grid service agent with the key as the host name it is running on.
int	getSize()	Returns the number of agents current discovered.
Map<String,GridServiceAgent>	getUids()	Returns a map of grid service agent with the key as the uid.
boolean	isEmpty()	Returns true if there are no agents, false otherwise.
Iterator<GridServiceAgent>	iterator()
InternalGridServiceAgent	removeGridServiceAgent(String uid)
void	removeLifecycleListener(GridServiceAgentLifecycleEventListener eventListener)	Allows to remove a GridServiceAgentLifecycleEventListener.
boolean	waitFor(int numberOfAgents)	Waits indefinitely till the provided number of agents are up.
boolean	waitFor(int numberOfAgents, long timeout, TimeUnit timeUnit)	Waits for the given timeout (in time unit) till the provided number of agents are up.
GridServiceAgent	waitForAtLeastOne()	Waits indefinitely till at least one agent is discovered.
GridServiceAgent	waitForAtLeastOne(long timeout, TimeUnit timeUnit)	Waits for the given timeout (in time unit) till at least one agent is discovered.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

DefaultGridServiceAgents

public DefaultGridServiceAgents(InternalAdmin admin)

Method Details

getAdmin

public Admin getAdmin()

Description copied from interface: AdminAware

Returns the Admin associated with this element.

Specified by:

getAdmin in interface AdminAware

getAgents

public GridServiceAgent[] getAgents()

Description copied from interface: GridServiceAgents

Returns all the currently discovered agents.

Specified by:

getAgents in interface GridServiceAgents

getAgentByUID

public GridServiceAgent getAgentByUID(String uid)

Description copied from interface: GridServiceAgents

Returns an agent based on its uid.

Specified by:

getAgentByUID in interface GridServiceAgents

See Also:

• GridComponent.getUid()

getUids

public Map<String,GridServiceAgent> getUids()

Description copied from interface: GridServiceAgents

Returns a map of grid service agent with the key as the uid.

Specified by:

getUids in interface GridServiceAgents

getHostAddress

public Map<String,GridServiceAgent> getHostAddress()

Description copied from interface: GridServiceAgents

Returns a map of grid service agent with the key as the host address it is running on.

Specified by:

getHostAddress in interface GridServiceAgents

getHostNames

public Map<String,GridServiceAgent> getHostNames()

Description copied from interface: GridServiceAgents

Returns a map of grid service agent with the key as the host name it is running on.

Specified by:

getHostNames in interface GridServiceAgents

getSize

public int getSize()

Description copied from interface: GridServiceAgents

Returns the number of agents current discovered.

Specified by:

getSize in interface GridServiceAgents

isEmpty

public boolean isEmpty()

Description copied from interface: GridServiceAgents

Returns true if there are no agents, false otherwise.

Specified by:

isEmpty in interface GridServiceAgents

iterator

public Iterator<GridServiceAgent> iterator()

Specified by:

iterator in interface Iterable<GridServiceAgent>

waitForAtLeastOne

public GridServiceAgent waitForAtLeastOne()

Description copied from interface: GridServiceAgents

Waits indefinitely till at least one agent is discovered.

Specified by:

waitForAtLeastOne in interface GridServiceAgents

waitForAtLeastOne

public GridServiceAgent waitForAtLeastOne(long timeout,
 TimeUnit timeUnit)

Description copied from interface: GridServiceAgents

Waits for the given timeout (in time unit) till at least one agent is discovered.

Specified by:

waitForAtLeastOne in interface GridServiceAgents

waitFor

public boolean waitFor(int numberOfAgents)

Description copied from interface: GridServiceAgents

Waits indefinitely till the provided number of agents are up.

Specified by:

waitFor in interface GridServiceAgents

Parameters:

numberOfAgents - The number of agents to wait for

waitFor

public boolean waitFor(int numberOfAgents,
 long timeout,
 TimeUnit timeUnit)

Description copied from interface: GridServiceAgents

Waits for the given timeout (in time unit) till the provided number of agents are up.

Specified by:

waitFor in interface GridServiceAgents

Parameters:

numberOfAgents - The number of agents to wait for

getGridServiceAgentAdded

public GridServiceAgentAddedEventManager getGridServiceAgentAdded()

Description copied from interface: GridServiceAgents

Returns the grid service agent added event manager allowing to add and remove GridServiceAgentAddedEventListeners.

Specified by:

getGridServiceAgentAdded in interface GridServiceAgents

getGridServiceAgentRemoved

public GridServiceAgentRemovedEventManager getGridServiceAgentRemoved()

Description copied from interface: GridServiceAgents

Returns the grid service agent added event manager allowing to add and remove GridServiceAgentRemovedEventListeners.

Specified by:

getGridServiceAgentRemoved in interface GridServiceAgents

addLifecycleListener

public void addLifecycleListener(GridServiceAgentLifecycleEventListener eventListener)

Description copied from interface: GridServiceAgents

Allows to add a GridServiceAgentLifecycleEventListener.

Specified by:

addLifecycleListener in interface GridServiceAgents

removeLifecycleListener

public void removeLifecycleListener(GridServiceAgentLifecycleEventListener eventListener)

Description copied from interface: GridServiceAgents

Allows to remove a GridServiceAgentLifecycleEventListener.

Specified by:

removeLifecycleListener in interface GridServiceAgents

addGridServiceAgent

public void addGridServiceAgent(InternalGridServiceAgent gridServiceAgent)

Specified by:

addGridServiceAgent in interface InternalGridServiceAgents

removeGridServiceAgent

public InternalGridServiceAgent removeGridServiceAgent(String uid)

Specified by:

removeGridServiceAgent in interface InternalGridServiceAgents

generateDump

public DumpResult generateDump(String cause,
 Map<String,Object> context)
                        throws AdminException

Description copied from interface: DumpProvider

Generates dump for all the provided dump processors. Note, this will include a heap dump which can consume time and potentially be of very large size

Specified by:

generateDump in interface DumpProvider

Parameters:

cause - The cause that this dump was generated

context - Allows to provide specific parameters to specific processors

Throws:

AdminException

generateDump

public DumpResult generateDump(String cause,
 Map<String,Object> context,
 String... processor)
                        throws AdminException

Description copied from interface: DumpProvider

Generates dump for the provided processors. The current list of processors include:

• summary: General summary information of the process.
• network: Information on the network layer of the process and the OS network stats.
• thread: Thread dump of the process.
• heap: Heap dump of the process. Note, this is a heavy operation and can produce very large dump files
• log: Adds all the log files of the process to the dump file.
• processingUnits: Dump of all the processing units (applicable only for GSCs) information.

Specified by:

generateDump in interface DumpProvider

Parameters:

cause - The cause this dump was generated.

context - Allows to provide specific parameters to specific processors.

processor - The list of processors to be used.

Throws:

AdminException

getAgentsGroupByReservationId

public Map<GSAReservationId,Collection<GridServiceAgent>> getAgentsGroupByReservationId()

Specified by:

getAgentsGroupByReservationId in interface InternalGridServiceAgents

Returns:

all agents indexed by their reservationId