de.mcs.jmeasurement.jmx.JmxConfigMBean Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of JMeasurement Show documentation
JMeasurement profiling programs in production enviroment
The newest version!
/*
 * MCS Media Computer Software Copyright (c) 2007 by MCS
 * -------------------------------------- Created on 09.01.2007 by W.Klaas
 * 
 * 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.
 */
package de.mcs.jmeasurement.jmx;

import java.io.IOException;

import org.xml.sax.SAXException;

/**
 * MBean interface for the configuration.
 * 
 * @author W.Klaas
 */
public interface JmxConfigMBean {
  /**
   * @return the configured background time.
   */
  int getBackgroundTime();

  /**
   * @param backgroundTime
   *            setting the background time.
   */
  void setBackgroundTime(int backgroundTime);

  /**
   * @return will the config file automatically rereaded.
   */
  boolean isConfigAutofile();

  /**
   * @param configAutofile
   *            setting, if the configuration file will be automatically
   *            rereaded.
   */
  void setConfigAutofile(boolean configAutofile);

  /**
   * @return is the deviation support disabled.
   */
  boolean isDisableDeviation();

  /**
   * @param disableDeviation
   *            disable the deviation support.
   */
  void setDisableDeviation(boolean disableDeviation);

  /**
   * @return is the auto snapshot feature enabled.
   */
  boolean isEnableAutosnapshot();

  /**
   * @param enableAutosnapshot
   *            enable the auto snapshot feature.
   */
  void setEnableAutosnapshot(boolean enableAutosnapshot);

  /**
   * @return is the Measurement system enabled.
   */
  boolean isEnableMeasurement();

  /**
   * @param enableMeasurement
   *            enable the JMeasurement system.
   */
  void setEnableMeasurement(boolean enableMeasurement);

  /**
   * @return is the memory saving feature enabled.
   */
  boolean isEnableMemorySavings();

  /**
   * @param enableMemorySavings
   *            enable the memory saving feature.
   */
  void setEnableMemorySavings(boolean enableMemorySavings);

  /**
   * @return the type of exception handling.
   */
  int getExceptionHandling();

  /**
   * @param exceptionHandling
   *            setting the exception handling
   */
  void setExceptionHandling(int exceptionHandling);

  /**
   * @return getting the point idle time for memory saving feature.
   */
  int getPointIdletime();

  /**
   * @param pointIdletime
   *            setting the idle time when the measure point will saved.
   *            (memory saving feature)
   */
  void setPointIdletime(int pointIdletime);

  /**
   * @return the working path.
   */
  String getWorkingpath();

  /**
   * @param workingpath
   *            setting the path, where some files will stored automatically.
   */
  void setWorkingpath(String workingpath);

  /**
   * taking a new shapshot with the given name.
   * 
   * @param name
   *            name of the snapshot.
   */
  void takeSnapShot(final String name);

  /**
   * @return String array with all snapshotnames.
   */
  String[] getSnapShotNames();

  /**
   * @param name
   *            name of the snapshot
   * @param filename
   *            save the snapshot to the desired filename.
   * @throws IOException
   *             if someting goes wrong.
   * @throws SAXException
   *             if someting goes wrong.
   */
  void saveSnapShot(final String name, final String filename) throws SAXException, IOException;

  /**
   * @param filename
   *            save the html report to the desired filename.
   * @throws IOException
   *             if someting goes wrong.
   */
  void saveHTMLReport(final String filename) throws IOException;

  String getApplicationName();
}