Package com.gigaspaces.grid.gsc

A dynamic lightweight container offering allocation and provisioning capabilities.

See:
Description

Interface Summary

GSC	The Grid Service Container (GSC) represents the capabilities of a compute resource, making the compute resource available as a service on the network, and provides a dynamic lightweight container to instantiate dynamic application services.

Package com.gigaspaces.grid.gsc Description

A dynamic lightweight container offering allocation and provisioning capabilities. The Grid Service Container represents the capabilities of compute resource through quantitative and qualitative mechanisms. Grid Service Container instances dynamically discover and enlist with dynamic provisioning agents, and provides a dynamic lightweight container to instantiate dynamic services.

Configuring Grid Service Container

Grid Service Container supports the following configuration entries; where each configuration entry name is associated with the component names com.gigaspaces.grid.gsc, org.jini.rio, org.jini.rio.boot and org.jini.rio.cybernode. Details on the configuration entry values and defaults follow.

• Configuration entries specific to com.gigaspaces.grid.gsc
• Configuration entries specific to org.jini.rio
• Configuration entries specific to org.jini.rio.boot
• Configuration entries specific to org.jini.rio.cybernode
• Configuration support for running the Grid Service Container using RMI Activation

Configuration entries specific to com.gigaspaces.grid.gsc

The Grid Service Container supports the following configuration entries; where each configuration entry name is associated with the component name com.gigaspaces.grid.gsc. The following configuration entries provide the opportunity to declaratively modify the operational behavior of the Grid Service Container.

• antCommand

  Type:	com.gigaspaces.ant.TaskDescriptor
  Default:	null
  Description:	This entry will be read at initialization by a Grid Service Container to determine the name of the Ant build file to run during the initialization of the Grid Service Container. For example: <Component Name="com.gigaspaces.grid.gsc"> <Parameter Name="antFile"> <![CDATA[new com.gigaspaces.ant.TaskDescriptor("../update.xml", false) ]]>s </Parameter> </Component> This example will run Ant using the update.xml file from a relative location of the working directory of the Grid Service Container, with the default project target, starting Ant asynchronously

• availabilitySchedule

  Type:	org.jini.rio.core.Schedule
  Default:	null
  Description:	Specifies the availability schedule for a Grid Service Container. If a Schedule is provided, the Grid Service Container will register and unregister to discovered Grid Service Manager instances based on the declared schedule. For example, if the Grid Service Container were to be available every day from 9 to 5, the following schedule would be declared : com.gigaspaces.grid.gsc { ... eightHours = 28800000; sixteenHours = 57600000; availablitySchedule = new Schedule(9, /* hour */ 0, /* minute */ eightHours, /* duration */ Schedule.INDEFINITE, /* repeats */ sixteenHours); }

• faultDetectionHandler

  Type:	FaultDetectionHandler
  Default:	A new AdminFaultDetectionHandler
  Description:	The faultDetectionHandler is used to configure the FaultDetectionHandler to determine reachability for the Grid Service Container.

• initialLookupGroups
  

  Type:	String[]
  Default:	All groups
  Description:	This entry will be read at initialization by a Grid Service Container to determine the initial set of multicast discovery groups the Grid Service Container should participate in. Any future changes to the set of discovery groups should be made via the Grid Service Container 's admin proxy using the JoinAdmin interface.

• initialLookupLocators
  

  Type:	LookupLocator[]
  Default:	null
  Description:	This entry will be read at initialization by a Grid Service Container to determine the initial set of specific lookup services the Grid Service Container should register with. Any future changes to the set of discovery groups should be made via the Grid Service Container 's admin proxy using the JoinAdmin interface.

• initialServices

  Type:	String[]
  Default:	null
  Description:	An array of deployment descriptor files. The deployment descriptor file(s) will be loaded at startup, creating a service instance for each service bean declared in the loaded deployment descriptor(s). The implications of using this property are that the services loaded are not managed by the Grid Service Manager (GSM), resulting in no management for fault detection & recovery, or declared behavioral policies which require the assistance of the GSM (such as the ScalablePolicyHandler or RelocationPolicyHandler). Example of using the declaration: com.gigaspaces.grid.gsc { initialServices = new String[]{"../opstrings/hello.xml"}; }

• initialServiceLoadDelay

  Type:	long
  Default:	5 seconds
  Description:	The amount of time (in milliseconds) to wait to load configured services described in deployment descriptors

• logDirectory
  

  Type:	String
  Default:	null
  Description:	If the a log directory is being used, the value of this entry is the name of the directory that will be used to persist the Grid Service Container 's state. Obtained at persistent service start and restart.

• loggerConfig
  

  Type:	org.jini.rio.log.LoggerConfig[]
  Default:	net.jini.core.discovery
  Description:	The LoggerConfig class provides the capability to declare a configuration attribute that specifies Logger attributes (Level, Handler, etc...) and have the attributes established without depending on machine resident logger.properties configuration attributes to be set.

• loginContext
  

  Type:	LoginContext
  Default:	Do not perform JAAS login
  Description:	Specifies the JAAS login context to use for performing a JAAS login and supplying the Subject to use when running the service. If this entry is not specified, no JAAS login is performed. This entry is obtained at service start and restart.

• operationalStringManagerPreparer

  Type:	ProxyPreparer
  Default:	An instance of net.jini.security.BasicProxyPreparer that does nothing
  Description:	The ProxyPreparer passed in OperationalStringManager instances.

• opStringName
  

  Type:	String
  Default:	""
  Description:	The name of the OperationalString the Grid Service Container is a part of.

• nativeLibDirectory
  

  Type:	String[]
  Default:	The default directory to load native libraries from is <gigaspaces-home-directory>/native. The Grid Service Container home directory is determined by the system property com.gigaspaces.grid.gsc.home. If the com.gigaspaces.grid.gsc.home property does not exist, the default location is <user-home-directory>/.gigaspaces/native
  Description:	An array of directory names to load native libraries from. At startup this value is used to create org.jini.rio.qos.capability.software.NativeLibrarySupport objects which represent native libraries found in these locations

• provisionEnabled
  

  Type:	boolean
  Default:	false
  Description:	ServiceBean instances may require external software to be resident on the compute resource the Grid Service Container represents. Setting this property will allow the Grid Service Container to install external software defined by ServiceBeans

• provisionRoot
  

  Type:	String
  Default:	If no provision root is provided, the Grid Service Container will establish the provision root using the home directory of the user, followed by the .gigaspaces subdirectory and add an external directory. For example: /usr/home/gigaspaces/.gigaspaces/external
  Description:	The directory to which external software is provisioned. This is the root directory where software may be installed by ServiceBean instances which require external software to be resident on the compute resource the Grid Service Container represents.

  
  
• recordAge
  

  Type:	long
  Default:	30. If no record age is provided, the Grid Service Container will remove persisted ServiceStatement instances if they are over 30 days old.
  Description:	The age a persisted ServiceStatement instance should remain on the filesystem before it is removed. Persisted ServiceStatement instances will be removed if they are older then the alloted age and if all the ServiceRecord instances within the ServiceStatement are INACTIVE. The value provided represents the number of days a record can age before it is removed. If records should live forever, then a value of 0 should be provided.

• recordDirectory
  

Type:	String
Default:	If no record directory root is provided, the Grid Service Container will establish the record directory root using the home directory of the user, followed by the .gigaspaces subdirectory, and add a records directory. For example: /usr/home/gigaspaces/.gigaspaces/records.
Description:	The directory to persist ServiceStatement instances to. ServiceStatement instances are created to record a ServiceBean's instantiation and resource usage.

• serviceBeanFactory
  

  Type:	ServiceBeanFactory
  Default:	JSBLoader
  Description:	The org.jini.rio.core.jsb.ServiceBeanFactory defines the semantics to create a service which will be hosted by the Grid Service Container. The implementation of the org.jini.rio.core.jsb.ServiceBeanFactory creates a service implementation and proxy to communicate with the service. Implementations of this interface may provide support for interoperability with external systems and native applications. See ServiceBeanFactory and JSBLoader.

• serviceBeanContainer
  

  Type:	org.jini.rio.cybernode.ServiceBeanContainer
  Default:	org.jini.rio.cybernode.JSBContainer
  Description:	The ServiceBeanContainer provides the capabilities and support necessary to instantiate and manage dynamic services.

• serviceComment
  

  Type:	String
  Default:	null
  Description:	The comment the Grid Service Container will use to construct a Comment Entry.

• serverExporter
  

  Type:	Exporter
  Default:	A new BasicJeriExporter with a TcpServerEndpoint created on a random port a BasicILFactory distributed garbage collection turned off keep alive on If activatable, the same default will be used but wrapped in an ActivationExporter and created with the service's ActivationID.
  Description:	The exporter used to export the server. If the server is activatable, the service's ActivationID will be passed as the data argument, otherwise the data argument will be null. A new exporter is obtained every time a Grid Service Container needs to export itself.

• serviceLimit
  

  Type:	int
  Default:	500
  Description:	The serviceLimit indicates the maximum amount of service instances the Grid Service Container instance will instantiate.

  
  
• serviceName
  

  Type:	String
  Default:	Grid Service Container
  Description:	The name the Grid Service Container should use as a Name Entry, and for display purposes.

• serviceRecordUpdateTaskTimer

  Type:	long
  Default:	60 seconds
  Description:	The serviceRecordUpdateTaskTimer specifies the amount of time (in seconds) between ServiceRecordUpdateTask sheduling. A ServiceRecordUpdateTask is scheduled at repeated fixed-rate execution, beginning after the specified delay. Subsequent executions take place at approximately regular intervals, separated by the specified period. ServiceStatement instances are updated with ServiceRecords for active ServiceBeans.

• serviceSecurityPolicy
  

  Type:	String
  Default:	If no serviceSecurityPolicy is provided, the policy file used will the policy set for the VM, obtained from System.getProperty("java.security.policy"); .
  Description:	The security policy to apply to services which are instantiated by the Grid Service Container. The Grid Service Container uses a com.sun.jini.start.AggregatePolicyProvider, which associates security sub-policies with context class loaders.

• serviceStatementManager
  

  Type:	ServiceStatementManager
  Default:	If no ServiceStatementManager is provided, a TransientServiceStatementManager is used.
  Description:	The ServiceStatementManager to use for managing ServiceStatements. This value must be suitable for Class.forName() use.

• serviceTerminationOnUnregister
  

  Type:	boolean
  Default:	true
  Description:	If the Grid Service Container has been configured with an availability Schedule, and the Grid Service Container removes itself as an asset, this property determines whether instantiated services should be terminated upon unregistration.

• slaThresholdTaskPoolMaximum
  

  Type:	int
  Default:	20
  Description:	The maximum amount of Thread instances to have in the pool of Thread instances used to notify interested clients of SLA Thresholds, which have been set for the Grid Service Container and crossed.

• slaThresholdTaskPoolMinimum
  

  Type:	int
  Default:	5
  Description:	The minimum amount of Thread instances to have in the pool of Thread instances used to notify interested clients of SLA Thresholds, which have been set for the Grid Service Container and crossed.

Configuration entries specific to org.jini.rio

Grid Service Container supports the following configuration entries for interoperating with the Rio technology core support. This area is focused on the declaration of a common, or default exporter.

• defaultExporter
  

  Type:	Exporter
  Default:	A new BasicJeriExporter with a TcpServerEndpoint created on a random port a BasicILFactory distributed garbage collection turned off keep alive on
  Description:	This allows deployers to configure one Exporter that all services (if service configurations declare), will use the Exporter configured by this property as the Exporter. Declaring that your Service will use the Exporter configured as its Exporter is done as follows: <Configuration> <Component Name="org.jini.rio"> <Parameter Name="defaultExporter" Value="$org_jini_rio_defaultExporter"/> </Component> </Configuration> All underlying Rio classes which create Exporter instances will always check whether an entry has been configured. The org.jini.rio.config.ExporterConfig utility is used.

Configuration entries specific to org.jini.rio.boot

Grid Service Container supports the following configuration entries for interoperating with the Rio technology boot/startup support.

• computeResource

  Type:	org.jini.rio.qos.ComputeResource
  Default:	new org.jini.rio.qos.ComputeResource(new String[] {"-"});
  Description:	Creates the ComputeResource component, representing qualitative and quantitative capabilities of the compute resource the service is executing on. The org.jini.rio.qos.ComputeResource object has a single Constructor which takes as an argument a String[], which is used to construct a net.jini.config.Configuration object, to provide attributes specific to the initialization of the org.jini.rio.qos.ComputeResource component.

• createShutdownHook

  Type:	Boolean
  Default:	true
  Description:	Creates a shutdown hook. This will result in the registration of a virtual-machine shutdown hook. The shutdown hook will provide an orderly shutdown of all service instances the Grid Service Container has instantiated by calling the service's destroy method.

• verifyMulticast

  Type:	Boolean
  Default:	true
  Description:	Determines if a Multicast socket can be created and a Request announcement can be sent. Note that it is still possible that multicast does not work outside the host. This configuration property may be redundant with multicast checks enabled by the Service Grid startup package, and should be verified.

Configuration entries specific to org.jini.rio.cybernode.

Grid Service Container supports the following configuration entries for interoperating with the Rio technology Cybernode service. These configuration properties control how the connection to a Provision Monitor instance is managed; where each configuration entry name is associated with the component name org.jini.rio.cybernode

• provisionerLeaseDuration
  

  Type:	long
  Default:	60 seconds
  Description:	The duration of the Lease requested (in seconds) by the ServiceInstantiator to ProvisionManager instances.

• provisionerPreparer
  

  Type:	ProxyPreparer
  Default:	An instance of BasicProxyPreparer that does nothing
  Description:	ProxyPreparer for ProvisionManager proxies. The preparer should expect the register and update methods to be called on the returned proxy.

  
  
• provisionerRetryCount
  

  Type:	int
  Default:	3
  Description:	The number of times the ServiceInstantiator consumer should attempt to reconnect to a ProvisionManager instance, if that instance could not be reached for Lease renewal.

  
  
• provisionerRetryDelay
  

  Type:	long
  Default:	1 second
  Description:	The length of time (in seconds) the ServiceInstantiator should wait before attempting to reconnect to a ProvisionManager instance, if that instance could not be reached for LeaseRenewal.

Configuration support for running the Grid Service Container using RMI Activation

Grid Service Container supports the following configuration entries for interoperating with the RMI Activation system; where each configuration entry name is associated with the component name com.gigaspaces.grid.gsc.

• activationIdPreparer

  Type:	ProxyPreparer
  Default:	new BasicProxyPreparer()
  Description:	Specifies the proxy preparer to use for the ActivationIDfor this service, if this service is running as activatable.

• activationSystemPreparer

  Type:	ProxyPreparer
  Default:	new BasicProxyPreparer()
  Description:	Specifies the proxy preparer to use for the ActivationSystemproxy. During shutdown, this service calls the unregisterObject method on the ActivationSystem instance returned from this preparer.