org.openspaces.admin.internal.gsc

Class DefaultGridServiceContainers

java.lang.Object

org.openspaces.admin.internal.gsc.DefaultGridServiceContainers

All Implemented Interfaces:

Iterable<GridServiceContainer>, AdminAware, DumpProvider, GridServiceContainers, InternalGridServiceContainers

public class DefaultGridServiceContainers
extends Object
implements InternalGridServiceContainers

Author:

kimchy

Constructor Summary

Constructors

Constructor and Description
DefaultGridServiceContainers(InternalAdmin admin)

Method Summary

Modifier and Type	Method and Description
void	addGridServiceContainer(InternalGridServiceContainer gridServiceContainer)
void	addLifecycleListener(GridServiceContainerLifecycleEventListener eventListener) Allows to add a GridServiceContainerLifecycleEventListener.
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.
GridServiceContainer	getContainerByUID(String uid) Returns a container based on its uid.
GridServiceContainer[]	getContainers() Returns all the currently discovered containers.
GridServiceContainerAddedEventManager	getGridServiceContainerAdded() Returns the grid service container added event manager allowing to add and remove GridServiceContainerAddedEventListeners.
GridServiceContainerRemovedEventManager	getGridServiceContainerRemoved() Returns the grid service container added event manager allowing to add and remove GridServiceContainerRemovedEventListeners.
int	getSize() Returns the number of containers current discovered.
Map<String,GridServiceContainer>	getUids() Returns a map of grid service container with the key as the uid.
boolean	isEmpty() Returns true if there are no containers, false otherwise.
Iterator<GridServiceContainer>	iterator()
InternalGridServiceContainer	removeGridServiceContainer(String uid)
void	removeLifecycleListener(GridServiceContainerLifecycleEventListener eventListener) Allows to remove a GridServiceContainerLifecycleEventListener.
boolean	waitFor(int numberOfGridServiceContainers) Waits indefinitely till the provided number of containers are up.
boolean	waitFor(int numberOfGridServiceContainers, long timeout, TimeUnit timeUnit) Waits for the given timeout (in time unit) till the provided number of containers are up.

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 Detail

DefaultGridServiceContainers

public DefaultGridServiceContainers(InternalAdmin admin)

Method Detail

getAdmin

public Admin getAdmin()

Description copied from interface: AdminAware

Returns the Admin associated with this element.

Specified by:

getAdmin in interface AdminAware

getGridServiceContainerAdded

public GridServiceContainerAddedEventManager getGridServiceContainerAdded()

Description copied from interface: GridServiceContainers

Returns the grid service container added event manager allowing to add and remove GridServiceContainerAddedEventListeners.

Specified by:

getGridServiceContainerAdded in interface GridServiceContainers

getGridServiceContainerRemoved

public GridServiceContainerRemovedEventManager getGridServiceContainerRemoved()

Description copied from interface: GridServiceContainers

Returns the grid service container added event manager allowing to add and remove GridServiceContainerRemovedEventListeners.

Specified by:

getGridServiceContainerRemoved in interface GridServiceContainers

getContainers

public GridServiceContainer[] getContainers()

Description copied from interface: GridServiceContainers

Returns all the currently discovered containers.

Specified by:

getContainers in interface GridServiceContainers

getContainerByUID

public GridServiceContainer getContainerByUID(String uid)

Description copied from interface: GridServiceContainers

Returns a container based on its uid.

Specified by:

getContainerByUID in interface GridServiceContainers

See Also:

GridComponent.getUid()

getUids

public Map<String,GridServiceContainer> getUids()

Description copied from interface: GridServiceContainers

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

Specified by:

getUids in interface GridServiceContainers

getSize

public int getSize()

Description copied from interface: GridServiceContainers

Returns the number of containers current discovered.

Specified by:

getSize in interface GridServiceContainers

isEmpty

public boolean isEmpty()

Description copied from interface: GridServiceContainers

Returns true if there are no containers, false otherwise.

Specified by:

isEmpty in interface GridServiceContainers

waitFor

public boolean waitFor(int numberOfGridServiceContainers)

Description copied from interface: GridServiceContainers

Waits indefinitely till the provided number of containers are up. When passing 0, will wait till there are no more grid service containers.

Specified by:

waitFor in interface GridServiceContainers

Parameters:

numberOfGridServiceContainers - The number of containers to wait for

waitFor

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

Description copied from interface: GridServiceContainers

Waits for the given timeout (in time unit) till the provided number of containers are up. Returns true if the required number of containers were discovered, false if the timeout expired.

When passing 0, will wait till there are not more containers.

Specified by:

waitFor in interface GridServiceContainers

Parameters:

numberOfGridServiceContainers - The number of containers to wait for

addLifecycleListener

public void addLifecycleListener(GridServiceContainerLifecycleEventListener eventListener)

Description copied from interface: GridServiceContainers

Allows to add a GridServiceContainerLifecycleEventListener.

Specified by:

addLifecycleListener in interface GridServiceContainers

removeLifecycleListener

public void removeLifecycleListener(GridServiceContainerLifecycleEventListener eventListener)

Description copied from interface: GridServiceContainers

Allows to remove a GridServiceContainerLifecycleEventListener.

Specified by:

removeLifecycleListener in interface GridServiceContainers

iterator

public Iterator<GridServiceContainer> iterator()

Specified by:

iterator in interface Iterable<GridServiceContainer>

addGridServiceContainer

public void addGridServiceContainer(InternalGridServiceContainer gridServiceContainer)

Specified by:

addGridServiceContainer in interface InternalGridServiceContainers

removeGridServiceContainer

public InternalGridServiceContainer removeGridServiceContainer(String uid)

Specified by:

removeGridServiceContainer in interface InternalGridServiceContainers

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