SQLFire 1.0.3

com.vmware.sqlfire
Interface FabricAgent

All Superinterfaces:
com.gemstone.gemfire.admin.jmx.Agent, FabricService

public interface FabricAgent
extends FabricService, com.gemstone.gemfire.admin.jmx.Agent


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.vmware.sqlfire.FabricService
FabricService.State
 
Field Summary
 
Fields inherited from interface com.vmware.sqlfire.FabricService
NETSERVER_DEFAULT_PORT, STOP_NETWORK_SERVERS
 
Fields inherited from interface com.gemstone.gemfire.admin.jmx.Agent
JNDI_NAME
 
Method Summary
 void start(Properties bootProperties)
          Start the SQLFire server singleton instance if not already started.
 void start(Properties bootProperties, boolean ignoreIfStarted)
          Start the SQLFire server singleton instance if not already started.
 FabricService.State status()
          Returns the fabric server status.
 
Methods inherited from interface com.vmware.sqlfire.FabricService
getAllNetworkServers, startNetworkServer, stop, stopAllNetworkServers
 
Methods inherited from interface com.gemstone.gemfire.admin.jmx.Agent
connectToSystem, disconnectFromSystem, getConfig, getDistributedSystem, getLogWriter, getMBeanServer, getObjectName, isConnected, manageDistributedSystem, saveProperties, start, stop
 

Method Detail

start

void start(Properties bootProperties)
           throws SQLException
Start the SQLFire server singleton instance if not already started. In case the server has already been started then the old instance is first stopped and then started again with the new properties. Initiates and establishes connections with all the other peer members.

Properties can be also configured in a file called 'sqlfire.properties' or defined as system properties. SQLFire looks for this file in 'sqlfire.user.home' directory, if set, otherwise in the current working directory, followed by 'user.home' directory. The file name can be overridden using the system property -Dsqlfire.properties=. If this value is a relative file system path then the above search is done. If it is an absolute file system path then that file must exist; no search for it is done.

The actual configuration attribute values used to connect comes from the following sources:

  1. System properties. If a system property named "sqlfire.propertyName" is defined and its value is not an empty string then its value will be used for the named configuration attribute.
  2. Code properties. Otherwise if a property is defined in the bootProperties parameter object and its value is not an empty string then its value will be used for that configuration attribute.
  3. File properties. Otherwise if a property is defined in a configuration property file found by this application and its value is not an empty string then its value will be used for that configuration attribute. A configuration property file may not exist. See the following section for how configuration property files are found.
  4. Defaults. Otherwise a default value is used.

If authentication is switched on, system user credentials must also be passed to start the server

Parameters:
bootProperties - Driver boot properties. If non-null, overrides default properties in 'sqlfire.properties'.
Throws:
SQLException

start

void start(Properties bootProperties,
           boolean ignoreIfStarted)
           throws SQLException
Start the SQLFire server singleton instance if not already started. Initiates and establishes connections with all the other peer members.

Properties can be also configured in a file called 'sqlfire.properties' or defined as system properties. SQLFire looks for this file in 'sqlfire.user.home' directory, if set, otherwise in the current working directory, followed by 'user.home' directory. The file name can be overridden using the system property -Dsqlfire.properties=. If this value is a relative file system path then the above search is done. If it is an absolute file system path then that file must exist; no search for it is done.

The actual configuration attribute values used to connect comes from the following sources:

  1. System properties. If a system property named "sqlfire.propertyName" is defined and its value is not an empty string then its value will be used for the named configuration attribute.
  2. Code properties. Otherwise if a property is defined in the bootProperties parameter object and its value is not an empty string then its value will be used for that configuration attribute.
  3. File properties. Otherwise if a property is defined in a configuration property file found by this application and its value is not an empty string then its value will be used for that configuration attribute. A configuration property file may not exist. See the following section for how configuration property files are found.
  4. Defaults. Otherwise a default value is used.

If authentication is switched on, system user credentials must also be passed to start the server

Parameters:
bootProperties - Driver boot properties. If non-null, overrides default properties in 'sqlfire.properties'.
ignoreIfStarted - if true then reuse any previous active instance, else stop any previous instance and start a new one with given properties
Throws:
SQLException

status

FabricService.State status()
Returns the fabric server status.

Specified by:
status in interface FabricService
Returns:
FabricService.State

SQLFire 1.0.3

Copyright © 2010-2012 VMware, Inc. All rights reserved.