org.openspaces.admin.internal.esm

Class DefaultElasticServiceManager

java.lang.Object

org.openspaces.admin.internal.support.AbstractGridComponent

org.openspaces.admin.internal.support.AbstractAgentGridComponent

org.openspaces.admin.internal.esm.DefaultElasticServiceManager

All Implemented Interfaces:

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

public class DefaultElasticServiceManager
extends AbstractAgentGridComponent
implements InternalElasticServiceManager

Author:

Moran Avigdor, itaif

Field Summary

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

admin

Constructor Summary

Constructors

Constructor and Description
DefaultElasticServiceManager(ServiceID serviceID, ESM esm, InternalAdmin admin, int agentId, String agentUid, JVMDetails jvmDetails)

Method Summary

Modifier and Type	Method and Description
void	disableAgentFailureDetection(String processingUnitName, long timeout, TimeUnit timeunit) Disables the GSA failure detection of the calling PU instance.
void	disableLRMIMonitoring()
void	enableAgentFailureDetection(String processingUnitName) Re-Enable the GSA failure detection of the calling PU instance.
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.
long	getCurrentTimeInMillis()
ESM	getESM()
JVMStatistics	getJVMStatistics()
NIODetails	getNIODetails()
NIOStatistics	getNIOStatistics()
OSDetails	getOSDetails()
OSStatistics	getOSStatistics()
ScaleStrategyConfig	getProcessingUnitScaleStrategyConfig(ProcessingUnit pu)
Remote	getRemoteApi(String processingUnitName, String apiName) expose access to remote provisioning APIs given by the ElasticMachineProvisioningCloudifyAdapter.
org.jini.rio.monitor.event.Events	getScaleStrategyEvents(long cursor, int maxNumberOfEvents)
ServiceID	getServiceID()
String	getUid() Returns the unique id of the grid component.
int	hashCode()
boolean	isManagingProcessingUnit(ProcessingUnit pu)
boolean	isManagingProcessingUnitAndScaleInProgress(ProcessingUnit pu)
boolean	isManagingProcessingUnitAndScaleNotInProgress(ProcessingUnit pu)
boolean	isManagingProcessingUnitAndScaleNotInProgressNoCache(ProcessingUnit pu) Deprecated.
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	processElasticScaleStrategyEvent(ElasticProcessingUnitEvent event) reflect the ESM state in the admin API object by analyzing the events
void	reloadMetricConfiguration()
void	runGc()
void	setProcessingUnitElasticProperties(ProcessingUnit pu, Map<String,String> properties)
void	setProcessingUnitScaleStrategyConfig(ProcessingUnit pu, ScaleStrategyConfig scaleStrategyConfig)

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.internal.support.InternalAgentGridComponent

getAgentUid, setGridServiceAgent

Methods inherited from interface org.openspaces.admin.AgentGridComponent

getAgentId, getGridServiceAgent, kill, restart

Methods inherited from interface org.openspaces.admin.AdminAware

getAdmin

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

setDiscovered

Methods inherited from interface org.openspaces.admin.DiscoverableComponent

isDiscovered

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

setMachine

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

getMachine

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

setTransport

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

getTransport

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

setOperatingSystem

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

getOperatingSystem

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

getJVMDetails

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

setVirtualMachine

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

getVirtualMachine

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

addZone

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

getZones

Constructor Detail

DefaultElasticServiceManager

public DefaultElasticServiceManager(ServiceID serviceID,
                                    ESM esm,
                                    InternalAdmin admin,
                                    int agentId,
                                    String agentUid,
                                    JVMDetails jvmDetails)
                             throws RemoteException

Throws:

RemoteException

Method Detail

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 InternalElasticServiceManager

getESM

public ESM getESM()

Specified by:

getESM in interface InternalElasticServiceManager

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setProcessingUnitElasticProperties

public void setProcessingUnitElasticProperties(ProcessingUnit pu,
                                               Map<String,String> properties)

Specified by:

setProcessingUnitElasticProperties in interface InternalElasticServiceManager

setProcessingUnitScaleStrategyConfig

public void setProcessingUnitScaleStrategyConfig(ProcessingUnit pu,
                                                 ScaleStrategyConfig scaleStrategyConfig)

Specified by:

setProcessingUnitScaleStrategyConfig in interface InternalElasticServiceManager

getProcessingUnitScaleStrategyConfig

public ScaleStrategyConfig getProcessingUnitScaleStrategyConfig(ProcessingUnit pu)

Specified by:

getProcessingUnitScaleStrategyConfig in interface InternalElasticServiceManager

isManagingProcessingUnit

public boolean isManagingProcessingUnit(ProcessingUnit pu)

Specified by:

isManagingProcessingUnit in interface InternalElasticServiceManager

isManagingProcessingUnitAndScaleNotInProgress

public boolean isManagingProcessingUnitAndScaleNotInProgress(ProcessingUnit pu)

Specified by:

isManagingProcessingUnitAndScaleNotInProgress in interface InternalElasticServiceManager

isManagingProcessingUnitAndScaleNotInProgressNoCache

@Deprecated
public boolean isManagingProcessingUnitAndScaleNotInProgressNoCache(ProcessingUnit pu)

Deprecated.

Specified by:

isManagingProcessingUnitAndScaleNotInProgressNoCache in interface InternalElasticServiceManager

isManagingProcessingUnitAndScaleInProgress

public boolean isManagingProcessingUnitAndScaleInProgress(ProcessingUnit pu)

Specified by:

isManagingProcessingUnitAndScaleInProgress in interface InternalElasticServiceManager

getScaleStrategyEvents

public org.jini.rio.monitor.event.Events getScaleStrategyEvents(long cursor,
                                                                int maxNumberOfEvents)

Specified by:

getScaleStrategyEvents in interface InternalElasticServiceManager

Returns:

the list of events generated by the ESM. For the beginning of the list start with cursor = 0

processElasticScaleStrategyEvent

public void processElasticScaleStrategyEvent(ElasticProcessingUnitEvent event)

Description copied from interface: InternalElasticServiceManager

reflect the ESM state in the admin API object by analyzing the events

Specified by:

processElasticScaleStrategyEvent in interface InternalElasticServiceManager

getRemoteApi

public Remote getRemoteApi(String processingUnitName,
                           String apiName)

Description copied from interface: InternalElasticServiceManager

expose access to remote provisioning APIs given by the ElasticMachineProvisioningCloudifyAdapter. (Network/Storage etc)

Specified by:

getRemoteApi in interface InternalElasticServiceManager

Parameters:

processingUnitName - - the processing unit name the cloud driver belongs to.

apiName - - the name of the remote API to access.

Returns:

an instance of a class implementing a specific provisioning api.

disableAgentFailureDetection

public void disableAgentFailureDetection(String processingUnitName,
                                         long timeout,
                                         TimeUnit timeunit)

Description copied from interface: InternalElasticServiceManager

Disables the GSA failure detection of the calling PU instance. The LRMI layer is used to identify the ip address of the caller to determine the GSA. If the GSA shuts down, no recovery operation will be performed. If any other component fails (GSC/PU), recovery operation will be performed as usual. This method is called before an agent (or one of its components) decides to reboot the machine. Call #enableAgentFailover(String) to re-enable agent failure detection functionality after the machine has completed reboot. Agent failover is enabled automatically once the timeout expires.

Specified by:

disableAgentFailureDetection in interface InternalElasticServiceManager

Parameters:

processingUnitName - - The name of the calling PU

enableAgentFailureDetection

public void enableAgentFailureDetection(String processingUnitName)

Description copied from interface: InternalElasticServiceManager

Re-Enable the GSA failure detection of the calling PU instance. The LRMI layer is used to identify the ip address of the caller to determine the GSA.

Specified by:

enableAgentFailureDetection in interface InternalElasticServiceManager

Parameters:

processingUnitName - - The name of the calling PU

See Also:

#disableAgentFailover(String)