ActiveMQComponentControl.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.activemq.artemis.api.core.management;

/**
 * An ActiveMQComponentControl is used to manage the life cycle of an ActiveMQ Artemis component.
 */
public interface ActiveMQComponentControl {

   /**
    * Returns {@code true} if this component is started, {@code false} else.
    */
   @Attribute(desc = "whether this component is started")
   boolean isStarted();

   /**
    * Starts this component.
    */
   @Operation(desc = "starts this component")
   void start() throws Exception;

   /**
    * Stops this component.
    */
   @Operation(desc = "stops this component")
   void stop() throws Exception;
}