com.stratio.cassandra.lucene.IndexServiceMBean.scala Maven / Gradle / Ivy
The newest version!
/*
* Copyright (C) 2014 Stratio (http://stratio.com)
*
* 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 com.stratio.cassandra.lucene
/** JMX methods to be exposed by [[IndexService]].
*
* @author Andres de la Pena `[email protected]`
*/
trait IndexServiceMBean {
/** Commits the pending changes. */
def commit()
/** Returns the total number of documents in this index.
*
* @return the number of documents
*/
def getNumDocs: Long
/** Returns the total number of deleted documents in this index.
*
* @return the number of deleted documents
*/
def getNumDeletedDocs: Long
/** Optimizes the index forcing merge segments leaving the specified number of segments. This
* operation may block until all merging completes.
*
* @param maxNumSegments the maximum number of segments left in the index after merging finishes
* @param doWait `true` if the call should block until the operation completes
*/
def forceMerge(maxNumSegments: Int, doWait: Boolean)
/** Optimizes the index forcing merge of all segments that have deleted documents. This operation
* may block until all merging completes.
*
* @param doWait `true` if the call should block until the operation completes
*/
def forceMergeDeletes(doWait: Boolean)
/** Refreshes the index readers. */
def refresh()
}