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     */
017    package org.apache.camel.api.management.mbean;
018    
019    import org.apache.camel.api.management.ManagedAttribute;
020    import org.apache.camel.api.management.ManagedOperation;
021    
022    public interface ManagedServiceMBean {
023    
024        @ManagedAttribute(description = "Service State")
025        String getState();
026    
027        @ManagedAttribute(description = "Camel ID")
028        String getCamelId();
029    
030        @ManagedAttribute(description = "Route ID")
031        String getRouteId();
032    
033        @ManagedOperation(description = "Start Service")
034        void start() throws Exception;
035    
036        @ManagedOperation(description = "Stop Service")
037        void stop() throws Exception;
038    
039        @ManagedAttribute(description = "Whether this service supports suspension")
040        boolean isSupportSuspension();
041    
042        @ManagedAttribute(description = "Whether this service is suspended")
043        boolean isSuspended();
044    
045        @ManagedOperation(description = "Suspend Service")
046        void suspend() throws Exception;
047    
048        @ManagedOperation(description = "Resume Service")
049        void resume() throws Exception;
050    
051    }