com.gemstone.gemfire.internal.statistics.StatArchiveHandlerConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation

SnappyData store based off Pivotal GemFireXD

There is a newer version: 2.0-BETA

/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License. You
 * may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.internal.statistics;

import java.io.File;

/**
 * Defines the contract enabling the {@link StatArchiveHandler} to retrieve
 * configuration details (some of which may change at runtime).
 * 
 * Implemented by {@link com.gemstone.gemfire.internal.HostStatSampler}.

 * @author Kirk Lund
 * @since 7.0
 * @see com.gemstone.gemfire.distributed.internal.RuntimeDistributionConfigImpl
 */
public interface StatArchiveHandlerConfig {

  /**
   * Gets the name of the archive file.
   */
  public File getArchiveFileName();
  
  /**
   * Gets the archive size limit in bytes.
   */
  public long getArchiveFileSizeLimit();
  
  /**
   * Gets the archive disk space limit in bytes.
   */
  public long getArchiveDiskSpaceLimit();

  /**
   * Returns a unique id for the sampler's system.
   */
  public long getSystemId();

  /**
   * Returns the time this sampler's system was started.
   */
  public long getSystemStartTime();

  /**
   * Returns the path to this sampler's system directory; if it has one.
   */
  public String getSystemDirectoryPath();
  
  /**
   * Returns a description of the product that the stats are on
   */
  public String getProductDescription();
}