AgentIndexRunnerMBean.java revision 457
340N/A/*
340N/A * CDDL HEADER START
340N/A *
340N/A * The contents of this file are subject to the terms of the
340N/A * Common Development and Distribution License (the "License").
340N/A * You may not use this file except in compliance with the License.
340N/A *
340N/A * See LICENSE.txt included in this distribution for the specific
340N/A * language governing permissions and limitations under the License.
340N/A *
340N/A * When distributing Covered Code, include this CDDL HEADER in each
340N/A * file and include the License file at LICENSE.txt.
340N/A * If applicable, add the following below this CDDL HEADER, with the
340N/A * fields enclosed by brackets "[]" replaced with your own identifying
340N/A * information: Portions Copyright [yyyy] [name of copyright owner]
340N/A *
340N/A * CDDL HEADER END
340N/A */
340N/A
340N/A/*
340N/A * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
340N/A * Use is subject to license terms.
340N/A */
340N/Apackage org.opensolaris.opengrok.management;
340N/A
340N/A/**
340N/A * @author Jan S Berg
340N/A */
340N/Apublic interface AgentIndexRunnerMBean {
340N/A
457N/A void enable();
340N/A
457N/A void disable();
340N/A
340N/A /**
340N/A * Last index time in System.currentmillis
340N/A * of successful index update
340N/A * @return long when last time the indexing finished
340N/A */
457N/A long lastIndexTimeFinished();
340N/A
340N/A /**
340N/A * Last index time in System.currentmillis
340N/A * @return long when last time indexing started
340N/A */
457N/A long lastIndexTimeStarted();
340N/A
340N/A /**
340N/A * Last index time usage for successful indexing (no exceptions)
340N/A * @return long how long the last index lasted
340N/A */
457N/A long lastIndexTimeUsed();
340N/A
340N/A /**
340N/A * Start indexing outside the timer
340N/A * @param waitForFinished wait for it to finish or just return when started
340N/A */
457N/A void index(boolean waitForFinished);
340N/A
340N/A /**
340N/A * Get Exception from last run
340N/A * @return Exception if any or null if no Exceptions.
340N/A */
457N/A Exception getExceptions();
340N/A}