/*
 * 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.catalina.tribes;

import javax.management.MBeanRegistration;


/**
 * JMX channel interface for managing JMX registration of a channel.
 */
public interface JmxChannel extends MBeanRegistration {

    /**
     * If set to true, this channel is registered with jmx.
     *
     * @return true if this channel will be registered with jmx.
     */
    boolean isJmxEnabled();

    /**
     * If set to true, this channel is registered with jmx.
     *
     * @param jmxEnabled set to true if this channel should be registered with jmx.
     */
    void setJmxEnabled(boolean jmxEnabled);

    /**
     * Return the jmx domain which this channel is registered.
     *
     * @return jmxDomain
     */
    String getJmxDomain();

    /**
     * Set the jmx domain which this channel should be registered.
     *
     * @param jmxDomain The jmx domain which this channel should be registered.
     */
    void setJmxDomain(String jmxDomain);

    /**
     * Return the jmx prefix which will be used with channel ObjectName.
     *
     * @return jmxPrefix
     */
    String getJmxPrefix();

    /**
     * Set the jmx prefix which will be used with channel ObjectName.
     *
     * @param jmxPrefix The jmx prefix which will be used with channel ObjectName.
     */
    void setJmxPrefix(String jmxPrefix);

}
