001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.api.management.mbean;
018
019import org.apache.camel.api.management.ManagedAttribute;
020import org.apache.camel.api.management.ManagedOperation;
021
022public interface ManagedServiceMBean {
023
024    @ManagedAttribute(description = "Service State")
025    String getState();
026
027    @ManagedAttribute(description = "Camel ID")
028    String getCamelId();
029
030    @ManagedAttribute(description = "Camel ManagementName")
031    String getCamelManagementName();
032
033    @ManagedAttribute(description = "Route ID")
034    String getRouteId();
035
036    @ManagedAttribute(description = "Service Type")
037    String getServiceType();
038
039    @ManagedOperation(description = "Start Service")
040    void start() throws Exception;
041
042    @ManagedOperation(description = "Stop Service")
043    void stop() throws Exception;
044
045    @ManagedAttribute(description = "Whether this service supports suspension")
046    boolean isSupportSuspension();
047
048    @ManagedAttribute(description = "Whether this service is static")
049    boolean isStaticService();
050
051    @ManagedAttribute(description = "Whether this service is suspended")
052    boolean isSuspended();
053
054    @ManagedOperation(description = "Suspend Service")
055    void suspend() throws Exception;
056
057    @ManagedOperation(description = "Resume Service")
058    void resume() throws Exception;
059
060}