org.openspaces.admin.internal.gsm

Class DefaultGridServiceManagers

java.lang.Object

org.openspaces.admin.internal.gsm.DefaultGridServiceManagers

All Implemented Interfaces:

Iterable<GridServiceManager>, AdminAware, DumpProvider, GridServiceManagers, InternalGridServiceManagers

public class DefaultGridServiceManagers
extends Object
implements InternalGridServiceManagers

Author:

kimchy

Constructor Summary

Constructors

Constructor and Description
DefaultGridServiceManagers(InternalAdmin admin)

Method Summary

Modifier and Type	Method and Description
void	addGridServiceManager(InternalGridServiceManager gridServiceManager)
void	addLifecycleListener(GridServiceManagerLifecycleEventListener eventListener) Allows to add a GridServiceManagerLifecycleEventListener.
Application	deploy(ApplicationConfig applicationConfig) Deploys an application consisting of one or more processing unit deployments.
Application	deploy(ApplicationConfig applicationConfig, long timeout, TimeUnit timeUnit) Deploys an application consisting of one or more processing unit deployments.
Application	deploy(ApplicationDeployment deployment) Deploys an application consisting of one or more processing unit deployments.
Application	deploy(ApplicationDeployment deployment, long timeout, TimeUnit timeUnit) Deploys an application consisting of one or more processing unit deployments.
ProcessingUnit	deploy(Application application, ProcessingUnitDeploymentTopology puDeploymentTopology, long timeout, TimeUnit timeUnit)
ProcessingUnit	deploy(ProcessingUnitDeployment deployment) Deploys a processing unit based on the processing unit deployment information on a random grid service manager (it will act as the primary GSM for the deployed processing unit).
ProcessingUnit	deploy(ProcessingUnitDeployment deployment, long timeout, TimeUnit timeUnit) Deploys a processing unit based on the processing unit deployment information on a random grid service manager (it will act as the primary GSM for the deployed processing unit).
ProcessingUnit	deploy(SpaceDeployment deployment) Deploys a space based on the space deployment information on a random grid service manager (it will act as the primary GSM for the deployed processing unit).
ProcessingUnit	deploy(SpaceDeployment deployment, long timeout, TimeUnit timeUnit) Deploys a space based on the space deployment information on a random grid service manager (it will act as the primary GSM for the deployed processing unit).
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.
GridServiceManagerAddedEventManager	getGridServiceManagerAdded() Returns the grid service manager added event manager allowing to add and remove GridServiceManagerAddedEventListeners.
GridServiceManagerRemovedEventManager	getGridServiceManagerRemoved() Returns the grid service container added event manager allowing to add and remove GridServiceManagerRemovedEventListeners.
GridServiceManager	getManagerByUID(String uid) Returns a manager based on its uid.
GridServiceManager[]	getManagers() Returns all the currently discovered managers.
GridServiceManager[]	getManagersNonFiltered()
int	getSize() Returns the number of managers current discovered.
Map<String,GridServiceManager>	getUids() Returns a map of grid service manager with the key as the uid.
boolean	isEmpty() Returns true if there are no managers, false otherwise.
Iterator<GridServiceManager>	iterator()
InternalGridServiceManager	removeGridServiceManager(String uid)
void	removeLifecycleListener(GridServiceManagerLifecycleEventListener eventListener) Allows to remove a GridServiceManagerLifecycleEventListener.
InternalGridServiceManager	replaceGridServiceManager(InternalGridServiceManager gridServiceManager) Replaces the grid service manager, returning the old one
boolean	waitFor(int numberOfGridServiceManagers) Waits indefinitely till the provided number of managers are up.
boolean	waitFor(int numberOfGridServiceManagers, long timeout, TimeUnit timeUnit) Waits for the given timeout (in time unit) till the provided number of managers are up.
GridServiceManager	waitForActiveManager()
GridServiceManager	waitForActiveManager(long timeout, TimeUnit timeUnit)
GridServiceManager	waitForAtLeastOne() Waits indefinitely till at least one GSM is discovered and returns it.
GridServiceManager	waitForAtLeastOne(long timeout, TimeUnit timeUnit) Waits for the given timeout (in time unit) till at least one GSM is discovered and returns it.

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

DefaultGridServiceManagers

public DefaultGridServiceManagers(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

getGridServiceManagerAdded

public GridServiceManagerAddedEventManager getGridServiceManagerAdded()

Description copied from interface: GridServiceManagers

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

Specified by:

getGridServiceManagerAdded in interface GridServiceManagers

getGridServiceManagerRemoved

public GridServiceManagerRemovedEventManager getGridServiceManagerRemoved()

Description copied from interface: GridServiceManagers

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

Specified by:

getGridServiceManagerRemoved in interface GridServiceManagers

getManagers

public GridServiceManager[] getManagers()

Description copied from interface: GridServiceManagers

Returns all the currently discovered managers.

Specified by:

getManagers in interface GridServiceManagers

getManagersNonFiltered

public GridServiceManager[] getManagersNonFiltered()

Specified by:

getManagersNonFiltered in interface InternalGridServiceManagers

getManagerByUID

public GridServiceManager getManagerByUID(String uid)

Description copied from interface: GridServiceManagers

Returns a manager based on its uid.

Specified by:

getManagerByUID in interface GridServiceManagers

See Also:

GridComponent.getUid()

getUids

public Map<String,GridServiceManager> getUids()

Description copied from interface: GridServiceManagers

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

Specified by:

getUids in interface GridServiceManagers

getSize

public int getSize()

Description copied from interface: GridServiceManagers

Returns the number of managers current discovered.

Specified by:

getSize in interface GridServiceManagers

isEmpty

public boolean isEmpty()

Description copied from interface: GridServiceManagers

Returns true if there are no managers, false otherwise.

Specified by:

isEmpty in interface GridServiceManagers

waitForAtLeastOne

public GridServiceManager waitForAtLeastOne()

Description copied from interface: GridServiceManagers

Waits indefinitely till at least one GSM is discovered and returns it.

Specified by:

waitForAtLeastOne in interface GridServiceManagers

waitForActiveManager

public GridServiceManager waitForActiveManager()

Specified by:

waitForActiveManager in interface GridServiceManagers

Returns:

the managing instance or null if non available in the default time-out.

waitForActiveManager

public GridServiceManager waitForActiveManager(long timeout,
                                               TimeUnit timeUnit)

Specified by:

waitForActiveManager in interface GridServiceManagers

Returns:

the managing instance or null if non available in the specified time-out

waitForAtLeastOne

public GridServiceManager waitForAtLeastOne(long timeout,
                                            TimeUnit timeUnit)

Description copied from interface: GridServiceManagers

Waits for the given timeout (in time unit) till at least one GSM is discovered and returns it.

Specified by:

waitForAtLeastOne in interface GridServiceManagers

waitFor

public boolean waitFor(int numberOfGridServiceManagers)

Description copied from interface: GridServiceManagers

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

Specified by:

waitFor in interface GridServiceManagers

Parameters:

numberOfGridServiceManagers - The number of managers to wait for

waitFor

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

Description copied from interface: GridServiceManagers

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

When passing 0, will wait till there are no more managers.

Specified by:

waitFor in interface GridServiceManagers

Parameters:

numberOfGridServiceManagers - The number of managers to wait for

deploy

public ProcessingUnit deploy(ProcessingUnitDeployment deployment)

Description copied from interface: GridServiceManagers

Deploys a processing unit based on the processing unit deployment information on a random grid service manager (it will act as the primary GSM for the deployed processing unit).

The deployment process will wait indefinitely and return the actual processing unit that can be used.

Specified by:

deploy in interface GridServiceManagers

deploy

public ProcessingUnit deploy(ProcessingUnitDeployment deployment,
                             long timeout,
                             TimeUnit timeUnit)

Description copied from interface: GridServiceManagers

Deploys a processing unit based on the processing unit deployment information on a random grid service manager (it will act as the primary GSM for the deployed processing unit).

The deployment process will wait for the given timeout and return the actual processing unit that can be used.

Specified by:

deploy in interface GridServiceManagers

deploy

public ProcessingUnit deploy(SpaceDeployment deployment)

Description copied from interface: GridServiceManagers

Deploys a space based on the space deployment information on a random grid service manager (it will act as the primary GSM for the deployed processing unit).

The deployment process will wait indefinitely and return the actual processing unit that can be used.

Note, deploying just a space is simply deploying a built in processing unit that starts just an embedded space.

Specified by:

deploy in interface GridServiceManagers

deploy

public ProcessingUnit deploy(SpaceDeployment deployment,
                             long timeout,
                             TimeUnit timeUnit)

Description copied from interface: GridServiceManagers

Deploys a space based on the space deployment information on a random grid service manager (it will act as the primary GSM for the deployed processing unit).

The deployment process will wait for the provided timeout and return the actual processing unit that can be used.

Note, deploying just a space is simply deploying a built in processing unit that starts just an embedded space.

Specified by:

deploy in interface GridServiceManagers

deploy

public Application deploy(ApplicationDeployment deployment)
                   throws ApplicationAlreadyDeployedException,
                          ProcessingUnitAlreadyDeployedException

Description copied from interface: GridServiceManagers

Deploys an application consisting of one or more processing unit deployments.

The deployment process will wait indefinitely

Specified by:

deploy in interface GridServiceManagers

Returns:

An application containing the actual processing units that can be used.

Throws:

ApplicationAlreadyDeployedException - - Application with the same name has already been deployed.

ProcessingUnitAlreadyDeployedException - - Processing unit with the same name has already been deployed. Processing Unit names are globally unique (regardless of the application name)

deploy

public Application deploy(ApplicationDeployment deployment,
                          long timeout,
                          TimeUnit timeUnit)
                   throws ApplicationAlreadyDeployedException,
                          ProcessingUnitAlreadyDeployedException

Description copied from interface: GridServiceManagers

Deploys an application consisting of one or more processing unit deployments.

The deployment process will wait for the given timeout

Specified by:

deploy in interface GridServiceManagers

Returns:

An application containing the actual processing units that can be used or null if timeout expired.

Throws:

ApplicationAlreadyDeployedException - - Application with the same name has already been deployed.

ProcessingUnitAlreadyDeployedException - - Processing unit with the same name has already been deployed. Processing Unit names are globally unique (regardless of the application name)

addLifecycleListener

public void addLifecycleListener(GridServiceManagerLifecycleEventListener eventListener)

Description copied from interface: GridServiceManagers

Allows to add a GridServiceManagerLifecycleEventListener.

Specified by:

addLifecycleListener in interface GridServiceManagers

removeLifecycleListener

public void removeLifecycleListener(GridServiceManagerLifecycleEventListener eventListener)

Description copied from interface: GridServiceManagers

Allows to remove a GridServiceManagerLifecycleEventListener.

Specified by:

removeLifecycleListener in interface GridServiceManagers

iterator

public Iterator<GridServiceManager> iterator()

Specified by:

iterator in interface Iterable<GridServiceManager>

addGridServiceManager

public void addGridServiceManager(InternalGridServiceManager gridServiceManager)

Specified by:

addGridServiceManager in interface InternalGridServiceManagers

removeGridServiceManager

public InternalGridServiceManager removeGridServiceManager(String uid)

Specified by:

removeGridServiceManager in interface InternalGridServiceManagers

replaceGridServiceManager

public InternalGridServiceManager replaceGridServiceManager(InternalGridServiceManager gridServiceManager)

Description copied from interface: InternalGridServiceManagers

Replaces the grid service manager, returning the old one

Specified by:

replaceGridServiceManager in interface InternalGridServiceManagers

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

deploy

public ProcessingUnit deploy(Application application,
                             ProcessingUnitDeploymentTopology puDeploymentTopology,
                             long timeout,
                             TimeUnit timeUnit)

Specified by:

deploy in interface InternalGridServiceManagers

deploy

public Application deploy(ApplicationConfig applicationConfig)

Description copied from interface: GridServiceManagers

Deploys an application consisting of one or more processing unit deployments.

The deployment process will wait indefinitely

Specified by:

deploy in interface GridServiceManagers

Returns:

An application containing the actual processing units that can be used.

deploy

public Application deploy(ApplicationConfig applicationConfig,
                          long timeout,
                          TimeUnit timeUnit)
                   throws ApplicationAlreadyDeployedException,
                          ProcessingUnitAlreadyDeployedException

Description copied from interface: GridServiceManagers

Deploys an application consisting of one or more processing unit deployments.

The deployment process will wait for the given timeout

Specified by:

deploy in interface GridServiceManagers

Returns:

An application configuration containing the actual processing units that can be used or null if timeout expired.

Throws:

ApplicationAlreadyDeployedException - - Application with the same name has already been deployed.

ProcessingUnitAlreadyDeployedException - - Processing unit with the same name has already been deployed. Processing Unit names are globally unique (regardless of the application name)