ManagementMBean.java revision 340
325N/A/*
325N/A * CDDL HEADER START
325N/A *
325N/A * The contents of this file are subject to the terms of the
325N/A * Common Development and Distribution License (the "License").
325N/A * You may not use this file except in compliance with the License.
325N/A *
325N/A * See LICENSE.txt included in this distribution for the specific
325N/A * language governing permissions and limitations under the License.
325N/A *
325N/A * When distributing Covered Code, include this CDDL HEADER in each
325N/A * file and include the License file at LICENSE.txt.
325N/A * If applicable, add the following below this CDDL HEADER, with the
325N/A * fields enclosed by brackets "[]" replaced with your own identifying
325N/A * information: Portions Copyright [yyyy] [name of copyright owner]
325N/A *
325N/A * CDDL HEADER END
325N/A */
325N/A
325N/A/*
325N/A * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
325N/A * Use is subject to license terms.
325N/A */
325N/Apackage org.opensolaris.opengrok.management;
325N/A
325N/Aimport java.util.Date;
325N/A
325N/A/**
325N/A * @author Jan S Berg
325N/A */
325N/Apublic interface ManagementMBean {
325N/A
325N/A /**
325N/A * Stops the agent, so it is not restarted.
325N/A */
325N/A public void stop();
325N/A
325N/A /**
325N/A * Get the xml based configuration file
325N/A * @return String with the file path and name for xml configuration
325N/A */
325N/A public String getConfigurationFile();
325N/A
325N/A /**
325N/A * Get the URL to the Publish Server we want to
325N/A * publish the indexed data
325N/A * @return String URL to the server (hostname:port)
325N/A */
325N/A public String getPublishServerURL();
325N/A
325N/A /**
325N/A * Set update index database property
325N/A */
325N/A public void setUpdateIndexDatabase(Boolean val);
325N/A
325N/A /**
325N/A * Get the udate database property
325N/A */
325N/A public Boolean getUpdateIndexDatabase();
325N/A
325N/A /**
325N/A * Set number of Threads to use for indexing
325N/A */
325N/A public void setNumberOfThreads(Integer val);
325N/A
325N/A /**
325N/A * Get number of Threads to use for indexing
325N/A */
325N/A public Integer getNumberOfThreads();
325N/A
325N/A /**
325N/A * Set subfiles
325N/A * @param sublist
325N/A */
325N/A public void setSubFiles(String[] sublist);
325N/A
/**
* Get subfiles
* @return get StringArray of subfiles to run through
*/
public String[] getSubFiles();
/**
* Get a selected property from JAG configuration.
* @return String with property value
*/
public String getProperty(String key);
/**
* Set a selected property in the JAG configuration.
* JAG will immediately save its configuration to file when a
* property is set.
* @param key the String key for the property to be set.
* $param value the String value for the property to be set.
*/
public void setProperty(String key, String value);
/**
* Get the selected System property
* @return String with property value
*/
public String getSystemProperty(String key);
/**
* Set a selected System property
* @param key the String key for the property to be set.
* $param value the String value for the property to be set.
*/
public void setSystemProperty(String key, String value);
/**
* Get the selected Environment property
* @return String with Environment property value
*/
public String getSystemEnvProperty(String key);
/**
* Get the time (in milliseconds since 1970) when the agent was started
* @return long time when the agent was started, in milliseconds.
*/
public long getStartTime();
/**
* Get a Date object with the time the agent was started.
* @return Date with the starting date
*/
public Date getStartDate();
/**
* Get the version tag for the agent
* @return String the version tag for this agent
*/
public String getVersion();
}