org.apache.geode.admin (Apache Geode 1.5.0)
Date: 2018-03-30

# Package org.apache.geode.admin

Provides an API for administering various GemFire components such as a GemFire distributed system, and processes that host GemFire Caches.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  AdminDistributedSystem | Deprecated as of 7.0 use the `management` package instead
  Alert | Deprecated as of 7.0 use the `management` package instead
  AlertListener | Deprecated as of 7.0 use the `management` package instead
  BackupStatus | Deprecated as of 7.0 use the `management` package instead
  CacheHealthConfig | Deprecated as of 7.0 use the `management` package instead
  CacheServer | Deprecated as of 5.7 use `CacheVm` instead.
  CacheServerConfig | Deprecated as of 5.7 use `CacheVmConfig` instead.
  CacheVm | Deprecated as of 7.0 use the `management` package instead
  CacheVmConfig | Deprecated as of 7.0 use the `management` package instead
  ConfigurationParameter | Deprecated as of 7.0 use the `management` package instead
  DistributedSystemConfig | Deprecated as of 7.0 use the `management` package instead
  DistributedSystemConfig.ConfigListener | A listener whose callback methods are invoked when this config changes.
  DistributedSystemHealthConfig | Deprecated as of 7.0 use the `management` package instead
  DistributionLocator | Deprecated as of 7.0 use the `management` package instead
  DistributionLocatorConfig | Deprecated as of 7.0 use the `management` package instead
  GemFireHealth | Deprecated as of 7.0 use the `management` package instead
  GemFireHealthConfig | Deprecated as of 7.0 use the `management` package instead
  ManagedEntity | Deprecated as of 7.0 use the `management` package instead
  ManagedEntityConfig | Deprecated as of 7.0 use the `management` package instead
  MemberHealthConfig | Deprecated as of 7.0 use the `management` package instead
  Statistic | Deprecated as of 7.0 use the `management` package instead
  StatisticResource | Deprecated as of 7.0 use the `management` package instead
  SystemMember | Deprecated as of 7.0 use the `management` package instead
  SystemMemberBridgeServer | Deprecated as of 5.7 use `SystemMemberCacheServer` instead.
  SystemMemberCache | Deprecated as of 7.0 use the `management` package instead
  SystemMemberCacheEvent | Deprecated as of 7.0 use the `management` package instead
  SystemMemberCacheListener | Deprecated as of 7.0 use the `management` package instead
  SystemMemberCacheServer | Deprecated as of 7.0 use the `management` package instead
  SystemMemberRegion | Deprecated as of 7.0 use the `management` package instead
  SystemMemberRegionEvent | Deprecated as of 7.0 use the `management` package instead
  SystemMembershipEvent | Deprecated as of 7.0 use the `management` package instead
  SystemMembershipListener | Deprecated as of 7.0 use the `management` package instead

- Class Summary
  Class | Description
  --- | ---
  AdminConfig | Deprecated as of 7.0 use the `management` package instead
  AdminConfig.Entry |
  AdminDistributedSystemFactory | Deprecated as of 7.0 use the `management` package instead
  AlertLevel | Deprecated as of 7.0 use the `management` package instead
  GemFireHealth.Health | An enumerated type for the health of GemFire.
  GemFireMemberStatus | Deprecated as of 7.0 use the `management` package instead
  RegionSubRegionSnapshot | Deprecated as of 7.0 use the `management` package instead
  SystemMemberType | Deprecated as of 7.0 use the `management` package instead

- Exception Summary
  Exception | Description
  --- | ---
  AdminException | Deprecated as of 7.0 use the `management` package instead
  AdminXmlException | Deprecated as of 7.0 use the `management` package instead
  CacheDoesNotExistException | Deprecated as of 7.0 use the `management` package instead
  OperationCancelledException | Deprecated as of 7.0 use the `management` package instead
  RegionNotFoundException | Deprecated as of 7.0 use the `management` package instead
  RuntimeAdminException | Deprecated as of 7.0 use the `management` package instead
  UnmodifiableConfigurationException | Deprecated as of 7.0 use the `management` package instead

## Package org.apache.geode.admin Description

Provides an API for administering various GemFire components such as a GemFire distributed system, and processes that host GemFire Caches.

### Administration of a GemFire Distributed System

The Admin API provides interfaces for administrative control, monitoring, and custom management of a GemFire system.

The `AdminDistributedSystemFactory` is the starting point. It creates an instance of `AdminDistributedSystem` that administers the distributed system to which a VM is connected.

    DistributedSystem connection = DistributedSystem.connect(new Properties());
    AdminDistributedSystem system =
        AdminDistributedSystemFactory.getDistributedSystem(connection);
    system.connect(new File("admin.log"), "info");

This `AdminDistributedSystem` interface exposes methods for such tasks as connecting to the system, merging system logs, getting administrative interfaces to applications that host GemFire Caches.

### Monitoring the Health of GemFire

The `GemFireHealth` interface allows the overall health of GemFire to be monitored. `GemFireHealth` monitors the behavior the members of a distributed system namely application VMs that may host `cache` instances. There are three levels of health: good health that indicates that all GemFire components are behaving reasonably, okay health that indicates that one or more GemFire components is slightly unhealthy and may need some attention, and poor health that indicates that a GemFire component is unhealthy and needs immediate attention.

Because each GemFire application has its own definition of what it means to be "healthy", the metrics that are used to determine health are configurable. `GemFireHealthConfig` provides methods for configuring how the health of the distributed system, members that host Cache instances, and individual members of the distributed system. `GemFireHealthConfig` also allows you to configure how often GemFire's health is evaluated.