Package org.openspaces.admin.internal.gsm

Class DefaultGridServiceManager

java.lang.Object

org.openspaces.admin.internal.support.AbstractGridComponent

org.openspaces.admin.internal.support.AbstractAgentGridComponent

org.openspaces.admin.internal.gsm.DefaultGridServiceManager

All Implemented Interfaces:

AdminAware, AgentGridComponent, DiscoverableComponent, DumpProvider, GridComponent, GridServiceManager, InternalGridServiceManager, InternalMachineAware, InternalOperatingSystemAware, InternalOperatingSystemInfoProvider, InternalAgentGridComponent, InternalDiscoverableComponent, InternalGridComponent, InternalTransportAware, InternalTransportInfoProvider, InternalVirtualMachineAware, InternalVirtualMachineInfoProvider, InternalZoneAware, LogProviderGridComponent, MachineAware, MetricProvider, OperatingSystemAware, TransportAware, VirtualMachineAware, ZoneAware

public class DefaultGridServiceManager
extends AbstractAgentGridComponent
implements InternalGridServiceManager

Author:

kimchy

Field Summary

Fields inherited from class org.openspaces.admin.internal.support.AbstractGridComponent

admin

Constructor Summary

Constructors

Constructor	Description
DefaultGridServiceManager(ServiceID serviceID, com.gigaspaces.grid.gsm.GSM gsm, InternalAdmin admin, int agentId, String agentUid, JVMDetails jvmDetails)

Method Summary

Modifier and Type	Method	Description
void	decrementInstance(ProcessingUnitInstance processingUnitInstance)
boolean	decrementPlannedInstances(ProcessingUnit processingUnit)	Decrements a planned instance if the number of planned instances is less then the actual instances to maintain.
boolean	deleteResource(String resourceName)
Map<String,String>	deleteUndeployedPuData(String puName)	Delete data of a given undeployed tiered storage processing unit
Application	deploy(ApplicationDeployment deployment)	Deploys an application consisting of one or more processing unit deployments.
Application	deploy(ApplicationDeployment applicationDeployment, long timeout, TimeUnit timeUnit)	Deploys an application consisting of one or more processing unit deployments.
ProcessingUnit	deploy(Application application, ProcessingUnitDeploymentTopology deploymentTopology, long timeout, TimeUnit timeUnit)
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.
ProcessingUnit	deploy(ProcessingUnitDeployment deployment)	Deploys a processing unit based on the processing unit deployment information on the given 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 the given grid service manager (it will act as the primary GSM for the deployed processing unit).
ProcessingUnit	deploy(ProcessingUnitConfigHolder puConfigHolder)	Deploys a new processing unit based on the specified configuration
ProcessingUnit	deploy(ProcessingUnitConfigHolder puConfigHolder, long timeout, TimeUnit timeUnit)	Deploys a new processing unit based on the specified configuration
ProcessingUnit	deploy(SpaceDeployment deployment)	Deploys a space based on the space deployment information on the given 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 the given grid service manager (it will act as the primary GSM for the deployed processing unit).
void	destroyInstance(ProcessingUnitInstance processingUnitInstance)
void	disableLRMIMonitoring()
void	enableLRMIMonitoring()
boolean	equals(Object o)
LRMIMonitoringDetails	fetchLRMIMonitoringDetails()
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... processors)	Generates dump for the provided processors.
String	getCodeBaseURL()
long	getCurrentTimeInMillis()
ServiceGridAdminDriver	getDriver()
org.jini.rio.monitor.event.Events	getEvents(int maxEvents)
com.gigaspaces.grid.gsm.GSM	getGSM()
JVMStatistics	getJVMStatistics()
NIODetails	getNIODetails()
NIOStatistics	getNIOStatistics()
OSDetails	getOSDetails()
OSStatistics	getOSStatistics()
ServiceID	getServiceID()
String	getUid()	Returns the unique id of the grid component.
List<UndeployedPuMetaData>	getUnDeployedPus()
int	hashCode()
void	incrementInstance(ProcessingUnit processingUnit)
boolean	isActiveManager()
boolean	isDeployed(String processingUnitName)	Determine if this deployment is known to this GSM.
String[]	listDeployDir()
LogEntries	logEntries(LogEntryMatcher matcher)	Returns the log entries matching the given matcher for the specific grid component.
LogEntries	logEntriesDirect(LogEntryMatcher matcher)	Same as LogProviderGridComponent.logEntries(com.gigaspaces.log.LogEntryMatcher), but does not try and get the logs from the agent.
void	reloadMetricConfiguration()
void	relocate(ProcessingUnitInstance processingUnitInstance, GridServiceContainer gridServiceContainer)
void	runGc()
void	setUndeployedInstanceIp(String puName, String instanceId, String ip, boolean validateHost)	Set ip of an instance in an undeployed tiered storage processing unit.
void	setUndeployedLeader(String puName, int partitionId, String instanceId)	Set leader of a partition in an undeployed tiered storage processing unit.
static org.jini.rio.core.OperationalString	toOperationalString(Properties props, Properties contextProperties)	Invoked via reflection from GSCImpl
static org.jini.rio.core.OperationalString	toOperationalString(Deploy deploy, ProcessingUnitConfig puConfig, String applicationName, String[] groups, LookupLocator[] locators, com.gigaspaces.grid.gsm.GSM gsm)
static org.jini.rio.core.OperationalString	toOperationalString(Deploy deploy, ProcessingUnitConfig puConfig, String applicationName, String[] groups, LookupLocator[] locators, com.gigaspaces.grid.gsm.GSM gsm, List<InstanceSLA> instanceSLAS)
void	undeploy(String processingUnitName)	Undeploys the processing unit based on its name.

Methods inherited from class org.openspaces.admin.internal.support.AbstractAgentGridComponent

getAgentId, getAgentUid, getGridServiceAgent, kill, restart, setGridServiceAgent

Methods inherited from class org.openspaces.admin.internal.support.AbstractGridComponent

addZone, assertStateChangesPermitted, getAdmin, getJVMDetails, getMachine, getOperatingSystem, getTransport, getVirtualMachine, getZones, isDiscovered, setDiscovered, setMachine, setOperatingSystem, setTransport, setVirtualMachine

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openspaces.admin.AdminAware

getAdmin

Methods inherited from interface org.openspaces.admin.AgentGridComponent

getAgentId, getGridServiceAgent, kill, restart

Methods inherited from interface org.openspaces.admin.DiscoverableComponent

isDiscovered

Methods inherited from interface org.openspaces.admin.internal.support.InternalAgentGridComponent

getAgentUid, setGridServiceAgent

Methods inherited from interface org.openspaces.admin.internal.support.InternalDiscoverableComponent

setDiscovered

Methods inherited from interface org.openspaces.admin.internal.machine.InternalMachineAware

setMachine

Methods inherited from interface org.openspaces.admin.internal.os.InternalOperatingSystemAware

setOperatingSystem

Methods inherited from interface org.openspaces.admin.internal.transport.InternalTransportAware

setTransport

Methods inherited from interface org.openspaces.admin.internal.vm.InternalVirtualMachineAware

setVirtualMachine

Methods inherited from interface org.openspaces.admin.internal.vm.InternalVirtualMachineInfoProvider

getJVMDetails

Methods inherited from interface org.openspaces.admin.internal.zone.InternalZoneAware

addZone

Methods inherited from interface org.openspaces.admin.machine.MachineAware

getMachine

Methods inherited from interface org.openspaces.admin.os.OperatingSystemAware

getOperatingSystem

Methods inherited from interface org.openspaces.admin.transport.TransportAware

getTransport

Methods inherited from interface org.openspaces.admin.vm.VirtualMachineAware

getVirtualMachine

Methods inherited from interface org.openspaces.admin.zone.ZoneAware

getZones

Constructor Details

DefaultGridServiceManager

public DefaultGridServiceManager(ServiceID serviceID,
 com.gigaspaces.grid.gsm.GSM gsm,
 InternalAdmin admin,
 int agentId,
 String agentUid,
 JVMDetails jvmDetails)
                          throws RemoteException

Throws:

RemoteException

Method Details

getDriver

public ServiceGridAdminDriver getDriver()

Specified by:

getDriver in interface InternalGridServiceManager

getUid

public String getUid()

Description copied from interface: GridComponent

Returns the unique id of the grid component.

Specified by:

getUid in interface GridComponent

Specified by:

getUid in interface InternalVirtualMachineInfoProvider

getServiceID

public ServiceID getServiceID()

Specified by:

getServiceID in interface InternalGridServiceManager

getGSM

public com.gigaspaces.grid.gsm.GSM getGSM()

Specified by:

getGSM in interface InternalGridServiceManager

deploy

public ProcessingUnit deploy(SpaceDeployment deployment)

Description copied from interface: GridServiceManager

Deploys a space based on the space deployment information on the given 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 GridServiceManager

deploy

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

Description copied from interface: GridServiceManager

Deploys a space based on the space deployment information on the given 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.

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

Specified by:

deploy in interface GridServiceManager

deploy

public ProcessingUnit deploy(ProcessingUnitDeployment deployment)

Description copied from interface: GridServiceManager

Deploys a processing unit based on the processing unit deployment information on the given 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 GridServiceManager

deploy

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

Description copied from interface: GridServiceManager

Deploys a processing unit based on the processing unit deployment information on the given 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 GridServiceManager

deploy

public ProcessingUnit deploy(ProcessingUnitConfigHolder puConfigHolder)

Description copied from interface: GridServiceManager

Deploys a new processing unit based on the specified configuration

Specified by:

deploy in interface GridServiceManager

deploy

public ProcessingUnit deploy(ProcessingUnitConfigHolder puConfigHolder,
 long timeout,
 TimeUnit timeUnit)

Description copied from interface: GridServiceManager

Deploys a new processing unit based on the specified configuration

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

Specified by:

deploy in interface GridServiceManager

toOperationalString

public static org.jini.rio.core.OperationalString toOperationalString(Properties props,
 Properties contextProperties)
                                                               throws Exception

Invoked via reflection from GSCImpl

Throws:

Exception

toOperationalString

public static org.jini.rio.core.OperationalString toOperationalString(Deploy deploy,
 ProcessingUnitConfig puConfig,
 String applicationName,
 String[] groups,
 LookupLocator[] locators,
 com.gigaspaces.grid.gsm.GSM gsm)
                                                               throws Exception

Throws:

Exception

toOperationalString

public static org.jini.rio.core.OperationalString toOperationalString(Deploy deploy,
 ProcessingUnitConfig puConfig,
 String applicationName,
 String[] groups,
 LookupLocator[] locators,
 com.gigaspaces.grid.gsm.GSM gsm,
 List<InstanceSLA> instanceSLAS)
                                                               throws Exception

Throws:

Exception

undeploy

public void undeploy(String processingUnitName)

Description copied from interface: GridServiceManager

Undeploys the processing unit based on its name. // wait for the lookup event of the processing unit by name. ProcessingUnit pu = admin.getProcessingUnits().waitFor("mypuname"); // wait for the lookup event of the grid service manager that manages the processing unit. pu.waitForManaged(); // undeploy the processing unit. pu.undeploy();

Specified by:

undeploy in interface GridServiceManager

destroyInstance

public void destroyInstance(ProcessingUnitInstance processingUnitInstance)

Specified by:

destroyInstance in interface InternalGridServiceManager

decrementPlannedInstances

public boolean decrementPlannedInstances(ProcessingUnit processingUnit)

Description copied from interface: InternalGridServiceManager

Decrements a planned instance if the number of planned instances is less then the actual instances to maintain.

Specified by:

decrementPlannedInstances in interface InternalGridServiceManager

Returns:

true if a planned instance was successfully decremented; false planned instances hasn't changed.

decrementInstance

public void decrementInstance(ProcessingUnitInstance processingUnitInstance)

Specified by:

decrementInstance in interface InternalGridServiceManager

incrementInstance

public void incrementInstance(ProcessingUnit processingUnit)

Specified by:

incrementInstance in interface InternalGridServiceManager

relocate

public void relocate(ProcessingUnitInstance processingUnitInstance,
 GridServiceContainer gridServiceContainer)

Specified by:

relocate in interface InternalGridServiceManager

Parameters:

processingUnitInstance - The processing unit instance to relocate

gridServiceContainer - The GSC to relocate to, or null if the GSM should decide on a suitable GSC to relocate to.

logEntries

public LogEntries logEntries(LogEntryMatcher matcher)
                      throws AdminException

Description copied from interface: LogProviderGridComponent

Returns the log entries matching the given matcher for the specific grid component. If it is managed by a GridServiceAgent, will get the log through it instead of creating a load on the actual grid component.

Specified by:

logEntries in interface LogProviderGridComponent

Throws:

AdminException

logEntriesDirect

public LogEntries logEntriesDirect(LogEntryMatcher matcher)
                            throws AdminException

Description copied from interface: LogProviderGridComponent

Same as LogProviderGridComponent.logEntries(com.gigaspaces.log.LogEntryMatcher), but does not try and get the logs from the agent.

Specified by:

logEntriesDirect in interface LogProviderGridComponent

Throws:

AdminException

reloadMetricConfiguration

public void reloadMetricConfiguration()
                               throws AdminException

Specified by:

reloadMetricConfiguration in interface MetricProvider

Throws:

AdminException

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... processors)
                        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.

processors - The list of processors to be used.

Throws:

AdminException

getNIODetails

public NIODetails getNIODetails()
                         throws RemoteException

Specified by:

getNIODetails in interface InternalTransportInfoProvider

Throws:

RemoteException

getNIOStatistics

public NIOStatistics getNIOStatistics()
                               throws RemoteException

Specified by:

getNIOStatistics in interface InternalTransportInfoProvider

Throws:

RemoteException

enableLRMIMonitoring

public void enableLRMIMonitoring()
                          throws RemoteException

Specified by:

enableLRMIMonitoring in interface InternalTransportInfoProvider

Throws:

RemoteException

disableLRMIMonitoring

public void disableLRMIMonitoring()
                           throws RemoteException

Specified by:

disableLRMIMonitoring in interface InternalTransportInfoProvider

Throws:

RemoteException

fetchLRMIMonitoringDetails

public LRMIMonitoringDetails fetchLRMIMonitoringDetails()
                                                 throws RemoteException

Specified by:

fetchLRMIMonitoringDetails in interface InternalTransportInfoProvider

Throws:

RemoteException

getCurrentTimeInMillis

public long getCurrentTimeInMillis()
                            throws RemoteException

Specified by:

getCurrentTimeInMillis in interface InternalOperatingSystemInfoProvider

Throws:

RemoteException

getOSDetails

public OSDetails getOSDetails()
                       throws RemoteException

Specified by:

getOSDetails in interface InternalOperatingSystemInfoProvider

Throws:

RemoteException

getOSStatistics

public OSStatistics getOSStatistics()
                             throws RemoteException

Specified by:

getOSStatistics in interface InternalOperatingSystemInfoProvider

Throws:

RemoteException

getJVMStatistics

public JVMStatistics getJVMStatistics()
                               throws RemoteException

Specified by:

getJVMStatistics in interface InternalVirtualMachineInfoProvider

Throws:

RemoteException

runGc

public void runGc()
           throws RemoteException

Specified by:

runGc in interface InternalVirtualMachineInfoProvider

Throws:

RemoteException

listDeployDir

public String[] listDeployDir()

Specified by:

listDeployDir in interface InternalGridServiceManager

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isDeployed

public boolean isDeployed(String processingUnitName)

Description copied from interface: GridServiceManager

Determine if this deployment is known to this GSM.

Specified by:

isDeployed in interface GridServiceManager

Parameters:

processingUnitName - the name of the deployed processing unit.

Returns:

true if this deployment is known; false otherwise.

deploy

public Application deploy(ApplicationDeployment deployment)
                   throws ApplicationAlreadyDeployedException,
ProcessingUnitAlreadyDeployedException

Description copied from interface: GridServiceManager

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

The deployment process will wait indefinitely

Specified by:

deploy in interface GridServiceManager

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(ApplicationConfig applicationConfig)
                   throws ApplicationAlreadyDeployedException,
ProcessingUnitAlreadyDeployedException

Description copied from interface: GridServiceManager

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

The deployment process will wait indefinitely

Specified by:

deploy in interface GridServiceManager

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 applicationDeployment,
 long timeout,
 TimeUnit timeUnit)
                   throws ApplicationAlreadyDeployedException,
ProcessingUnitAlreadyDeployedException

Description copied from interface: GridServiceManager

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 GridServiceManager

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)

deploy

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

Description copied from interface: GridServiceManager

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 GridServiceManager

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)

isActiveManager

public boolean isActiveManager()

Specified by:

isActiveManager in interface GridServiceManager

Returns:

true if managing at least one deployment ; false otherwise

deleteResource

public boolean deleteResource(String resourceName)

Specified by:

deleteResource in interface GridServiceManager

Returns:

true if successfully deleted the resource folder from the deploy folder ; false otherwise

getUnDeployedPus

public List<UndeployedPuMetaData> getUnDeployedPus()

Specified by:

getUnDeployedPus in interface GridServiceManager

Returns:

List of persistent undeployed processing units

deleteUndeployedPuData

public Map<String,String> deleteUndeployedPuData(String puName)

Description copied from interface: GridServiceManager

Delete data of a given undeployed tiered storage processing unit

Specified by:

deleteUndeployedPuData in interface GridServiceManager

Returns:

response of deletion status for each pu instance

setUndeployedLeader

public void setUndeployedLeader(String puName,
 int partitionId,
 String instanceId)

Description copied from interface: GridServiceManager

Set leader of a partition in an undeployed tiered storage processing unit.

Specified by:

setUndeployedLeader in interface GridServiceManager

setUndeployedInstanceIp

public void setUndeployedInstanceIp(String puName,
 String instanceId,
 String ip,
 boolean validateHost)

Description copied from interface: GridServiceManager

Set ip of an instance in an undeployed tiered storage processing unit.

Specified by:

setUndeployedInstanceIp in interface GridServiceManager

deploy

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

Specified by:

deploy in interface InternalGridServiceManager

getCodeBaseURL

public String getCodeBaseURL()

Specified by:

getCodeBaseURL in interface InternalGridServiceManager

getEvents

public org.jini.rio.monitor.event.Events getEvents(int maxEvents)

Specified by:

getEvents in interface InternalGridServiceManager