modules/core/src/main/java/org/apache/ignite/mxbean/QueryMXBean.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.ignite.mxbean;

import org.apache.ignite.spi.systemview.view.ContinuousQueryView;
import org.apache.ignite.spi.systemview.view.ScanQueryView;
import org.apache.ignite.spi.systemview.view.SqlQueryView;

/**
 * Query MXBean interface.
 */
public interface QueryMXBean {
    /**
     * Kills continuous query by the identifier.
     *
     * @param routineId Continuous query id.
     * @param originNodeId ID of the node that is CQ initiator.
     * @see ContinuousQueryView#routineId()
     */
    @MXBeanDescription("Kills continuous query by the identifier.")
    void cancelContinuous(
        @MXBeanParameter(name = "originNodeId", description = "Originating node ID.") String originNodeId,
        @MXBeanParameter(name = "routineId", description = "Continuous query id.") String routineId
    );

    /**
     * Kills SQL query by the identifier.
     *
     * @param id SQL query id.
     * @see SqlQueryView#queryId()
     */
    @MXBeanDescription("Kills SQL query by the identifier.")
    void cancelSQL(
        @MXBeanParameter(name = "id", description = "SQL query id.") String id
    );

    /**
     * Kills scan query by the identifiers.
     *
     * @param originNodeId Originating node id.
     * @param cacheName Cache name.
     * @param id Scan query id.
     * @see ScanQueryView#originNodeId()
     * @see ScanQueryView#cacheName()
     * @see ScanQueryView#queryId()
     */
    @MXBeanDescription("Kills scan query by the identifiers.")
    void cancelScan(
        @MXBeanParameter(name = "originNodeId", description = "Originating node ID.") String originNodeId,
        @MXBeanParameter(name = "cacheName", description = "Cache name.") String cacheName,
        @MXBeanParameter(name = "id", description = "Scan query id.") Long id
    );
}