/*
 * 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 java.util.Collection;
import org.apache.ignite.IgniteEncryption;

/**
 * Encryption features MBean.
 */
@MXBeanDescription("MBean that provides access to encryption features.")
public interface EncryptionMXBean {
    /**
     * Gets the current master key name.
     *
     * @return Master key name.
     * @see IgniteEncryption#getMasterKeyName()
     */
    @MXBeanDescription("Current master key name.")
    public String getMasterKeyName();

    /**
     * Starts master key change process.
     *
     * @param masterKeyName Master key name.
     * @see IgniteEncryption#changeMasterKey(String)
     */
    @MXBeanDescription("Change master key name.")
    public void changeMasterKey(
        @MXBeanParameter(name = "masterKeyName", description = "Master key name.") String masterKeyName
    );

    /**
     * Starts cache group encryption key change process.
     *
     * @param cacheOrGrpName Cache or group name.
     * @see IgniteEncryption#changeCacheGroupKey(Collection)
     */
    @MXBeanDescription("Change cache group key.")
    public void changeCacheGroupKey(
        @MXBeanParameter(name = "cacheOrGroupName", description = "Cache or group name.") String cacheOrGrpName
    );
}
