management
package instead@Deprecated public class AdminDistributedSystemFactory extends Object
Constructor and Description |
---|
AdminDistributedSystemFactory()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static void |
bindToAddress(String bindAddress)
Deprecated.
|
static DistributedSystemConfig |
defineDistributedSystem()
Deprecated.
Defines a "default" distributed system configuration based on VM system properties and the
content of
gemfire.properties . |
static DistributedSystemConfig |
defineDistributedSystem(DistributedSystem system,
String remoteCommand)
Deprecated.
Defines a distributed system configuration for administering the distributed system to which
this VM is currently connected.
|
static AdminDistributedSystem |
getDistributedSystem(DistributedSystemConfig config)
Deprecated.
Returns the distributed system for administrative monitoring and managing.
|
static LogWriter |
getLogWriter()
Deprecated.
Returns a default GemFire LogWriterI18n for logging.
|
static void |
setEnableAdministrationOnly(boolean adminOnly)
Deprecated.
Call this method with a value of
true to dedicate the VM to GemFire administration
only. |
@Deprecated public static void bindToAddress(String bindAddress)
DistributedSystemConfig.setBindAddress(java.lang.String)
instead.Using a null or empty bindAddress will clear the usage of this option and connections to distributed systems will return to using all available network interfaces.
This method always throws UnsupportedOperationException because it is now deprecated and is
unsafe to use. Please use DistributedSystemConfig.setBindAddress(java.lang.String)
instead.
bindAddress
- machine name or IP address to bind toUnsupportedOperationException
- because of deprecationpublic static DistributedSystemConfig defineDistributedSystem()
gemfire.properties
. The
DistributedSystemConfig.DEFAULT_REMOTE_COMMAND default remote command is used.gemfire.properties
DistributedSystem.connect(java.util.Properties)
public static void setEnableAdministrationOnly(boolean adminOnly)
true
to dedicate the VM to GemFire administration
only. Default is false
.
This method must be called before calling AdminDistributedSystem.connect()
. It
must also be called before DistributedSystem.connect(java.util.Properties)
is when creating a
colocated distributed system.
Once it has been enabled be careful to only use GemFire APIs from the
org.apache.geode.admin
package. In particular do not create a
Cache
or a normal DistributedSystem
.
adminOnly
- true
if this VM should be limited to administration APIs;
false
if this VM should allow all GemFire APIs.IllegalStateException
- if a DistributedSystem
or AdminDistributedSystem
connection already exists.public static DistributedSystemConfig defineDistributedSystem(DistributedSystem system, String remoteCommand) throws AdminException
DistributedSystem
is used to configure the
discovery mechanism (multicast or locators), bind address, SSL attributes, as well as the
logger of the DistributedSystemConfig
. Note that the distributed system will not
be able to be administered until the connect
method is
invoked.system
- A connection to the distributed systemremoteCommand
- The shell command that is used to launch processes that run on remote
machines. If null
, then the
default will be used.AdminException
- is an exception is encounteredpublic static AdminDistributedSystem getDistributedSystem(DistributedSystemConfig config)
AdminDistributedSystem.connect()
before interacting with the actual system.config
- configuration definition of the system to administerpublic static LogWriter getLogWriter()